DimensionProvider Class [AX 2012]

The DimensionProvider class contains helper methods that interact with the dimensions subsystem.

Syntax

class DimensionProvider implements DimensionProviderBase

Run On

Called

Methods

	Method	Description
	addAttributeFilterToQuery	Adds the appropriate joins and filters to a query to filter the results by a specific dimension attribute and value.
	addAttributeRangeToQuery	Adds the appropriate joins and ranges to a query to filter the results by a specified dimension attribute and value.
	addAttributeRangeToQueryFromRangeCon	Adds the appropriate joins and ranges to a query to filter results by a specific dimension attribute and value by using the range container that is supplied by the getDimensionRangesFromQuery method.
	addDataSourceToQuery	Adds the appropriate joins to the query to pivot the specified dimension information as a column on the query.
	addDimensionFieldRangeToQuery	Adds the necessary joins into the related dimension storage tables for this dimension field and then restricts the values for a specific dimension field RefRecID enumeration value
	addDimensionStorageDatasourcesToQuery	Adds the appropriate joins into the appropriate dimension storage tables for this dimension field to get the individual dimension attribute names and values
	addFiltersToList
	addOrderByAttribute	Sorts the specified query by the specified dimension information.
	addOrderBysToList
	addRangesToList
	addUserDefinedAttributeFilterToQuery	Adds the appropriate joins and filter to a query to filter results by a specific user-defined dimension attribute name.
	addUserDefinedAttributeRangeToQuery	Adds the appropriate joins and range to a query to filter results by a specific user-defined dimension attribute name.
	addUserDefinedBackingEntityToQuery	Adds the appropriate joins to the query to get the related backing entity tables for user-defined dimension attributes.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	clearDimensionRangesFromDatasource	Clears all ranges that are related to the dimension field in the input data source.
	clearDimensionRangesFromQuery	This method clears all the ranges that are related to the dimension field in the input query.
	constrainNameLength	Constrains the name to a specified maximum length.
	enableDimensionRangeOnQuery	Enables the disabled range that is related to the dimension field in the input query.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getAttributeValueFromQueryRun	Retrieves the value of the specified dimension from the QueryRun object and authorization information.
	getAttributeValueLocFromQueryRun	Gets the location of the dimension information from the specified query.
	getAttributeValueNameFromQueryRun	Retrieves the name of the specified dimension from the QueryRun object and authorization information.
	getDimensionAttributeNames	Retrieves a list of the names of all dimension attributes.
	getDimensionAttributesFromFocus	Retrieves a list of the names of all dimension attributes in the specified focus.
	getDimensionFiltersFromQuery	Gets the list of all dimension filters in a query.
	getDimensionFocusNames	Retrieves a list of the dimension focuses.
	getDimensionOrderBysFromQuery	Retrieves the list of all dimension order bys in a query.
	getDimensionRangesFromQuery	Gets the list of all of the dimension ranges in a query.
	getDisplayStringForAttributeValue	Retrieves the display string for the specified DimensionAttributeValue record.
	getDisplayValueEDTName	Retrieves the name of the extended data type that is used for denormalized display values.
	getNameForAttributeValue	Retrieves the name for the specified DimensionAttributeValue record.
	getPivotedAccountStructureTableName	Constructs a table name for pivoted account structure values.
	getPivotedAttributeTableName	Constructs a table name for pivoted dimension values.
	getPivotedCombinationTableName	Constructs a table name for pivoted combination values.
	getStringValueFromCursor	Retrieves a string that represents the concatenated dimension information from the specified field.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getUserDefinedBackingEntityName	Constructs a table name that represents the related backing entity tables for user-defined dimensions.
	getValidDimensionAttributes
	getValueQueryForDimensionAttribute	Constructs a query for the specified table with a pivoted column for the specified dimension.
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	isDenormalizedValueAvailableForEDT	Indicates whether a denormalized combination string exists for the specified dimension type.
	isDimensionDatasource	Checks whether the input data source is a dimension data source.
	new	Initializes a new instance of the DimensionProvider class.
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	verifyDimensionAttributeAndComponent
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::findChildDataSource	Finds the first child data source with the specified name under the specified parent.
	::IncludeDataSourceFields	Adds table fields to query data source field list

Top

Inheritance Hierarchy

Object Class
  DimensionProvider Class