com.mega.modeling.workflowengine.context

Interface IWorkflowContextEngine

All Known Implementing Classes:

CWrapperWorkflowContextEngine, WorkflowContextEngine

public interface IWorkflowContextEngine

Interface describing the available methods for a workflow context returned by the Workflow Engine.

The methods apply to this object 'context'.

Version:

1.0

Author:

SCL

Method Summary

Modifier and Type	Method and Description
com.mega.modeling.api.MegaCollection	getAssignedPersonsFromTransitionInstance(com.mega.modeling.api.MegaObject mgobjWorkflowTransitionInstance) Returns the collection of persons assigned for a workflow transition instance
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.MegaRoot	getRoot() Get root.
com.mega.modeling.api.MegaCollection	getTransition(java.lang.String strCount) Returns the workflow transition instances (read-only informal MegaCollection) corresponding to the "strCount" triggered transition where strCount is first, second, third etc.
int	getTransitionCount() Retrieves the number of triggered transitions of a workflow instance
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	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.
com.mega.modeling.api.MegaObject	getWorkflowSubject() Get subject identifier.
java.lang.String	getWorkflowSubjectID() Get subject identifier.
boolean	isBatchMode() Test if it's a mode batch.

Method Detail

getRoot

com.mega.modeling.api.MegaRoot getRoot()

Get root.

Returns:

root

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)

isBatchMode

boolean isBatchMode()

Test if it's a mode batch.

Returns:

true = batch mode (boolean)

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

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

getTransitionCount

int getTransitionCount()

Retrieves the number of triggered transitions of a workflow instance

Returns:

an integer corresponding to this count

getTransition

com.mega.modeling.api.MegaCollection getTransition(java.lang.String strCount)
                                            throws com.mega.modeling.api.MegaException

Returns the workflow transition instances (read-only informal MegaCollection) corresponding to the "strCount"
triggered transition where strCount is first, second, third etc.
For example : getTransition("Count=4") returns the workflow transition instances of
the 4th triggered transition

Parameters:

strCount - a String "Count=X" where X in an integer

Returns:

Informal MegaCollection containing all workflow transition instances

Throws:

com.mega.modeling.api.MegaException

getAssignedPersonsFromTransitionInstance

com.mega.modeling.api.MegaCollection getAssignedPersonsFromTransitionInstance(com.mega.modeling.api.MegaObject mgobjWorkflowTransitionInstance)
                                                                       throws com.mega.modeling.api.MegaException

Returns the collection of persons assigned for a workflow transition instance

Parameters:

mgobjWorkflowTransitionInstance - MegaObject corresponding to a workflow transition instance

Returns:

MegaCollection containing users assigned for this transition instance

Throws:

com.mega.modeling.api.MegaException