com.mega.modeling.workflowengine.contextengine

Class WorkflowContextEngine

java.lang.Object

com.mega.modeling.workflowengine.contextengine.WorkflowContextEngine

All Implemented Interfaces:

IWorkflowContextEngine

public class WorkflowContextEngine
extends java.lang.Object
implements IWorkflowContextEngine

Description of context to computed users of a participant

Constructor Summary

Constructors

Constructor and Description
WorkflowContextEngine(com.mega.modeling.workflowengine.wrapper.CWrapperWorkflowContext jvobjContext)

Method Summary

Modifier and Type	Method and Description
com.mega.modeling.api.MegaCollection	getActivatorParticipantsFromStatusInstance(com.mega.modeling.api.MegaObject mgobjWorkflowStatusInstance, com.mega.modeling.api.MegaObject mgobjActivator)
com.mega.modeling.api.MegaCollection	getActivatorParticipantsFromTransitionInstance(com.mega.modeling.api.MegaObject mgobjTransitionInstance, com.mega.modeling.api.MegaObject mgobjActivator)
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() Get current workflow status instance description.
com.mega.modeling.api.MegaObject	getCurrentWorkflowStatusInstanceDescription() Get current workflow status instance description.
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) Get workflow transition instances description.
com.mega.modeling.api.MegaObject	getWorkflowDefinition() Get workflow definition identifier.
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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowContextEngine

public WorkflowContextEngine(com.mega.modeling.workflowengine.wrapper.CWrapperWorkflowContext jvobjContext)

Method Detail

getRoot

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

Get root.

Specified by:

getRoot in interface IWorkflowContextEngine

Returns:

root

getWorkflowDefinitionID

public java.lang.String getWorkflowDefinitionID()

Get workflow definition identifier.

Specified by:

getWorkflowDefinitionID in interface IWorkflowContextEngine

Returns:

workflow definition identifier (String)

getWorkflowDefinition

public com.mega.modeling.api.MegaObject getWorkflowDefinition()

Get workflow definition identifier.

Specified by:

getWorkflowDefinition in interface IWorkflowContextEngine

Returns:

workflow definition identifier (MegaObject)

getWorkflowSubjectID

public java.lang.String getWorkflowSubjectID()

Get subject identifier.

Specified by:

getWorkflowSubjectID in interface IWorkflowContextEngine

Returns:

subject identifier (String)

getWorkflowSubject

public com.mega.modeling.api.MegaObject getWorkflowSubject()

Get subject identifier.

Specified by:

getWorkflowSubject in interface IWorkflowContextEngine

Returns:

subject identifier (String)

isBatchMode

public boolean isBatchMode()

Test if it's a mode batch.

Specified by:

isBatchMode in interface IWorkflowContextEngine

Returns:

true = batch mode (boolean)

getWorkflowInstance

public com.mega.modeling.api.MegaObject getWorkflowInstance()

Get workflow instance description.

Specified by:

getWorkflowInstance in interface IWorkflowContextEngine

Returns:

workflow instance (MegaObject)

getWorkflowInstanceDescription

public com.mega.modeling.api.MegaObject getWorkflowInstanceDescription()

Get workflow instance description.

Specified by:

getWorkflowInstanceDescription in interface IWorkflowContextEngine

Returns:

workflow instance (MegaObject)

getCurrentWorkflowStatusInstance

public com.mega.modeling.api.MegaObject getCurrentWorkflowStatusInstance()
                                                                  throws com.mega.modeling.api.MegaException

Get current workflow status instance description.

Specified by:

getCurrentWorkflowStatusInstance in interface IWorkflowContextEngine

Returns:

workflow status instance (MegaObject)

Throws:

com.mega.modeling.api.MegaException

getCurrentWorkflowStatusInstanceDescription

public com.mega.modeling.api.MegaObject getCurrentWorkflowStatusInstanceDescription()
                                                                             throws com.mega.modeling.api.MegaException

Get current workflow status instance description.

Specified by:

getCurrentWorkflowStatusInstanceDescription in interface IWorkflowContextEngine

Returns:

workflow status instance (MegaObject)

Throws:

com.mega.modeling.api.MegaException

getTransitionInstances

public com.mega.modeling.api.MegaCollection getTransitionInstances(java.lang.String strTransitionInstancesParam)
                                                            throws com.mega.modeling.api.MegaException

Get workflow transition instances description.

Specified by:

getTransitionInstances in interface IWorkflowContextEngine

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:

workflow instances (MegaCollection)

Throws:

com.mega.modeling.api.MegaException

getTransitionCount

public int getTransitionCount()

Description copied from interface: IWorkflowContextEngine

Retrieves the number of triggered transitions of a workflow instance

Specified by:

getTransitionCount in interface IWorkflowContextEngine

Returns:

an integer corresponding to this count

getTransition

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

Description copied from interface: IWorkflowContextEngine

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

Specified by:

getTransition in interface IWorkflowContextEngine

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

getActivatorParticipantsFromTransitionInstance

public com.mega.modeling.api.MegaCollection getActivatorParticipantsFromTransitionInstance(com.mega.modeling.api.MegaObject mgobjTransitionInstance,
                                                                                           com.mega.modeling.api.MegaObject mgobjActivator)

getActivatorParticipantsFromStatusInstance

public com.mega.modeling.api.MegaCollection getActivatorParticipantsFromStatusInstance(com.mega.modeling.api.MegaObject mgobjWorkflowStatusInstance,
                                                                                       com.mega.modeling.api.MegaObject mgobjActivator)
                                                                                throws com.mega.modeling.api.MegaException

Throws:

com.mega.modeling.api.MegaException

getAssignedPersonsFromTransitionInstance

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

Description copied from interface: IWorkflowContextEngine

Returns the collection of persons assigned for a workflow transition instance

Specified by:

getAssignedPersonsFromTransitionInstance in interface IWorkflowContextEngine

Parameters:

mgobjWorkflowTransitionInstance - MegaObject corresponding to a workflow transition instance

Returns:

MegaCollection containing users assigned for this transition instance

Throws:

com.mega.modeling.api.MegaException