LedgerDimensionController Class [AX 2012]

The LedgerDimensionController class is used as a base for specialized classes that use the segmented entry control for transaction entry.

class LedgerDimensionController extends DimensionController

Run On

Called

  MethodDescription
Gg764355.privmethod(en-us,AX.60).gif addCombinationToMRU Adds the current combination to an instance of the DimensionMRUProvider class.
Gg764355.protmethod(en-us,AX.60).gif addExcludedDimensionValues Adds the provided dimension value exclusion set to the existing set.
Gg764355.protmethod(en-us,AX.60).gif addHierarchyCombinationToMRU Adds the specified combination of values to the most recently used list for the specified hierarchy.
Gg764355.protmethod(en-us,AX.60).gif addSegmentToControl Adds the specified segment to the control.
Gg764355.privmethod(en-us,AX.60).gif applyBothPagingAndAutoFilterRanges Applies both paging and auto filter ranges on the supplied backing entity datasource.
Gg764355.protmethod(en-us,AX.60).gif applyDimensionAttributeValuesRestriction Restricts dimension attribute values based on the total, suspended and inactive date range.
Gg764355.privmethod(en-us,AX.60).gif applyOnlyAutoFilterRange Applies only auto filter ranges on the supplied backing entity datasource.
Gg764355.privmethod(en-us,AX.60).gif applyOnlyPagingRange Applies only paging ranges on the supplied backing entity datasource.
Gg764355.privmethod(en-us,AX.60).gif applyPagingAndAutoFilterRanges Applies paging and auto filter ranges on the supplied backing entity datasource.
Gg764355.privmethod(en-us,AX.60).gif applyPagingAndAutoFilterRangesLanguage Applies paging and auto filter ranges on the supplied backing entity datasource when there is a dimension value language id.
Gg764355.protmethod(en-us,AX.60).gif buildExcludedDimensionValues Builds the excluded dimension values set.
Gg764355.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg764355.privmethod(en-us,AX.60).gif canPerformValidValuesQuery Determines whether a valid values query can be performed for the specified dimension attribute.
Gg764355.protmethod(en-us,AX.60).gif checkForBlockedValue Determines whether the specified value is blocked and cannot be entered. (Inherited from DimensionController.)
Gg764355.protmethod(en-us,AX.60).gif clearInvalidSegment Clears the specified control segment, marks it as invalid, and prevents the user from leaving the segment. (Inherited from DimensionController.)
Gg764355.pubmethod(en-us,AX.60).gif clearReference Clears the record ID of the DimensionAttributeValueCombination record that is referenced by the dialog field or the table field and reloads a blank control. (Inherited from DimensionController.)
Gg764355.privmethod(en-us,AX.60).gif clearTrackingArrays Clears the arrays for tracking dimension attributes in the control and dimension storage.
Gg764355.protmethod(en-us,AX.60).gif control_segmentEntered Explicitly implemented segmented entry control segmentEntered method not to require the method to be specified at design time on all uptake forms. (Overrides the control_segmentEntered Method.)
Gg764355.protmethod(en-us,AX.60).gif DimensionLinkAllowFieldEdit Rises when a field is being made editable for a specified dimension attribute. (Inherited from DimensionControllerObject.)
Gg764355.protmethod(en-us,AX.60).gif DimensionLinkMarkFieldOptional Rises when a field is being made optional for a specified dimension attribute. (Inherited from DimensionControllerObject.)
Gg764355.protmethod(en-us,AX.60).gif DimensionLinkSetFieldValue Rises when a field value is being set for a specified dimension attribute. (Inherited from DimensionControllerObject.)
Gg764355.protmethod(en-us,AX.60).gif DimensionLinkShowField Rises when a field is being shown for a specified dimension attribute. (Inherited from DimensionControllerObject.)
Gg764355.protmethod(en-us,AX.60).gif displayStructureChangedMessage Displays the message to inform the user that the structure has changed.
Gg764355.protmethod(en-us,AX.60).gif doIncludeSuspendedDimAttributeValues Determines whether the suspended dimension attribute values are included in the lookup.
Gg764355.protmethod(en-us,AX.60).gif doIncludeTotalDimAttributeValues Determines whether the total dimension attribute values are included in the lookup.
Gg764355.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg764355.pubmethod(en-us,AX.60).gif getAccountStructure Retrieves the current account structure. (Inherited from DimensionController.)
Gg764355.protmethod(en-us,AX.60).gif getAttributeValueSet Gets a container of all dimension attribute values and backing entity instances for the specified value set. (Inherited from DimensionControllerObject.)
Gg764355.protmethod(en-us,AX.60).gif getAutoCompleteAllQuery Adds the appropriate restrictions to retrieve all the AutoComplete fields from the database.
Gg764355.protmethod(en-us,AX.60).gif getAutoCompleteDataFromDatabase Retrieves the appropriate the AutoComplete from the database.
Gg764355.protmethod(en-us,AX.60).gif getAutoCompleteDataFromMRU Retrieves the appropriate the AutoComplete field from the most recently used provider.
Gg764355.protmethod(en-us,AX.60).gif getAutoCompleteValidQuery Adds the appropriate restrictions to retrieve all valid the AutoComplete field from the database.
Gg764355.privmethod(en-us,AX.60).gif getCombinationsForMRU Retrieves a map of the current combination formatted for storage in the DimensionMRUProvider object.
Gg764355.pubmethod(en-us,AX.60).gif getControlIndexByDimensionAttribute Retrieves the index in the control of the specified dimension attribute.
Gg764355.protmethod(en-us,AX.60).gif getDimAttributeValueRestrictionDate The date by which the dimension attribute values need to be restricted to.
Gg764355.protmethod(en-us,AX.60).gif getDimAttributeViewContract Gets an instance of the DimensionAttributeViewContract class for the specified dimension attribute record ID.
Gg764355.pubmethod(en-us,AX.60).gif getDimensionAttributeByControlIndex Retrieves the dimension attribute ID of the specified index in the control.
Gg764355.privmethod(en-us,AX.60).gif getDimensionAttributeValue
Gg764355.protmethod(en-us,AX.60).gif getReference Gets the record ID of the DimensionAttributeValueCombination record that is referenced by the dialog field or the table field. (Inherited from DimensionController.)
Gg764355.pubmethod(en-us,AX.60).gif getSegmentNames Retrieves an array of the dimension attribute names for each segment that is displayed in the control.
Gg764355.protmethod(en-us,AX.60).gif getStorageIndexArrayByDimensionAttribute Retrieves an array that contains the indexes where the specified dimension attribute is used in the DimensionStorage object.
Gg764355.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg764355.pubmethod(en-us,AX.60).gif getValue Gets the value of the specified dimension attribute. (Overrides the getValue Method.)
Gg764355.protmethod(en-us,AX.60).gif getValuesForHierarchyFromMRU Gets the most recently used values for a specified segment based on the segment values that have been entered.
Gg764355.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg764355.privmethod(en-us,AX.60).gif hasValue
Gg764355.protmethod(en-us,AX.60).gif isAccountStructureForced Indicates whether to only search for values for the current account structure before the point of disambiguation.
Gg764355.protmethod(en-us,AX.60).gif isControlEmpty Indicates whether the control is empty.
Gg764355.pubmethod(en-us,AX.60).gif jumpRef Uses the currently selected segment to provide functionality to go to main table to start the correct backing form in edit mode. (Overrides the jumpRef Method.)
Gg764355.pubmethod(en-us,AX.60).gif jumpRefDialogField Jumps to the dialog field when the dialog fields are dynamically added at runtime. (Inherited from DimensionController.)
Gg764355.pubmethod(en-us,AX.60).gif loadAutoCompleteData Retrieves the AutoComplete data for segment lookup purposes. (Inherited from DimensionController.)
Gg764355.pubmethod(en-us,AX.60).gif loadAutoCompleteDataDialogField Jumps to the dialog field when the dialog fields are dynamically added at runtime. (Inherited from DimensionController.)
Gg764355.protmethod(en-us,AX.60).gif loadEmptySegments Allows subclasses to define the behavior of the control when an identifier of a DimensionAttributeValueComination record is not provided.
Gg764355.privmethod(en-us,AX.60).gif loadFromDimensionHierarchy
Gg764355.pubmethod(en-us,AX.60).gif loadFromDimensionStorage Loads an instance of the DimensionStorage class into the control. (Overrides the loadFromDimensionStorage Method.)
Gg764355.privmethod(en-us,AX.60).gif loadFromDimensionStorageSegments
Gg764355.privmethod(en-us,AX.60).gif loadFromDimensionStructureInformation
Gg764355.pubmethod(en-us,AX.60).gif loadSegments Loads a previously stored DimensionAttributeValueComination record into the control. (Overrides the loadSegments Method.)
Gg764355.pubmethod(en-us,AX.60).gif loadSegmentsDialogField Loads the segments from the specified FormSegmentedEntryControl object. (Inherited from DimensionController.)
Gg764355.protmethod(en-us,AX.60).gif new Initializes a new instance of the LedgerDimensionController class. (Overrides the new Method.)
Gg764355.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg764355.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg764355.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg764355.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg764355.pubmethod(en-us,AX.60).gif parmControl Gets or sets the Control parameter. (Overrides the parmControl Method.)
Gg764355.pubmethod(en-us,AX.60).gif parmDataAreaId Gets or sets the DataAreaId parameter. (Overrides the parmDataAreaId Method.)
Gg764355.protmethod(en-us,AX.60).gif parmDataSource Sets a reference to the data source and field name that link to a DimensionAttributeValueCombination table. (Overrides the parmDataSource Method.)
Gg764355.pubmethod(en-us,AX.60).gif parmDate Gets or sets the Date parameter.
Gg764355.pubmethod(en-us,AX.60).gif parmDialogField Sets a reference to and initializes the override methods on the DialogField class that contain a value reference to a DimensionAttributeValueCombination record. (Inherited from DimensionController.)
Gg764355.pubmethod(en-us,AX.60).gif parmDimensionAccountStorageUsage Gets or sets the DimensionAccountStorageUsage parameter.
Gg764355.pubmethod(en-us,AX.60).gif parmDimensionAutocompleteFilter Gets or sets the DimensionAutocompleteFilter parameter.
Gg764355.pubmethod(en-us,AX.60).gif parmDisableMRU Gets or sets the DisableMRU parameter. (Inherited from DimensionController.)
Gg764355.protmethod(en-us,AX.60).gif parmIsChildController Checks whether the controller is a root-level controller or a child-level controller. (Inherited from DimensionController.)
Gg764355.protmethod(en-us,AX.60).gif parmProcessExcludedDAVLedgerOverrides Gets or sets the ProcessExcludedDAVLedgerOverrides parameter.
Gg764355.pubmethod(en-us,AX.60).gif parmSkipSuspendedAndActiveDateValidation Gets or sets the SkipSuspendedAndActiveDateValidation parameter. (Inherited from DimensionController.)
Gg764355.pubmethod(en-us,AX.60).gif parmValidateBlockedForManualEntry Gets or sets the ValidateBlockedForManualEntry parameter. (Inherited from DimensionController.)
Gg764355.privmethod(en-us,AX.60).gif raiseSetFieldValueForDimensionStorage Raises the DimensionLinkSetFieldValue event for each value in the DimensionStorage object.
Gg764355.privmethod(en-us,AX.60).gif removeCombinationFromMRU Removes the current combination from the instancec of the DimensionMRUProvider class.
Gg764355.protmethod(en-us,AX.60).gif removeHierarchyCombinationFromMRU Removes the specified combination of values from the most recently used list for the specified hierarchy.
Gg764355.pubmethod(en-us,AX.60).gif resolveReference Saves the current combination. (Overrides the resolveReference Method.)
Gg764355.pubmethod(en-us,AX.60).gif resolveReferenceDialogField Saves the segmented value combination. (Inherited from DimensionController.)
Gg764355.protmethod(en-us,AX.60).gif retrieveDimensionHierarchy Loads a dimension hierarchy into the control when the exact hierarchy to use is not known.
Gg764355.pubmethod(en-us,AX.60).gif segmentValueChanged Updates the controller when the value of a segment changes. (Inherited from DimensionController.)
Gg764355.pubmethod(en-us,AX.60).gif segmentValueChangedDialogField Updates the controller when the value of a segment changes. (Inherited from DimensionController.)
Gg764355.pubmethod(en-us,AX.60).gif setDataAreaId Sets an instance of the DataAreaId class that is used by the controller. (Overrides the setDataAreaId Method.)
Gg764355.pubmethod(en-us,AX.60).gif setDimensionSpecifierValues Sets the current dimension values that are based on the specified values.
Gg764355.protmethod(en-us,AX.60).gif setDimensionStorageSegments Sets the DimensionStorageSegment objects backing the specified control segment with the specified value.
Gg764355.protmethod(en-us,AX.60).gif setReference Sets the record ID of the DimensionAttributeValueCombination referenced by the dialog field or table field. (Inherited from DimensionController.)
Gg764355.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg764355.protmethod(en-us,AX.60).gif setValue Sets the value of the specified control segment by using the specified DimensionAttributeValue record.
Gg764355.pubmethod(en-us,AX.60).gif setValues Sets the current dimension values, depending on the specified set.
Gg764355.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg764355.privmethod(en-us,AX.60).gif updateStorageForStructureChange
Gg764355.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
Gg764355.pubmethod(en-us,AX.60).gif validate Validates the current combination. (Overrides the validate Method.)
Gg764355.protmethod(en-us,AX.60).gif validateCombination Determines the DimensionValidationStatus enumeration value for the dimension value combination currently in the control.
Gg764355.pubmethod(en-us,AX.60).gif validateDialogField Validates the fields. (Inherited from DimensionController.)
Gg764355.protmethod(en-us,AX.60).gif validateUsedDimensionAttributeValue Validates the specified dimension attribute value.
Gg764355.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg764355.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)
Gg764355.pubmethod(en-us,AX.60).gif Gg764355.static(en-us,AX.60).gif ::applyTotalSuspendedDateRanges Restricts the query to dimension attribute values that meet the specified criteria.
Gg764355.protmethod(en-us,AX.60).gif Gg764355.static(en-us,AX.60).gif ::doRestrictQueryToTreeValuesForHierarchy Determines whether restrictions are to be applied from the specified hierarchy.
Gg764355.pubmethod(en-us,AX.60).gif Gg764355.static(en-us,AX.60).gif ::getExcludedValuesFromDAVLedgerOverride Builds a Set containing the dimension value record ID's which need to be excluded from the lookup.
Gg764355.protmethod(en-us,AX.60).gif Gg764355.static(en-us,AX.60).gif ::getFilterSuspendTotalDateQueryCriteria Generates the query range criteria for filtering suspended, total and inactive date dimension attribute values.
Gg764355.privmethod(en-us,AX.60).gif Gg764355.static(en-us,AX.60).gif ::getLastPagedValue Retrieves the last paged value from the tag on the specified tag.
Gg764355.privmethod(en-us,AX.60).gif Gg764355.static(en-us,AX.60).gif ::getStorageAndStructure Gets an instance of the DimensionStorage and DimensionStructureInformation classes that are associated with the specified ID.
Gg764355.privmethod(en-us,AX.60).gif Gg764355.static(en-us,AX.60).gif ::getStructureForDimensionStorage Gets the structural information for the specified dimension storage instance.
Gg764355.pubmethod(en-us,AX.60).gif Gg764355.static(en-us,AX.60).gif ::restrictQueryDimensionAttributeValues Restricts the query to dimension attribute values that meet the specified criteria.
Gg764355.pubmethod(en-us,AX.60).gif Gg764355.static(en-us,AX.60).gif ::restrictQueryForRelationshipConstraints Restricts the query to dimension attribute values that are based on the relationships for the current account structure.
Gg764355.pubmethod(en-us,AX.60).gif Gg764355.static(en-us,AX.60).gif ::restrictQueryToCategorizedValues Restricts the query to dimension attribute values for the category associated with the specified dimension attribute.
Gg764355.pubmethod(en-us,AX.60).gif Gg764355.static(en-us,AX.60).gif ::restrictQueryToTreeValues Restricts the query to dimension attribute values by using the constraint trees.
Gg764355.pubmethod(en-us,AX.60).gif Gg764355.static(en-us,AX.60).gif ::restrictQueryToTreeValuesForHierarchy Restricts the query to dimension attribute values by using the constraint trees for the specfied hierarchy.
Top

Community Additions

ADD
Show: