BudgetPlan Class [AX 2012]
The BudgetPlan class provides information for a BudgetPlanHeader document.
| Method | Description | |
|---|---|---|
| cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
| defaultBudgetingOrganization | Sets a value for the BudgetingOrganization field of the BudgetPlanHeader table. |
| defaultBudgetPlanningProcess | Sets a value for the BudgetPlanningProcess field of the BudgetPlanHeader table. |
| defaultBudgetPlanningStage | Sets a value for the BudgetPlanningStage field of the BudgetPlanHeader table. |
| defaultBudgetPlanPreparer | Sets a value for the BudgetPlanPreparer field of the BudgetPlanHeader table. |
| defaultDocumentNumber | Provides a default value for the DocumentNumber field of the BudgetPlanHeader table. |
| defaultField | Applies the default values for the specified field. |
| defaultRow | Applies the default field values for a BudgetPlanHeader record. |
| equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
| getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
| handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
| hasParentPlanWithParentOrganization | Verifies that the OMInternalOrganization record ID is a child organization of the OMInternalOrganization record ID on the parent BudgetPlanHeader record. |
| modifiedBudgetingOrganization | Sets additional field values based on the modified BudgetingOrganization field value. |
| modifiedBudgetPlanningProcess | Sets additional field values based on the modified BudgetPlanningProcess field value. |
| modifiedField | Verifies or sets additional field values based on the modified field. |
| new | Initializes a new instance of the BudgetPlan 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.) |
| parmAxBudgetPlanHeader | Gets or sets the AxBudgetPlanHeader parameter. |
| parmBudgetPlanHeader | Gets or sets the BudgetPlanHeader parameter. |
| 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.) |
| validateBudgetingOrganization | Indicates whether the BudgetingOrganization field in the BudgetPlanHeader table is valid. |
| validateBudgetPlanningProcess | Indicates whether the BudgetPlanningProcess field in the BudgetPlanHeader table is valid. |
| validateBudgetPlanPreparer | Indicates whether the BudgetPlanPreparer field in the BudgetPlanHeader table is valid. |
| validateBudgetPlanPriority | Indicates whether the BudgetPlanPriority field in the BudgetPlanHeader table is valid. |
| validateField | Validates the value for a specific field. |
| validateParentBudgetPlanHeader | Indicates whether the ParentBudgetPlanHeader field in the BudgetPlanHeader table is valid. |
| wait | Pauses a process. (Inherited from Object.) |
| xml | Returns an XML string that represents the current object. (Inherited from Object.) |
| ::allChildPlansHaveAccessLevelSet | Determines whether all child budget plans for the specified parent budget plan have their access level set. |
| ::approveWorkflow | Approves the workflow for the budget plan document. |
| ::areUnitOfMeasureValuesEqual | Validates the value of the UnitOfMeasureClass fields are equal for two BudgetPlanScenario records. |
| ::canAddBudgetPlanLine | Determines whether the budget plan header can have budget lines added. |
| ::cancelWorkflow | Cancels the budget plan. |
| ::checkBudgetPlanHeaderForWrite | Indicates whether the BudgetPlanHeader record is valid and ready to be written to the database. |
| ::checkBudgetPlanNumberSequence | Validates the number sequence that is set up for the budget plan ID. |
| ::checkIsParentBudgetPlanRequired | Validates whether a parent budget plan is required. |
| ::checkWorkflowStatusForDelete | Indicates whether a budget plan can be deleted that has the specified BudgetPlanWorkflowStatus enumeration value. |
| ::construct | Initializes a new instance of the BudgetPlan class. |
| ::convertPathToUri | Converts the path to uri, assuming the path is an absolute path. |
| ::convertsToAbsolutePath | Converts the file path to the absolute path. |
| ::copyBudgetPlan | Copies the caller BudgetPlanHeader record. |
| ::createBudgetPlanningProcessTmpTable | |
| ::createBudgetPlanPriorityTmpTable | |
| ::createBudgetPlanScenarioTmpTable | |
| ::createWorkflowChildren | Creates budget plans for all budget organizations in the hierarchy. |
| ::createWorkflowChildrenInternal | Creates budget plans for all budget organizations in the hierarchy. |
| ::defaultRowForChild | Initializes the child BudgetPlanHeader record from the parent BudgetPlanHeader record. |
| ::defaultRowForCopy | Initializes the copy BudgetPlanHeader record from a source BudgetPlanHeader record. |
| ::defaultRowForCreate | Initializes the BudgetPlanHeader record. |
| ::doesBudgetPlanHaveAccessLevel | Determines whether the budget plan header has scenario constraint access level. |
| ::doesBudgetPlanHaveChild | Indicates whether the budget plan header has a child record. |
| ::doesChildrenBudgetPlansHaveAccessLevel | Determines whether the budget plan header has scenario constraint access level. |
| ::existScenarioForBudgetPlan | Indicates whether a budget plan line exists for BudgetPlanHeader and BudgetPlanScenario combination. |
| ::existScenarioForChildBudgetPlan | Determines if the specified BudgetPlanHeader has any child budget plans with lines referencing the specified BudgetPlanScenario. |
| ::existWorkerForBudgetPlanningOrganization | Verifies that the current user belongs to one of the organizations in the budget planning hierarchy. |
| ::getAccountStructure | Gets the ID of an account structure if a valid account structure is found with the specified name for the specified ledger. |
| ::getAccountStructureQueryByLedger | Gets the account structure query for the specified Ledger table record ID. |
| ::getBudgetingOrganizationQuery | Builds a query to retrieve a list of OMInternalOrganization records. |
| ::getBudgetPlanHeaderReferenceQuery | Builds a query to retrieve BudgetPlanHeader records. |
| ::getBudgetPlanIdBasedOnProcessLedger | Determines the number sequence ID based on the process associated with the budget plan document. |
| ::getBudgetPlanningProcessQuery | Builds a query to retrieve a list of active BudgetPlanningProcess records. |
| ::getBudgetPlanNumberSeqBasedOnProcess | Determines the number sequence reference based on the process associated with the budget plan document. |
| ::getBudgetPlanPreparerQuery | Builds a query that retrieves a list of active workers. |
| ::getBudgetPlanPriorityQuery | Builds a query to retrieve a list of BudgetPlanPriority records. |
| ::getBudgetPlanScenarioConstraintQuery | Builds a query to retrieve a list of BudgetPlanScenario records. |
| ::getBudgetPlanScenarioForBudgetPlan | Gets the BudgetPlanScenario record ID for the budget plan. |
| ::getBudgetPlanScenarioQuery | Builds a query to retrieve a list of BudgetPlanScenario records. |
| ::getChildBudgetingOrganizationQuery | Builds a query to retrieve a list of OMInternalOrganization records. |
| ::getChildBudgetPlans | Gets a Set of child budget plans for the specified parent BudgetPlanHeader record ID. |
| ::getChildBudgetPlansInternal | Gets a packed Set of child budget plans for the specified parent BudgetPlanHeader record ID. |
| ::getDataAreaId | Gets the data area ID associated with the specified BudgetPlanHeader reference. |
| ::getMaxScenarioLineNumber | Gets the highest ScenarioLineNumber value for the specified parameters. |
| ::getNextPlanningStage | Gets the next budget planning stage for the budget plan. |
| ::getParentBudgetPlanHeaderQuery | Builds a query to retrieve a list of parent BudgetPlanHeader records. |
| ::getScenarioAccessLevelForBudgetPlan | Determines the access level of BudgetPlanScenarioConstraint record associated with BudgetPlanHeader record. |
| ::getWorkflowVersionTable | Gets the WorkflowVersionTable record associated to the BudgetPlanningWorkflow record. |
| ::getWorkflowWorkItemForCurrentUser | Gets the pending WorkflowWorkItemTable record for the current BudgetPlanHeader record and current user. |
| ::isBudgetPlanValidForCompletion | Indicates whether the budget plan header is valid for completion. |
| ::isOrganizationInBudgetPlanningHierarchy | Verifies that the OMInternalOrganization record ID belongs to the organization hierarchy on the BudgetPlanningProcess table. |
| ::isOrganizationVisibleToWorker | Verifies that the OMInternalOrganization record ID is visible to the specified worker. |
| ::isReadyForReview | Indicates whether the budget plan header can be submitted to the workflow. |
| ::jumpRefLookupRecord | Runs the reference form for the specified lookup record. |
| ::lookupBudgetingOrganization | Performs the lookup for the budgeting organization records in the OMInternalOrganization table. |
| ::lookupBudgetPlanHeaderReference | Performs the lookup for the document number records in table BudgetPlanHeader. |
| ::lookupBudgetPlanningProcess | Performs the lookup for the BudgetPlanningProcess records. |
| ::lookupBudgetPlanningProcessReference | Performs the lookup for the BudgetPlanningProcess records. |
| ::lookupBudgetPlanPriority | Performs the lookup for the BudgetPlanPriority records. |
| ::lookupBudgetPlanScenario | Performs the lookup for the budget plan scenario records in the BudgetPlanScenario table. |
| ::lookupBudgetPlanScenarioReference | Performs the lookup for the BudgetPlanScenario records. |
| ::lookupHcmPosition | Performs the lookup for the HcmPosition records. |
| ::lookupParentBudgetPlanHeader | Performs the lookup for the BudgetPlanHeader records. |
| ::lookupWorker | Performs the lookup for the HcmWorker records. |
| ::rejectWorkflow | Sets the workflow status to rejected for the budget plan. |
| ::releaseBudgetPlanDocumentNumber | Releases the unused number for budget plan. |
| ::resetBudgetPlan | Resets the BudgetPlanHeader status. |
| ::setBudgetPlanningStage | Sets the planning stage of the budget plan document. |
| ::setDocumentStatus | Set the status of a budget plan document. |
| ::setWorkflowStatus | Sets the workflow status for the budget plan header. |
| ::startChildWorkflow | Starts the workflow for the child budget plan document. |
| ::startWorkflow | Starts the workflow for the budget plan document. |
| ::updateParentBudgetPlanHeaderForChild | Associates a selected budget plan with the parent budget plan. |
| ::validateLedgerDimensionsByBudgetPlan | Validates the ledger dimensions for the specified BudgetPlanHeader reference. |
| ::validateScenarioContraintExists | Validates if the scenario name has a valid BudgetPlanScenarioConstraint record. |
| ::validateWorkerBelongsToPlanningHierarchy | Validates that the current user belongs to one of the organizations in the budget planning hierarchy. |
| ::validateWorkflowTableSequenceNumber | Indicates whether the WorkflowTableSequenceNumber field is valid. |
Community Additions
ADD
Show: