DimensionStorage Class [AX 2012]

The DimensionStorage class manages the storage of dimension value combinations.

Syntax

class DimensionStorage implements SysPackable

Run On

Called

Methods

	Method	Description
	addAccountStructure	Adds the initial account structure mapping, which allows the specified number of segments to be set for it.
	addHierarchy	Adds a hierarchy mapping, which allows the specified number of segments to be set for it.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	clearSegment	Clears the specified segment.
	dimensionAttributeValuesChanged	Raised when dimension attribute values are changed.
	dimensionStructureChangedError	Determines whether the structures of the combination have changed since the initial persistence of the combination.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	find	Retrieves the specified combination and populates the list of hierarchies and segments.
	getAttributeIdForSegment	Retrieves the ID of the DimensionAttribute record for the segment with the specified index.
	getComboDisplayValue	Retrieves a concatenated string with the combined list of display values for each segment, separated by a delimiter.
	getComboDisplayValueForRenamedValue	Gets a concatenated string with the combined list of display values for each segment, separated by a delimiter, for a renamed dimension attribute value.
	getComboHash	Computes the hash value of the whole combination using the tracked hierarchy and segment information.
	getGroupHash	Computes the hash value of the hierarchy group combination using the tracked segment information for the specified hierarchy
	getHierarchyCollection	Gets a dimension hierarchy collection for the hierarchies in the current instance.
	getHierarchyId	Retrieves the ID of the DimensionHierarchy object at the specified index.
	getHierarchyIdForSegment	Retrieves the ID of the DimensionHierarchy object for the specified segment.
	getIndexForHierarchyId	Retrieves the index of the specified DimensionHierarchy object.
	getSavedComboRecId	Gets the combination record ID if it has been previously saved.
	getSegment	Retrieves the DimensionStorageSegment object at the specified index.
	getSegmentCollectionForHierarchy	Gets the dimension storage segment collection for the specified hierarchy.
	getSegmentForHierarchy	Retrieves the DimensionStorageSegment object at the specified index in the specified hierarchy.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getValueGroupForHierarchy	Retrieves a DimensionAttributeValueGroup object, if one exists, for the specified hierarchy.
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	hierarchyCount	Retrieves the total number of hierarchies mapped to segments in the combination.
	initialSegmentForHierarchy	Retrieves the position in the combination of the first segment mapped to the specified hierarchy.
	invalidateStructureChangedValue	Invalidates any caching of the structure changed value.
	isEqualTo	Determines whether the specified combination is equal to this combination based on the contained values.
	lastSavedRecId	Retrieves the record ID for the combination if it has been unchanged since it was found.
	ledgerDimensionType	Retrieves the type of the ledger dimension for the current combination held by the instance of the DimensionStorage class.
	new	Constructs and retrieves an instance of the DimensionStorage class that has the specified initial number of segments.
	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.)
	pack	Serializes the current instance of the DimensionStorage class.
	removeHierarchies	Removes the right-most number of hierarchies and all their segments from being tracked.
	reset	Removes all hierarchies, all mapped and unmapped segments and reallocates the number of specified segments as a new blank combination.
	resetAs	Removes all hierarchies and all mapped and unmapped segments and reallocates the number of specified segments as a new blank combination.
	save	Saves the current information and retrieves the record ID of the persisted combination.
	saveAsDefaultAccount	Saves the current information as a default account and retrieves the record ID of the persisted combination.
	savePrivate	Saves the current information and retrieves the record ID of the persisted combination.
	segmentCount	Retrieves the total number of segments in the combination.
	segmentCountForHierarchy	Retrieves the total number of segments in the combination for the specified hierarchy.
	setSegment	Sets the value of a DimensionStorageSegment object at the specified index.
	setSegmentForHierarchy	Sets the value of a DimensionStorageSegment object at the specified index in the specified hierarchy.
	setStructureChangedValue	Sets the pre-validated value of whether the structure has changed.
	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.)
	unpack	Deserializes the pack parameter value to an instance of the DimensionStorage class.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::accountNum2LedgerDimension	Constructs a LedgerDimensionAccount object for the specified non-ledger account.
	::addSegmentToDisplayValue	Adds to a concatenated string of display values for the specified segment optionally separated by a delimiter added to the end.
	::compareMainAccounts	Indicates whether the two specified records in the DimensionAttributeValueCombination table have the same main account.
	::construct	Constructs and retrieves an instance of the DimensionStorage class that has the specified initial number of segments.
	::constructStorageForAccount	Constructs a new DimensionStorage object for the specified non-ledger account.
	::create	Creates an instance of the DimensionStorage class from a packed copy.
	::dimLedgerAccountType2LedgerAccountType	Converts a LedgerAccountType enumeration value to a DimensionLedgerAccountType enumeration value.
	::equals	Indicates whether the two specified instances are equal based on the values that are contained in each of the objects.
	::findById	Retrieves the specified combination and populates the list of hierarchies and segments.
	::findByIdPacked	Retrieves a packed copy of the specified combination and populates the list of hierarchies and segments.
	::getAccountStructureFromLedgerDimension	Gets the DimensionHierarchy record that is the account structure of the specified ledger dimension.
	::getDefaultAccount	Retrieves the record ID of a LedgerDimensionDefaultAccount record that represents the specified main account.
	::getDefaultAccountForMainAccountNum	Constructs a LedgerDimensionDefaultAccount object for the specified main account number.
	::getDefaultDimensionFromLedgerDimension	Retrieves the record ID of a DimensionDefault record that represents all dimension information from the combination other than the main account.
	::getDimensionAttributeValueHashKey	Gets the value of the HashKey field from the DimensionAttributeValue record .
	::getDisplayValueForFocusName	Gets the dimension focus display value for the focus name and ledger dimension.
	::getDynamicAccount	Constructs a LedgerDimensionAccount object for the specified non-ledger account.
	::getFirstDimHierarchyFromLedgerDimension	Retrieves a DimensionHierarchy record that represents the first hierarchy associated with the specified LedgerDimension record.
	::getHash	Computes a hash value for the specified message.
	::getHierarchyCollectionForLedgerDimension	Gets a dimension hierarchy collection for the specified ledger dimension.
	::getHierarchyCollectionForLedgerDimPacked	Gets a dimension hierarchy collection for the specified ledger dimension.
	::getHierarchyCollectionForLedgerDimServer	Gets a dimension hierarchy collection for the specified ledger dimension.
	::getLedgerDefaultAccountFromLedgerDim	Retrieves the record ID of a LedgerDimensionDefaultAccount record that represents the default account from the specified ledger dimension.
	::getMainAccountFromLedgerDimension	Gets the MainAccount record that is part of the specified ledger dimension.
	::getMainAccountIdFromLedgerDimension	Gets the record ID of the MainAccount record that is part of the specified ledger dimension.
	::getMainAccountNumFromLedgerDimension	Gets the display value for the MainAccount record that is part of the specified ledger dimension.
	::getSavedComboRecIdByHash
	::getSegmentCollectionForLedgerDimension	Retrieves the DimensionStorageSegmentCollection object for the specified hierarchy and ledger dimension.
	::getSegmentCollectionForLedgerDimPacked	Retrieves the DimensionStorageSegmentCollection object for the specified hierarchy and ledger dimension.
	::getSegmentCollectionForLedgerDimServer	Retrieves the DimensionStorageSegmentCollection object for the specified hierarchy and ledger dimension.
	::ledgerDimension2AccountNum	Retrieves the string value of the specified account.
	::raiseDimensionAttributeValuesChanged	Raises an event when dimension attribute values have changed.
	::saveOnServer	Saves the current information and returns the record ID of the persisted combination.
	::syncRenamedValue	Updates all stored combinations to reflect a change in the display value of a entity instance.
	::syncRenamedValuesForAttributeValue	Updates all stored combinations to reflect a change in the display value of a dimension attribute value.
	::syncRenamedValuesForValueSetItem	Updates all stored value set items to reflect a change in a display value of a dimension attribute value.
	::validateCombinationIntegrity	Validates the integrity of the overall combination.

Top

Remarks

The segment values and associated hierarchies are managed through a familiar collection type interface. The hierarchies and segments are stored in lists and are referenced from left to right based on their position in the list given. This is the typical UI presentation.

Inheritance Hierarchy

Object Class
  DimensionStorage Class