IWorkflowContextAction

```
public interface IWorkflowContextAction
```
Interface describing the available methods for an execution of an action.

The macro associated with an action must implement the function 'executeAction' whose setting is the 'context' object.
The methods apply to this object 'context'.

Version:

1.0

Author:

LCY

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`cancel()` Allows you to cancel the current transition
`void`	`desactivateExecuteAction()`
`com.mega.modeling.api.MegaObject`	`getCurrentWorkflowStatusInstance()` Retrieves the MegaObject of current workflow status instance (Read only).
`com.mega.modeling.api.MegaObject`	`getCurrentWorkflowStatusInstanceDescription()` Retrieves the MegaObject of current workflow status instance (Read only).
`java.lang.String`	`getErrMessage()`
`com.mega.modeling.api.MegaObject`	`getNewWorkflowStatusInstance()` Retrieves the MegaObject of new workflow status instance (Read only).
`com.mega.modeling.api.MegaObject`	`getNewWorkflowStatusInstanceDescription()` Retrieves the MegaObject of new workflow status instance (Read only).
`com.mega.modeling.api.MegaRoot`	`getRoot()` Retrieves the MEGA root object (Read only).
`com.mega.modeling.api.MegaCollection`	`getTransitionInstances(java.lang.String strTransitionInstancesParam)` Retrieves the collection of workflow transition instances (Read only) corresponding to the asked transition.
`com.mega.modeling.api.MegaObject`	`getWorkflowAction()` Retrieves workflow action (Read only).
`java.lang.String`	`getWorkflowActionID()` Retrieves the MegaField of current workflow action (Read only).
`com.mega.modeling.api.MegaObject`	`getWorkflowDefinition()` Retrieves current workflow definition (Read only).
`java.lang.String`	`getWorkflowDefinitionID()` Retrieves the MegaField of current workflow definition (Read only).
`java.lang.Double`	`getWorkflowExecutionUserId()` Get the workflow execution user
`com.mega.modeling.api.MegaObject`	`getWorkflowInstance()` Retrieves the MegaObject of current workflow status instance (Read only). The specification of this MegaObject is available in the informal query "~y1H7f3I6FXfH[Workflow Instance Description]"
`com.mega.modeling.api.MegaObject`	`getWorkflowInstanceDescription()` Retrieves the MegaObject of current workflow status instance (Read only). The specification of this MegaObject is available in the informal query "~y1H7f3I6FXfH[Workflow Instance Description]"
`com.mega.modeling.api.MegaObject`	`getWorkflowSubject()` Retrieves the MegaObject of subject of current workflow instance (Read only).
`com.mega.modeling.api.MegaObject`	`getWorkflowTransition()` Retrieves current workflow transition (Read only).
`java.lang.String`	`getWorkflowTransitionID()` Retrieves the MegaField of current workflow transition (Read only).
`boolean`	`isBatchMode()`
`boolean`	`isExecuteAction()`
`void`	`setActionRunTime(java.lang.String strActionRunTime)` Sets Action Run Time : before dispatch ("BD") or after dispatch ("AD").
`void`	`setErrMessage(java.lang.String strErrMessage)`

- Method Detail
  - getRoot
```
com.mega.modeling.api.MegaRoot getRoot()
```
    Retrieves the MEGA root object (Read only).
    
    Returns:
    
    MegaRoot
  - isExecuteAction
```
boolean isExecuteAction()
```
  - isBatchMode
```
boolean isBatchMode()
```
  - desactivateExecuteAction
```
void desactivateExecuteAction()
```
  - setActionRunTime
```
void setActionRunTime(java.lang.String strActionRunTime)
```
    Sets Action Run Time : before dispatch ("BD") or after dispatch ("AD"). Default value is Before Dispatch.
    
    Parameters:
    
    strActionRunTime - String : before dispatch ("BD") or after dispatch ("AD")
  - getErrMessage
```
java.lang.String getErrMessage()
```
  - setErrMessage
```
void setErrMessage(java.lang.String strErrMessage)
```
  - getWorkflowActionID
```
java.lang.String getWorkflowActionID()
```
    Retrieves the MegaField of current workflow action (Read only).
    
    Returns:
    
    String
  - getWorkflowAction
```
com.mega.modeling.api.MegaObject getWorkflowAction()
```
    Retrieves workflow action (Read only).
    
    Returns:
    
    MegaObject
  - getWorkflowDefinitionID
```
java.lang.String getWorkflowDefinitionID()
```
    Retrieves the MegaField of current workflow definition (Read only).
    
    Returns:
    
    String
  - getWorkflowDefinition
```
com.mega.modeling.api.MegaObject getWorkflowDefinition()
```
    Retrieves current workflow definition (Read only).
    
    Returns:
    
    MegaObject
  - getWorkflowTransitionID
```
java.lang.String getWorkflowTransitionID()
```
    Retrieves the MegaField of current workflow transition (Read only).
    
    Returns:
    
    String
  - getWorkflowTransition
```
com.mega.modeling.api.MegaObject getWorkflowTransition()
```
    Retrieves current workflow transition (Read only).
    
    Returns:
    
    MegaObject
  - getWorkflowSubject
```
com.mega.modeling.api.MegaObject getWorkflowSubject()
```
    Retrieves the MegaObject of subject of current workflow instance (Read only).
    
    Returns:
    
    MegaObject
  - getCurrentWorkflowStatusInstance
