com.mega.modeling.workflowengine.contextengine

Class CWrapperWorkflowContextEngine

java.lang.Object

com.mega.modeling.workflowengine.contextengine.CWrapperWorkflowContextEngine

All Implemented Interfaces:

IWorkflowContextEngine

public class CWrapperWorkflowContextEngine
extends java.lang.Object
implements IWorkflowContextEngine

Constructor Summary

Constructors

Constructor and Description
CWrapperWorkflowContextEngine(com.mega.modeling.api.MegaCOMObject mgComBaseObject)
CWrapperWorkflowContextEngine(WorkflowContextEngine jvobjWorkflowContextEngine)

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() Retrieves the MegaObject of current workflow status instance (Read only). The specification of this MegaObject is available in the informal query "~9rw21p03Fb3C[Workflow Status Instance Description]"
com.mega.modeling.api.MegaObject	getCurrentWorkflowStatusInstanceDescription() Retrieves the MegaObject of current workflow status instance (Read only). The specification of this MegaObject is available in the informal query "~9rw21p03Fb3C[Workflow Status Instance Description]"
com.mega.modeling.api.MegaRoot	getRoot() Retrieves the MEGA root object (Read only).
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() Retrieves the MegaField of current workflow definition (Read only).
java.lang.String	getWorkflowDefinitionID() Retrieves the MegaField of current workflow definition (Read only).
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).
java.lang.String	getWorkflowSubjectID() Retrieves the MegaObject of subject of current workflow instance (Read only).
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

CWrapperWorkflowContextEngine

public CWrapperWorkflowContextEngine(com.mega.modeling.api.MegaCOMObject mgComBaseObject)

CWrapperWorkflowContextEngine

public CWrapperWorkflowContextEngine(WorkflowContextEngine jvobjWorkflowContextEngine)

Method Detail

getRoot

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

Retrieves the MEGA root object (Read only).

Specified by:

getRoot in interface IWorkflowContextEngine

Returns:

MegaRoot

getWorkflowDefinitionID

public java.lang.String getWorkflowDefinitionID()

Retrieves the MegaField of current workflow definition (Read only).

Specified by:

getWorkflowDefinitionID in interface IWorkflowContextEngine

Returns:

String

getWorkflowDefinition

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

Retrieves the MegaField of current workflow definition (Read only).

Specified by:

getWorkflowDefinition in interface IWorkflowContextEngine

Returns:

MegaObject

getWorkflowSubject

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

Retrieves the MegaObject of subject of current workflow instance (Read only).

Specified by:

getWorkflowSubject in interface IWorkflowContextEngine

Returns:

MegaObject

getWorkflowSubjectID

public java.lang.String getWorkflowSubjectID()

Retrieves the MegaObject of subject of current workflow instance (Read only).

Specified by:

getWorkflowSubjectID in interface IWorkflowContextEngine

Returns:

MegaObject

isBatchMode

public boolean isBatchMode()

Test if it's a mode batch.

Specified by:

isBatchMode in interface IWorkflowContextEngine

Returns:

true = batch mode (boolean)

getCurrentWorkflowStatusInstance

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

Retrieves the MegaObject of current workflow status instance (Read only).
The specification of this MegaObject is available in the informal query "~9rw21p03Fb3C[Workflow Status Instance Description]"

Specified by:

getCurrentWorkflowStatusInstance in interface IWorkflowContextEngine

Returns:

Informal MegaObject

Throws:

com.mega.modeling.api.MegaException

getCurrentWorkflowStatusInstanceDescription

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

Retrieves the MegaObject of current workflow status instance (Read only).
The specification of this MegaObject is available in the informal query "~9rw21p03Fb3C[Workflow Status Instance Description]"

Specified by:

getCurrentWorkflowStatusInstanceDescription in interface IWorkflowContextEngine

Returns:

Informal MegaObject

Throws:

com.mega.modeling.api.MegaException

getWorkflowInstance

public 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]"

Specified by:

getWorkflowInstance in interface IWorkflowContextEngine

Returns:

Informal MegaObject

getWorkflowInstanceDescription

public 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]"

Specified by:

getWorkflowInstanceDescription in interface IWorkflowContextEngine

Returns:

Informal MegaObject

getTransitionInstances

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

Description copied from interface: IWorkflowContextEngine

Retrieves the collection of workflow transition instances (Read only) corresponding to the asked transition.

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:

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

getActivatorParticipantsFromTransitionInstance

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

Throws:

com.mega.modeling.api.MegaException

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

getTransitionCount

public int getTransitionCount()

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

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

getAssignedPersonsFromTransitionInstance

public 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

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