DimensionDefaultingEngine Class [AX 2012]
The DimensionDefaultingEngine class provides an API for defaulting dimension values.
Syntax
class DimensionDefaultingEngine
Run On
Called
Methods
| Method | Description | |
|---|---|---|
.gif "Public method") |
accountDelimiter | Gets the account delimiter. |
.gif "Private method") |
addAccountStructureAndRules | Adds the account structure and rules to the internal cache. |
|
addHierarchy | Adds the hierarchy to the internal cache. |
|
addRuleHierarchies | Adds the rules hierarchies. |
|
addSegment | Adds the segment to the internal cache. |
|
addSegmentsForAccountStructure | Adds the segments to the internal cache from the specified account structure. |
|
applyDimensionSources | Fills any empty segments that match one of the specified dimension values. |
|
applyDimensionSourcesPrivate | Fills any empty segments that match one of the specified dimension values. |
|
applyDimensionSpecifiers | Fills any empty segments that match with one of the dimension specifiers. |
|
applyDimensionSpecifiesWithMainAccount | Fills any empty segments that match one of the specified dimension values. |
|
applyMainAccountDefaults | Applies the defaulting dimensions for the main account. |
|
cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
|
equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
|
fillById | Fills internal values for the specified ledger dimensions. |
|
fillByMainAccount | Fills internal values for the specified main account and account structure. |
|
fillByValues | Fills internal values for the specified values. |
|
fillDelimiterCache | Fills the account delimiter cache variable. |
|
getDimensionAttributes | Gets the record IDs of the dimensions attributes. |
|
getLedgerDimension | Gets a ledger dimension that represents the current state of the dimension values of the defaulting engine. |
|
getLedgerDimensionForSources | Retrieves a ledger dimension after the dimension sources are applied. |
|
getStorage | Gets a storage object that represents the current state of the dimension values default engine. |
|
getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
|
handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
|
init | Initializes local variables to reflect an empty state. |
|
initAccountStructureForOverride | Initializes the dimension values for the first hierarchy based on the specified values. |
|
isFilled | Indicates whether all segment values have been filled. |
|
isModified | Indicates whether a dimension value has been applied. |
|
isStateModified | Checks whether the state has been modified after the state was saved or restored. |
.gif "Protected method") |
new | Initializes a new instance of the DimensionDefaultingEngine 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.) |
|
restoreState | Restores the state of the DimensionDefaultingEngine class. |
|
saveState | Saves the state of the DimensionDefaultingEngine class. |
|
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.) |
|
wait | Pauses a process. (Inherited from Object.) |
|
xml | Returns an XML string that represents the current object. (Inherited from Object.) |
.gif "Static member") |
::addDefaultDimensionForLedgerDimension | Adds the default dimensions for the main account of the ledger dimension to the dimension sources. |
| |
::addDimensionSpecifiers | Adds two collections of dimension specifiers together. |
| |
::addNaturalKey | Adds an entity specifier by using a natural key to the list of entity specifiers. |
| |
::addSurrogateKey | Adds an entity specifier by using the surrogate key to the list of entity specifiers. |
| |
::applyDimensionSourcesServer | Fills any empty segments that match one of the specified dimension values. |
| |
::construct | Constructs an instance of the DimensionDefaultingEngine class. |
| |
::constructForAccountStructure | Initializes an instance of the DimensionDefaultingEngine class. |
| |
::constructForMainAccountId | Initializes a new instance of the DimensionDefaultingEngine class. |
| |
::constructForSetupLedgerDimensions | Constructs an instance of the DimensionDefaultingEngine class for merging setup ledger dimensions. |
| |
::createEmptyDimensionSpecifiers | Creates an empty collection of dimension specifiers. |
| |
::createEmptyEntityDimensionSpecifiers | Creates an empty collection of entity dimension specifiers. |
| |
::createLedgerDimension | Creates a ledger dimension for the specified combination. |
| |
::createLedgerDimensionPacked | Creates a ledger dimension for the specified combination. |
| |
::createLedgerDimensionServer | Creates a ledger dimension for the specified combination. |
| |
::filterDimensionSpecifiers | Filters a collection of dimension specifiers. |
| |
::getDefaultDimension | Gets a default dimension by using the specified dimension values as default values. |
| |
::getDefaultDimensionPrivate | Gets a default dimension that uses the specified dimension values as default values. |
| |
::getDefaultDimensionServer | Gets a default dimension that uses the specified dimension values as default values. |
| |
::getDefaultDimensionSpecifiers | Retrieves a collection of dimension specifiers for the specified default dimension. |
| |
::getDefaultDimensionSpecifiersServer | Retrieves a packed collection of dimension specifiers for the specified default dimension. |
| |
::getDimensionSourcesForLedgerDimension | Retrievse a dimension source that corresponds to the specified ledger dimension. |
| |
::getLedgerDimensionFromAccountAndDim | Retrieves the ID for the DimensionAttributeValueCombination record that represents a combination of the specified main account and default dimension information. |
| |
::getLedgerDimensionSpecifiers | Retrieves a collection of dimension specifiers for the specified ledger dimension. |
| |
::getStorageFromDimensionSpecifiers | Gets a structure that contains the dimension storage for the specified values. |
| |
::getValueSetStorageDimensionSpecifiers | Retrieves a collection of dimension specifiers that correspond to a DimensionAttributeValueSetStorage object. |
| |
::insertDimensionSpecifer | Adds a new dimension specifier to the collection. |
| |
::mergeSetupLedgerDimensions | Merges the specified ledger dimensions into a single ledger dimension. |
| |
::mergeSetupLedgerDimensionsServer | Merges the specified ledger dimensions into a single ledger dimension. |
| |
::overrideDefaultDimension | Updates a default dimension with the specified dimension values. |
| |
::overrideDefaultDimensionServer | Updates a default dimension with the specified dimension values. |
| |
::overrideDimensionSpecifiers | Updates a collection of dimension specifiers with the specified override dimension values. |
| |
::overrideLedgerDimension | Gets a ledger dimension based on the specified ledger dimension that is overridden with the specified dimension values. |
| |
::overrideLedgerDimensionServer | Gets a ledger dimension based on the specified ledger dimension that is overridden with the specified dimension values. |
Top
Inheritance Hierarchy
Object Class
DimensionDefaultingEngine Class