BudgetControlProcessor Class [AX 2012]

The BudgetControlProcessor class provides the interface that is used to interact with the budgetary control.

Syntax

class BudgetControlProcessor

Run On

Server

Methods

	Method	Description
	abortProcessForBudgetCheckFailure	Determines whether the process must be aborted for a budget check failure.
	activateTracking	Activates budget source details tracking.
	addBudgetCheckRequestToProcessAtCommit	Adds an instance of the BudgetControlCheckRequest class to the collection to be processed.
	addBudgetControlDetailsToProcessCheck	Adds the budget control details that contain the budget checking transaction currency totals for each source ledger dimension for later budget checking processing.
	addBudgetControlDetailsToProcessRelief	Adds the budget control details that contain the budget checking transaction currency totals for each source ledger dimension to check budget and the budget relieving transaction currency totals for each source ledger dimension whose budget funds are to be relieved for later budget funds relieving processing.
	addBudgetReturnDetailsToProcessCheck	Adds the budget return details with the budget checking transaction currency totals for each source ledger dimension for later budget checking processing.
	addBudgetSourceError	Adds the specified error message, error type, and error to the collection for the current budget source.
	addBudgetSourceToRemoveAtCommit	Adds the record ID of the BudgetSource record to the collection to be removed.
	addBudgetSourceToReturnRemainingAtCommit	Adds the budget source details to the collection to be processed for return.
	addCheckDetailToTransCurrencyTotal	Adds budget source detail transaction currency amount to check budget to the transaction currency total.
	addLedgerToCleanupDrafts	Adds the ledger to be processed for draft reservation cleanup on transaction commit.
	addRelievingDetailToTransCurrencyTotal	Adds budget source detail transaction currency amount to check budget to the budget check transaction currency total and the amount to relieve budget to the budget relieving transaction currency total.
	areProcessingDetailsPrepared	Indicates whether there are any processing details prepared for budget check.
	areProcessingDetailsPreparedForCurrent	Indicates whether there are any processing details prepared for the current budget source.
	areWarningsSuppressed	Determines whether warnings are suppressed for the specified user and budget control configuration.
	cacheCurrentBudgetResultDetails	Caches the current result related details for the current budget source.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	clearTableCache
	convertAmountCurToAmountMst	Converts the specified amount in the specified currency to the accounting currency of the ledger using the budget exchange rate type.
	determineBudgetCheckMessages	Determines the messages that result from the budget check for the specified budget source.
	determineDetailGroupStatus	Determines the result of the check of the available budget based on the specified BudgetCheckResult values for the detail and the group.
	determineErrorMessages	Indicates the error messages for the available budget check based on the specified BudgetCheckResultErrorWarningDetail records.
	determineMessagesForCheckResultDetails	Determines messages based on the specified BudgetCheckResultErrorWarningDetail records.
	determineWarningMessages	Determines the warning messages for the check of the available budget based in the specified BudgetCheckResultErrorWarningDetail records.
	displayBudgetCheckMessages	Displays error and warning messages that result from the budget check.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getBudgetRelievingDetailKey
	getBudgetSourceDetailKey
	getBudgetSourceTrackingToRelieve	Gets the budget source tracking record whose budget source tracking ledger dimension budget funds are to be relieved.
	getDimensionDisplayValue
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	initialize	Initializes an instance of the BudgetControlProcessor class.
	isAmountWithinBoundary
	loadCurrentBudgetControlDetails	Loads the control processing related details for the current budget source.
	loadCurrentBudgetResultDetails	Loads the result processing related details for the current budget source.
	markDraftsForCleanupByIntegrator	Marks the draft budget source tracking data for deletion.
	markDraftsForCleanupByLedger	Marks the draft budget source tracking data for deletion.
	new	Initializes a new instance of the BudgetControlProcessor 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.)
	parmDoBudgetCheckAsSimulation	Gets or sets the DoBudgetCheckAsSimulation parameter.
	parmDoBudgetCheckForConfirmation	Gets or sets the DoBudgetCheckForConfirmation parameter.
	parmDoDisplayMessagesFromBudgetCheck	Gets or sets the DoDisplayMessagesFromBudgetCheck parameter.
	postProcessForBudgetAvailableCheck	Performs the post-processing logic after the budget check that includes determining error and warning messages.
	postProcessForBudgetControlRemoval	Performs post-processing logic after processing for removal.
	prepareBudgetSourceForRemoval	Prepares the budget source record ID for removal processing.
	prepareBudgetSourceForReturn	Prepares the budget source record ID for removal processing.
	preProcessForBudgetAvailableCheck	Performs the pre-processing logic in preparation for the budget check that includes the validation of details to be checked, marking details for deletion and return, and tracking of relieving details and budget check details.
	preProcessForBudgetControlRemoval	Performs the pre-processing for removal of the BudgetSource records.
	preProcessForBudgetControlReturn	Performs the pre-processing for return for the BudgetSource records that are designated to return the remaining funds.
	processForBudgetControl	Calls the stored procedure for performing the budget check.
	resetCurrentMembers	Resets the state of the class variables caching details about the current budget source.
	resetProcessor	Resets the class variables for the instance.
	runBudgetControlProcessing	Performs the budget control processing for budget sources to be removed, budget sources for which to return the remaining funds and budget check requests.
	runDraftBudgetCleanup	Performs the cleanup of draft budget reservations.
	saveBudgetCheckResultErrorWarningDetails
	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.)
	trackBudgetControlDetails	Tracks all budget control details that are associated with the current budget source.
	trackBudgetControlDetailsToRelieve	Tracks all relieving budget control details that are associated with the current budget source.
	trackBudgetReturnDetails	Tracks all budget return details that are associated with the current budget source.
	trackSimulatingBudgetSource	Tracks the simulating budget source that simulates budget fund reservations from another budget source.
	ttsNotifyAbort	Performs processing for the budget control in case of a transaction abort.
	ttsNotifyCommit	Performs processing for the budget control for a transaction commit.
	ttsNotifyPostBegin	Performs processing for the budget control for a transaction begin.
	ttsNotifyPreCommit	Performs processing for the budget control during the transaction commit sequence.
	updateBudgetSourceForInvalidRequest	Updates the current BudgetSource record with the overall budget control result of invalid request.
	updateBudgetSourceForPreProcessResult	Updates the current BudgetSource record with the overall budget control result determined by pre-processing.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	validateBudgetCheckDetails	Validates the budget check details input from the BudgetControlCheckRequest class.
	validateBudgetModel	Validates the budget model ID input from the BudgetControlCheckRequest object.
	validateBudgetRelievingDetails	Validates budget relieving details.
	validateBudgetReturnDetails	Validates the budget return details input from the BudgetControlCheckRequest object.
	validateBudgetSource	Validates the budget source record ID specified by an instance of the BudgetControlCheckRequest class.
	validateBudgetSourceDetail	Validates the budget source ledger dimension detail.
	validateBudgetSourceDetails	Validates all budget source details input from the BudgetControlCheckRequest object.
	validateBudgetSourceLedgerDimension	Validates a budget source ledger dimension.
	validateBudgetSourceToRelieve	Validates the budget source whose ledger dimension budget funds are to be relieved.
	validateCurrency	Validates the currency specified.
	validateDate	Validates the date input from the BudgetControlCheckRequest class.
	validateDateForOpenFiscalPeriod	Validates that the specified date is in an open fiscal period for the ledger of the specified legal entity.
	validateForBudgetAvailableCheck	Validates the user, date and budget model inputs from the BudgetControlCheckRequest object.
	validateLegalEntityToCheckBudget	Validates the legal entity that is associated with the ledger dimension to check budget.
	validateLegalEntityToRelieveBudget	Validates the legal entity that are associated with the ledger dimension whose budget funds are to be relieved.
	validateRelievingCategories	Validates the specified budget control category that contains the current budget source.
	validateUser	Validates the user input from the BudgetControlCheckRequest object.
	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 BudgetControlProcessor class.
	::invokeBudgetCheckStoredProcedure	Calls the budget check stored procedure to perform budget check.
	::invokeBudgetControlSaveErrorWarnProc	Calls the budget control save error warning results stored procedure.

Top

Remarks

This class is to be called by the integrators to budgetary control to check for available budget and remove the budgetary control data that is related to a budget source when it is deleted.

Inheritance Hierarchy

Object Class
  BudgetControlProcessor Class