LedgerAllocationProcessReqByBudgetPlan Class [AX 2012]

The LedgerAllocationProcessReqByBudgetPlan class is used to create the list of BudgetPlanLine table buffers as per the specified ledger allocation rule.

Syntax

class LedgerAllocationProcessReqByBudgetPlan

Run On

Called

Methods

	Method	Description
	allocate	Controls the processing of allocation request for specified ledger allocation rule and adds BudgetPlanLine table buffers in the list.
	calcDestinationValues	Computes the distribution value for a destination line, and adjusts totals and remaining amounts and quantities.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	createBudgetPlanLineDestinations	Creates destination BudgetPlanLine table buffers as per the specified LedgerAllocationRule table's LedgerAllocationRuleID field.
	createSpreadEvenDestinations	Creates the destination BudgetPlanLine table buffers in the case where the allocation method is Spread Even and Source BudgetPlanLine table record's main account, dimensions or both are to be used to create the LedgerDimenison field of destination BudgetPlanLine table buffers.
	deleteBudgetPlanLinesByLedgerDimension	Deletes the matching BudgetPlanLine table records in the target scenario, after confirmation from the user.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getBudgetPlanningQuery	Creates a query to retrieve the BudgetPlanLine table records based on the ledger allocation rules source criteria.
	getListOfBudgetPlanLineDistributions	Returns the list of BudgetPlanLine table buffers.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	initBasisValues	Determines the basis amount for each destination BudgetPlanline table record against each LedgerAllocationBasisRule table record id.
	initDestinationAllocationSettings	Determine the total number of destination BudgetPlanLine buffers to be created.
	initFixedPercentage	Fixed Percentage allocation method requires all destinations to be user-specified.
	initFixedWeight	Fixed Weight allocation method requires all destinations to be user-specified.
	initRequest	Initialize the LedgerAllocationProcessReqByBudgetPlan class.
	initSourceValues	Intializes the source amounts and quantities to allocate.
	initSpreadEven	Determine the number of destination allocations to be created for spread even method.
	new	Initializes a new instance of the LedgerAllocationProcessReqByBudgetPlan 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.)
	setAccountValues	Retrieves the LedgerDimension field of BudgetPlanLine table record and creates a new a default account and retrieves the record ID of the persisted DimensionAttributeValueCombination table record.based on the Main Account in the BudgetPlanLine table's LedgerDimension field.
	setDimensionValues	Retrieves ledgerDimension field from BudgetPlanLine table record and converts it to DimensionDefault extended data type.
	setDistributionValues	Assigns the value in the BudgetPlanLine table record buffer for allocation.
	setLedgerDimensionValues	Retrieves the LedgerDimension field of BudgetPlanLine table record and add it to the instance of Set class named setLedgerDimension.
	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.)
	validateBasisRules	The allocation rule is of allocation type = Basis. Iterate through each destination line for the rule and validate the Basis Id assigned to that destination line.
	validateRequest	Validates the ledger allocation rule and basis rules.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::construct	Initializes a new instance of the LedgerAllocationProcessReqByBudgetPlan class.
	::deleteBudgetPlanLines	Deletes the BudgetPlanLine table records that are returned by specified QueryRun class instance.

Top

Remarks

The LedgerAllocationProcessReqByBudgetPlan class is similar to LedgerAllocationProcessRequest class.

Inheritance Hierarchy

Object Class
  LedgerAllocationProcessReqByBudgetPlan Class