```
com.mega.modeling.api.MegaObject getCurrentWorkflowStatusInstance()
                                                           throws com.mega.modeling.api.MegaException
```
    Retrieves the MegaObject of current workflow status instance (Read only).
    
    Returns:
    
    MegaObject
    
    Throws:
    
    com.mega.modeling.api.MegaException
  - getCurrentWorkflowStatusInstanceDescription
```
com.mega.modeling.api.MegaObject getCurrentWorkflowStatusInstanceDescription()
                                                                      throws com.mega.modeling.api.MegaException
```
    Retrieves the MegaObject of current workflow status instance (Read only).
    
    Returns:
    
    MegaObject
    
    Throws:
    
    com.mega.modeling.api.MegaException
  - getNewWorkflowStatusInstance
```
com.mega.modeling.api.MegaObject getNewWorkflowStatusInstance()
```
    Retrieves the MegaObject of new workflow status instance (Read only).
    
    Returns:
    
    MegaObject
  - getNewWorkflowStatusInstanceDescription
```
com.mega.modeling.api.MegaObject getNewWorkflowStatusInstanceDescription()
```
    Retrieves the MegaObject of new workflow status instance (Read only).
    
    Returns:
    
    MegaObject
  - getWorkflowInstance
```
com.mega.modeling.api.MegaObject getWorkflowInstance()
```
    Retrieves the MegaObject of current workflow status instance (Read only).
    The specification of this MegaObject is available in the informal query "~y1H7f3I6FXfH[Workflow Instance Description]"
    
    Returns:
    
    Informal MegaObject
  - getWorkflowInstanceDescription
```
com.mega.modeling.api.MegaObject getWorkflowInstanceDescription()
```
    Retrieves the MegaObject of current workflow status instance (Read only).
    The specification of this MegaObject is available in the informal query "~y1H7f3I6FXfH[Workflow Instance Description]"
    
    Returns:
    
    Informal MegaObject
  - getTransitionInstances
```
com.mega.modeling.api.MegaCollection getTransitionInstances(java.lang.String strTransitionInstancesParam)
                                                     throws com.mega.modeling.api.MegaException
```
    Retrieves the collection of workflow transition instances (Read only) corresponding to the asked transition.
    
    Parameters:
    
    strTransitionInstancesParam - String describing the requested transition instances.
    The string is the concatenation of 3 possible fields:
    "Current", "Previous" or "Next" (to get the current, previous or next transition instances)
    "Transition=strMegaField" (where strMegaField is the MegaField of a Workflow Transition)
    "Iteration=intIteration" (where intIteration is an integer corresponding to the transition "Transition=strMegaField" )
    "Iteration=1" means the most recent "Transition=strMegaField", "Iteration=2" means the previous one etc.
    For example :
    GetTransitionInstances("Current") returns the current transition workflow transition instances
    GetTransitionInstances("Next") returns the next transition workflow transition instances
    GetTransitionInstances("Previous") returns the previous transition workflow transtion instances
    GetTransitionInstances("Previous,Transition=~vtBtb)juFH)T[To be closed]) returns the previous workflow transition instances
    corresponding to the transition "To be closed"
    GetTransitionInstances ("Previous,Transition=~vtBtb)juFH)T[To be closed],Iteration=2") returns the previous workflow transition instances
    corresponding to the second most recent transition "To be closed"
    GetTransitionInstances ("Next,Transition=~vtBtb)juFH)T[To be closed]") returns the next workflow transition instance
    corresponding to the transition "To be closed"
    
    Returns:
    
    Informal MegaCollection
    The properties available on an object from this collection are: getProp("~f0Du8Y(fJXwP[Workflow Transition Identifier]") : returns the idabs of the transition
    getProp("~70Du4a(fJX0Q[Workflow Transition Activator]") : returns the idabs of the transition activator
    getProp("f10000000b20[Comment]") returns the comment for this transition
    getProp("megafield of a taggedvalue") : returns the value of the transition additional information
    The collections available on an object from this collection are: getCollection("~x)mORRsrJ1gV[Users assigned for this transition]")
    returns the collection of users assigned to this transition
    getCollection("megafield of a Workflow Transition Attachment Motive" )
    returns the collection of objects corresponding to this Attachment Motive
    
    Throws:
    
    com.mega.modeling.api.MegaException
  - cancel
```
void cancel()
```
    Allows you to cancel the current transition
  - getWorkflowExecutionUserId
```
java.lang.Double getWorkflowExecutionUserId()
```
    Get the workflow execution user
    
    Returns:
    
    String

Interface IWorkflowContextAction

Method Summary

Method Detail

getRoot

isExecuteAction

isBatchMode

desactivateExecuteAction

setActionRunTime

getErrMessage

setErrMessage

getWorkflowActionID

getWorkflowAction

getWorkflowDefinitionID

getWorkflowDefinition

getWorkflowTransitionID

getWorkflowTransition

getWorkflowSubject

getCurrentWorkflowStatusInstance

getCurrentWorkflowStatusInstanceDescription

getNewWorkflowStatusInstance

getNewWorkflowStatusInstanceDescription

getWorkflowInstance

getWorkflowInstanceDescription

getTransitionInstances

cancel

getWorkflowExecutionUserId