DimensionTree Class [AX 2012]

The DimensionTree class provides an API for creating and editing dimension constraint trees.

Syntax

  Microsoft Dynamics AX 2012 R3
          class DimensionTree implements SysPackable

  Microsoft Dynamics AX 2012 R2 (SYS)
          class DimensionTree

  Microsoft Dynamics AX 2012 Feature Pack (SYS)
          class DimensionTree

  Microsoft Dynamics AX 2012 (FPK)
          class DimensionTree

  Microsoft Dynamics AX 2012 (SYS)
          class DimensionTree

Run On

Called

Methods

	Method	Description
	addLevel	Adds the dimension attribute to the tree at the specified level.
	addLevelPrivate	Adds the dimension attribute to the tree at the specified level.
	addNode	Inserts a constraint node record at the specified point.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	clearLevels	Deletes all tree nodes at the specified levels.
	createCriteriaRecords	Creates the criteria records for the node.
	createNode	Creates an instance of the DimensionTreeNode class.
	createStarBranch	Appends nodes that contain "*" to the node until all hierarchy levels are filled.
	createStarNode	Creates a star node for the specified hierarchy level.
	deleteNodeAndChildren	Deletes the constraint node and all its child nodes.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	fillHierarchyCache	Fills the hierarchy cache variables for the current tree.
	fixupJournalControlTree	Updates the specified journal control hierarchy and tree for an account structure modification.
	getDisambiguationLevel	Determines the level at which the tree can be disambiguated with the existing account structures.
	getDisambiguationLevelByLedger	Determines the level at which the tree can be disambiguated with the existing account structures.
	getHierarchyId	Gets the ID of the hierarchy record.
	getHierarchyLevelId	Gets the ID of the hierarchy level record at the specified level.
	getHierarchyName	Retrieves the hierarchy name.
	getLevel	Gets the level for the hierarchy level record.
	getMatchingLevelCount	Determines the number of levels with matching dimension attributes.
	getMaxOrdinal	Gets the maximum ordinal of the sibling nodes for the specified parent node.
	getParentNodeLevel	Gets the hierarchy level of the parent node.
	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 an instance of the DimensionTree class.
	initHierarchySynchronization	Initializes certain class variables that are needed for the subsequent hierarchy synchronization process.
	moveLevel	Moves the dimension attribute at the specified level to a new level position.
	moveLevelPrivate	Moves the dimension attribute at the specified level to a new level position.
	new	Initializes a new instance of the DimensionTree 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.)
	pack	Serializes the current instance of the DimensionTree class.
	parmLastModifiedId	Gets the LastModifiedId parameter.
	parmLevelCount	Gets the LevelCount value.
	removeLevel	Removes the dimension attribute from the tree at the specified level.
	removeLevelPrivate	Removes the dimension attribute from the tree at the specified level.
	removeNode	Deletes the constraint node and all its child nodes.
	retrieveLastModifiedId	Retrieves the last modified ID for the current tree value from the database and caches it locally.
	setActiveDates	Sets the active dates for the specified DimensionConstraintNode record.
	setLevelActiveDates	Sets the active dates for the added level.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	structureType	Retrieves the structure type of the tree.
	synchronizeHierarchies	Synchronizes the account structure hierarchy changes with its related journal control and alias records.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	unpack	Deserializes the _packedClass parameter value to an instance of the DimensionTree class.
	updateErrorInChildren	Updates the HasErrorInChildren flag in the pertinent tree nodes.
	updateLastModifiedId	Updates the last modified ID of the current record to a new GUID and caches the new value.
	updateNode	Updates an existing constraint node record with the specified values.
	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.)
	::activateDraft	Converts the draft tree into the active tree
	::addLevelServer	Adds the dimension attribute to the tree at the specified level.
	::checkForMainAccount	Indicates whether the main account is part of the hierarchy.
	::clearTree	Clears the specified tree.
	::compareHierarchies	Indicates whether two hierarchies have the same structure.
	::construct	Constructs an instance of the DimensionTree class.
	::constructDimTreeForAccountStructures	Constructs an instance of the DimensionTree class.
	::copyTree	Creates a copy of the whole tree.
	::create	Creates an instance of the DimensionTree class from a packed copy.
	::createDraft	Creates a draft version of the tree.
	::createSystemTree	Creates an empty, system generated constraint tree.
	::createTree	Creates an empty constraint tree.
	::createTreePrivate	Creates an empty constraint tree.
	::deleteAllNodes	Deletes all tree nodes for the specified tree.
	::deleteDraft	Deletes the draft version of a tree.
	::deleteTree	Deletes the tree.
	::deleteTreeAndHierarchy	Deletes the whole tree. This includes the underlying hierarchy.
	::displayDuplicateTreeNameError	Displays an error message for duplicate tree names.
	::draftExists	Determines whether a draft version of the specified tree exists.
	::duplicateTree	Creates a copy of the whole tree.
	::getConstraintText	Gets a string that represents all of the criteria for a node that matches the specified criteria.
	::getDisambiguationDepth	Calculates the number of segments before the disambiguation point for all account structures in the specified chart of accounts.
	::getDisambiguationDepthByLedger	Calculates the number of segments before the disambiguation point for all account structures in the specified ledger.
	::getDisambiguationDepthForTreeImages	Calculates the disambiguation depth for the specified trees.
	::getDisambiguationDepthForTrees	Determines the level at which the two nodes can be disambiguated.
	::getDisambiguationTreeDepth	Determines the level at which two trees can be disambiguated.
	::getMainAccountCriteria	Retrieves the main account criteria for the specified tree
	::getOverlappingErrorMessage	Gets the error message for a node with an overlapping criteria.
	::getSameStructureDepth	Determines the number of leading levels that match for both trees by dimension attribute.
	::isCriteriaIntersecting	Checks if the criteria intersect.
	::isMainAccountOverlapping	Check if main account is overlapping within a specified ledger.
	::isNodeDisjoint	Indicates whether the node has overlapping criteria at the specified point.
	::isNodeIntersecting	Indicates whether the nodes have overlapping criteria.
	::isValidForActivate	Indicates whether a draft tree can be activated.
	::isValidForAssign	Indicates whether an active account structure can be assigned to a chart of accounts
	::isValidForAssignByLedger	Indicates whether an active account structure can be assigned to a ledger
	::logIsOptionalWarning	Sends the correct warning message to the Infolog for a node with the IsOptional value of true.
	::moveLevelServer	Moves the dimension attribute at the specified level to a new level position.
	::removeLevelServer	Removes the dimension attribute from the tree at the specified level.
	::retrieveLastModifiedIdForTree	Gets the last modified ID for the specified tree.
	::updateLastModifiedIdStatic	Updates the last modified ID of the specified tree to a new value.

Top

Inheritance Hierarchy

Object Class
  DimensionTree Class