IWorkflowContextParticipant

```
public interface IWorkflowContextParticipant
```
Interface describing the available methods for a participant of a transition.

The macro associated with an action must implement the function 'GetUsersToSelect' 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
`java.lang.String`	`getActivatorID()` Get activator identifier.
`com.mega.modeling.api.MegaObject`	`getCurrentWorkflowStatusInstance()` Retrieves the MegaObject of current Workflow Status Instance.
`com.mega.modeling.api.MegaObject`	`getCurrentWorkflowStatusInstanceDescription()` Retrieves the MegaObject of current workflow status instance (Read only).
`com.mega.modeling.api.MegaObject`	`getNewWorkflowStatusInstance()` Retrieves the MegaObject of new workflow status instance.
`com.mega.modeling.api.MegaObject`	`getNewWorkflowStatusInstanceDescription()` Retrieves the MegaObject of new workflow status instance (Read only).
`java.lang.String`	`getParticipantWorkflowTransitionID()` Get transition identifier associated to the participant.
`com.mega.modeling.api.MegaRoot`	`getRoot()` Get root.
`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.MegaCollection`	`getUserFromProvidingTransition(java.lang.String strTransitionId)` Get activators of providing transition .
`com.mega.modeling.api.MegaObject`	`getWorkflowDefinition()` Get workflow definition.
`java.lang.String`	`getWorkflowDefinitionID()` Get workflow definition identifier.
`com.mega.modeling.api.MegaObject`	`getWorkflowInstance()` Get workflow instance description.
`com.mega.modeling.api.MegaObject`	`getWorkflowInstanceDescription()` Get workflow instance description.
`java.lang.String`	`getWorkflowParticipantID()` Get participant identifier.
`com.mega.modeling.api.MegaObject`	`getWorkflowSubject()` Get subject identifier.
`java.lang.String`	`getWorkflowSubjectID()` Get subject identifier.
`com.mega.modeling.api.MegaObject`	`getWorkflowTransition()` Retrieves current workflow transition (Read only).
`java.lang.String`	`getWorkflowTransitionID()` Get triggering transition identifier.

- Method Detail
  - getRoot
```
com.mega.modeling.api.MegaRoot getRoot()
```
    Get root.
    
    Returns:
    
    root
  - getWorkflowParticipantID
```
java.lang.String getWorkflowParticipantID()
```
    Get participant identifier.
    
    Returns:
    
    participant identifier
  - getParticipantWorkflowTransitionID
```
java.lang.String getParticipantWorkflowTransitionID()
```
    Get transition identifier associated to the participant.
    
    Returns:
    
    transition identifier
  - getWorkflowDefinitionID
```
java.lang.String getWorkflowDefinitionID()
```
    Get workflow definition identifier.
    
    Returns:
    
    workflow definition identifier
  - getWorkflowDefinition
```
com.mega.modeling.api.MegaObject getWorkflowDefinition()
```
    Get workflow definition.
    
    Returns:
    
    workflow definition identifier
  - getWorkflowSubjectID
```
java.lang.String getWorkflowSubjectID()
```
    Get subject identifier.
    
    Returns:
    
    subject identifier
  - getWorkflowSubject
```
com.mega.modeling.api.MegaObject getWorkflowSubject()
```
    Get subject identifier.
    
    Returns:
    
    subject identifier (String)
  - getActivatorID
```
java.lang.String getActivatorID()
```
    Get activator identifier.
    
    Returns:
    
    activator identifier
  - getWorkflowTransitionID
```
java.lang.String getWorkflowTransitionID()
```
    Get triggering transition identifier.
    
    Returns:
    
    triggering transition identifier
  - getWorkflowTransition
```
com.mega.modeling.api.MegaObject getWorkflowTransition()
```
    Retrieves current workflow transition (Read only).
    
    Returns:
    
    MegaObject
  - getUserFromProvidingTransition
```
com.mega.modeling.api.MegaCollection getUserFromProvidingTransition(java.lang.String strTransitionId)
                                                             throws com.mega.modeling.api.MegaException
```
    Get activators of providing transition .
    
    Parameters:
    
    strTransitionId - String
    
    Returns:
    
    users (MegaCollection)
    
    Throws:
    
    com.mega.modeling.api.MegaException
  - getWorkflowInstance
```
com.mega.modeling.api.MegaObject getWorkflowInstance()
```
    Get workflow instance description.
    
    Returns:
    
    workflow instance (MegaObject)
  - getWorkflowInstanceDescription
```
com.mega.modeling.api.MegaObject getWorkflowInstanceDescription()
```
    Get workflow instance description.
    
    Returns:
    
    workflow instance (MegaObject)
  - getCurrentWorkflowStatusInstance
```
com.mega.modeling.api.MegaObject getCurrentWorkflowStatusInstance()
                                                           throws com.mega.modeling.api.MegaException
```
    Retrieves the MegaObject of current Workflow Status Instance.
    
    Returns:
    
    Workflow Status Instance (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:
    
    Workflow Status Instance Description (MegaObject)
    
    Throws:
    
    com.mega.modeling.api.MegaException
  - getNewWorkflowStatusInstance
```
com.mega.modeling.api.MegaObject getNewWorkflowStatusInstance()
```
    Retrieves the MegaObject of new workflow status instance.
    
    Returns:
    
    Workflow Status Instance (MegaObject)
  - getNewWorkflowStatusInstanceDescription
```
com.mega.modeling.api.MegaObject getNewWorkflowStatusInstanceDescription()
```
    Retrieves the MegaObject of new workflow status instance (Read only).
    
    Returns:
    
    Workflow Status Instance Description (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

Interface IWorkflowContextParticipant

Method Summary

Method Detail

getRoot

getWorkflowParticipantID

getParticipantWorkflowTransitionID

getWorkflowDefinitionID

getWorkflowDefinition

getWorkflowSubjectID

getWorkflowSubject

getActivatorID

getWorkflowTransitionID

getWorkflowTransition

getUserFromProvidingTransition

getWorkflowInstance

getWorkflowInstanceDescription

getCurrentWorkflowStatusInstance

getCurrentWorkflowStatusInstanceDescription

getNewWorkflowStatusInstance

getNewWorkflowStatusInstanceDescription

getTransitionInstances