WorkflowDocument Class [AX 2012]
The WorkflowDocument class represents the base class for all documents that are enabled for workflow.
Syntax
class WorkflowDocument
Run On
Called
Methods
Method | Description | |
---|---|---|
cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) | |
equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) | |
getQuery | Returns an initialized query object based on the query name that is returned from the getQueryName method. | |
getQueryName | Returns the query name for this workflow document. | |
getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) | |
handle | Retrieves the handle of the class of the object. (Inherited from Object.) | |
new | Initializes a new instance of the Object class. (Inherited from Object.) | |
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.) | |
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.) | |
wait | Pauses a process. (Inherited from Object.) | |
xml | Returns an XML string that represents the current object. (Inherited from Object.) |
Top
Remarks
A derived WorkflowDocument class returns information about the data structure that is associated to a given workflow. This data structure is represented by a query defined in the Application Object Tree.
Derived classes also represent a placeholder for calculated fields. Calculated fields are supported via implementing a method prefixed with 'parm'. These methods will be surfaced in the workflow condition editor and also as placeholder tokens when defining messages within the workflow configuration UI. These 'parm' methods require a unique extended data type as a return value because the label from the extended data type is surfaced in the workflow condition editor and in the workflow configuration UI.
Inheritance Hierarchy
Object Class
WorkflowDocument Class
AdvancedLedgerEntryWFDocument Class
BankReconciliationApprovalDocument Class
BudgetPlanReviewWorkflowDocument Class
BudgetTransactionLineWorkflowDocument Class
BudgetTransactionWorkflowDocument Class
CaseDocument Class
CatProductApprovalDocument Class
CatVendCatalogApprovalDocument Class
CustFreeInvoiceWorkflowDocument Class
CustRecurrenceInvoiceWFDocument Class
DocumentHandlingDocument Class
HcmBenefitEligibilityExpressionSetup Class
HcmPositionActionWorkflowDocument Class
HcmWorkerActionHireWorkFlowDocument Class
HcmWorkerActionTerminateWorkFlowDocument Class
HcmWorkerActionTransferWorkflowDocument Class
HRPLimitRequestDocument Class
JmgDaysTotalWorkflowDocument Class
JmgJournalRegWorkflowDocument Class
JmgPayRule Class
LedgerJournalWFApprovalDocument Class
ProjBudgetOrigWorkflowDocument Class
ProjBudgetRevWorkflowDocument Class
PSAProjInvoiceProposalDocument Class
PSAProjQuotationDocument Class
PurchAgreementWorkflowDocument Class
PurchCommitmentWFDocument_PSN Class
PurchCORPackingslipErrorDocument Class
PurchCORPurchLineDocument Class
PurchCORRejectsDocument Class
PurchLineDocument Class
PurchReqControlSubmissionExpressionSetup Class
PurchReqDocument Class
PurchReqWFLineDocument Class
PurchTableDocument Class
RetailCatalogApprovalDocument Class
smmSalesProcessExpressionSetup Class
TAMCustRebateApprDocument Class
TAMPromoMgmtApprovalDocument Class
TAMVendRebateApprDocument Class
TMSInvoiceApprovalDocument Class
TrvHeaderRuleExpressionSetup Class
TrvPolicyExpressionSetup Class
TrvReqHeaderRuleExpressionSetup Class
TrvRequisitionRuleExpressionSetup Class
TrvRuleExpressionSetup Class
TrvWorkflowCashAdvance Class
TrvWorkflowDisputes Class
TrvWorkflowExpHeader Class
TrvWorkflowExpLines Class
TrvWorkflowRequisition Class
TrvWorkflowTax Class
TSWorkflowTimesheet Class
TSWorkflowTimesheetLines Class
UserRequestDocument Class
VendInvoiceDocument Class
VendInvoiceLineDocument Class
VendRequestCatNCADocument Class
VendRequestCatNCJDocument Class
VendRequestNVADocument Class
VendRequestNVJDocument Class
VendRequestStatusChangeDocument Class