WorkflowCancelManager Class [AX 2012]

The WorkflowCancelManager class can be used as the menu item class to manage workflow cancellation action.

class WorkflowCancelManager

Run On

Called

  MethodDescription
Gg829759.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif new Initializes a new instance of the Object class. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif run Contains the code that does the actual job of the class.
Gg829759.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif updateDocument Overridden in a derived class to perform the necessary application logic when the workflow cancel action is taken from the UI.
Gg829759.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)
Gg829759.pubmethod(en-us,AX.60).gif Gg829759.static(en-us,AX.60).gif ::cancelWorkflows Performs the cancellation logic by invoking the cancelWorkflow method on the Workflow class.
Gg829759.pubmethod(en-us,AX.60).gif Gg829759.static(en-us,AX.60).gif ::construct Initializes a new instance of the WorkflowCancelManager class.
Gg829759.pubmethod(en-us,AX.60).gif Gg829759.static(en-us,AX.60).gif ::getDialogContent Retrieves the content to be displayed in the cancel dialog box, including the caption, prompt, button text, and button help text.
Gg829759.pubmethod(en-us,AX.60).gif Gg829759.static(en-us,AX.60).gif ::getWorkflowsToCancel Retrieves the list of workflow correlation IDs to cancel.
Gg829759.pubmethod(en-us,AX.60).gif Gg829759.static(en-us,AX.60).gif ::main Provides an entry point for the WorkflowCancelManager class when it is called from a menu item.
Top

The WorkflowCancelManager class represents a default implementation of a menu item class for managing the workflow cancel action from the UI. This class can be either extended or used as is, depending on what needs to occur when a workflow instance has been chosen for cancellation.

Community Additions

ADD
Show: