com.mega.modeling.workflowengine.api

Class WorkflowEngine

java.lang.Object

com.mega.modeling.workflowengine.object.WorkflowContext

com.mega.modeling.workflowengine.api.WorkflowEngine

public class WorkflowEngine
extends com.mega.modeling.workflowengine.object.WorkflowContext

Class of the api of the workflow engine.

Version:

3.0

Author:

LCY

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CURRENT Current version to use at creation of status instance

Fields inherited from class com.mega.modeling.workflowengine.object.WorkflowContext

CONTEXT_ORIGIN_SUBJECT_COMMAND, CONTEXT_ORIGIN_SUBJECT_CREATION, ContextNameForMegaObject, ContextNameForMegaObjectDescription, DEBUG_MESSAGE_ACTION_END, DEBUG_MESSAGE_ACTION_START, DEBUG_MESSAGE_CONDITION_END, DEBUG_MESSAGE_CONDITION_RESULT, DEBUG_MESSAGE_CONDITION_START, DEBUG_MESSAGE_INSTANCIATION_END, DEBUG_MESSAGE_INSTANCIATION_START, DEBUG_MESSAGE_LINK_USER_END, DEBUG_MESSAGE_LINK_USER_START, DEBUG_MESSAGE_PARTICIPANT_END, DEBUG_MESSAGE_PARTICIPANT_START, DEBUG_MESSAGE_PROPERTY_MANDATORY_END, DEBUG_MESSAGE_PROPERTY_MANDATORY_START, DEBUG_MESSAGE_TRIGGER_END, DEBUG_MESSAGE_TRIGGER_START, FILTER_MODE_NONE, FILTER_MODE_STANDARD, m_strOriginContext

Constructor Summary

Constructors

Constructor and Description
WorkflowEngine(com.mega.modeling.api.MegaRoot omgRoot) Constructor from a root object
WorkflowEngine(com.mega.modeling.api.MegaRoot mgobjRoot, com.mega.modeling.workflowengine.wrapper.CWrapperWorkflowParameter jvobjParameter)

Method Summary

Modifier and Type	Method and Description
void	clean() This feature allows you to optimize the treatment by releasing including memory.
CWrapperWorkflowContextEngine	getContext(java.lang.Object jvobjParameter) Returns a Workflow Context which allows calling APIs
com.mega.modeling.api.MegaCollection	getInstanciableWorkflowDefinition(java.lang.Object jvobjParameter) Get a collection of workflow instantiable from a set of search criteria
java.lang.Object	getPropertyForWorkflowInstance(com.mega.modeling.api.MegaObject mgobjWorkflowInstance, java.lang.String strProperty) Get property for a workflow instance CURRENT_STATUS : current workflow status , CURRENT_STATUS_INSTANCE : current workflow status instance SUBJECT : workflow subject
java.lang.Object	getPropertyForWorkflowTransitionInstance(com.mega.modeling.api.MegaObject mgobjWorkflowTransitionInstance, java.lang.String strProperty) Get property for a workflow transition instance ASSIGNED_PERSONS : persons assigned for this transition instance ,
com.mega.modeling.api.MegaCollection	getWorkflowInstances(java.lang.Object jvobjParameter) Get a collection of workflow instance that can be updated from a set of search criteria
boolean	isUserActive(com.mega.modeling.api.MegaObject mgobjUser) is a Workflow User active ?
CWorkflowParameter	NewParameter() Initialization of a new set of search criteria
void	recomputeParticipants(com.mega.modeling.api.MegaObject object)
WorkflowInstanceCreator	WorkflowInstanceCreator(com.mega.modeling.api.MegaObject mgobjWorkflowDefinitionDescription) Get an object to instantiate a workflow
WorkflowTransitionTrigger	WorkflowTransitionTrigger(com.mega.modeling.api.MegaObject mgobjWorkflowInstanceDescription) Get an object to trigger a transition of a workflow instance

Methods inherited from class com.mega.modeling.workflowengine.object.WorkflowContext

addDebugMessage, addDebugStringMessage, addMessage, addStatusInstance, cancel, deleteWorkflowStatusInstance, getContextFromBag, getCurrentWorkflowStatusInstance, getFailedWorkflowTransitionString, getFilterMode, getInitialTransitions, getKeyForHashMap, getNewWorkflowStatusInstance, getNextTransitionCollection, getNextUserForTransition, getOriginContext, getPermissionPropertyForTransition, getPropertyForTransition, getReport, getRoot, getTransition, getTransitionCount, getTransitionToTrigger, getUser, getUserForTransition, getUserParticipantForNextTransition, getUserParticipantForTransition, getWorkflowDefinition, getWorkflowExecutionUserId, getWorkflowInstance, getWorkflowReport, getWorkflowSubject, getWorkflowSubjectPropertyMandatory, getWorkflowTransitionInstances, isBatchMode, isCancel, isDebugMode, isForceToReload, isInstanceCreatorContext, isProgressBarDisplay, isQuickMode, nameWorkflowStatusInstance, setBatchMode, setContextInBag, setCurrentStatus, setCurrentWorkflowStatusInstance, setCurrentWorkflowStatusInstanceFromMegaObject, setFilterMode, setForceToReload, setNewWorkflowInstance, setNewWorkflowStatusInstance, setNextUserForTransition, setOriginContext, setPermissionPropertyForTransition, setProgressBarDisplay, setPropertyForTransition, setPropertyToWorkflowStatusInstance, setTransitionToTrigger, setTransitionToTriggerFromMegaObject, setUser, setUserForTransition, setWorkflowDefinition, setWorkflowInstance, setWorkflowSubject, setWorkflowTransitionInstances, setWorkflowTransitionInstancesWithUsers

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT

public static final java.lang.String CURRENT

Current version to use at creation of status instance

See Also:

Constant Field Values

Constructor Detail

WorkflowEngine

public WorkflowEngine(com.mega.modeling.api.MegaRoot omgRoot)

Constructor from a root object

Parameters:

omgRoot - MegaRoot

WorkflowEngine

public WorkflowEngine(com.mega.modeling.api.MegaRoot mgobjRoot,
                      com.mega.modeling.workflowengine.wrapper.CWrapperWorkflowParameter jvobjParameter)

Method Detail

clean

public void clean()

This feature allows you to optimize the treatment by releasing including memory.

Overrides:

clean in class com.mega.modeling.workflowengine.object.WorkflowContext

NewParameter

public CWorkflowParameter NewParameter()

Initialization of a new set of search criteria

Returns:

Set of search criteria

WorkflowInstanceCreator

public WorkflowInstanceCreator WorkflowInstanceCreator(com.mega.modeling.api.MegaObject mgobjWorkflowDefinitionDescription)

Get an object to instantiate a workflow

Parameters:

mgobjWorkflowDefinitionDescription - Description of workflow

Returns:

Instance creator object

See Also:

WorkflowInstanceCreator

WorkflowTransitionTrigger

public WorkflowTransitionTrigger WorkflowTransitionTrigger(com.mega.modeling.api.MegaObject mgobjWorkflowInstanceDescription)

Get an object to trigger a transition of a workflow instance

Parameters:

mgobjWorkflowInstanceDescription - Description of workflow instance

Returns:

Transition trigger object

See Also:

WorkflowTransitionTrigger

getInstanciableWorkflowDefinition

public com.mega.modeling.api.MegaCollection getInstanciableWorkflowDefinition(java.lang.Object jvobjParameter)
                                                                       throws com.mega.modeling.api.MegaException

Get a collection of workflow instantiable from a set of search criteria

Parameters:

jvobjParameter - Set of search criteria

Returns:

Collection of workflow description

Throws:

com.mega.modeling.api.MegaException

getWorkflowInstances

public com.mega.modeling.api.MegaCollection getWorkflowInstances(java.lang.Object jvobjParameter)

Get a collection of workflow instance that can be updated from a set of search criteria

Parameters:

jvobjParameter - Set of search criteria

Returns:

Collection of workflow instance description

getContext

public CWrapperWorkflowContextEngine getContext(java.lang.Object jvobjParameter)
                                         throws com.mega.modeling.api.MegaException

Returns a Workflow Context which allows calling APIs

Parameters:

jvobjParameter - Set of search criteria : the "~uh0I(bdFFrSL[Workflow Instance Identifier]" criteria is mandatory

Returns:

a Workflow Context

Throws:

com.mega.modeling.api.MegaException

getPropertyForWorkflowInstance

public java.lang.Object getPropertyForWorkflowInstance(com.mega.modeling.api.MegaObject mgobjWorkflowInstance,
                                                       java.lang.String strProperty)
                                                throws com.mega.modeling.api.MegaException

Get property for a workflow instance

• CURRENT_STATUS : current workflow status
,
• CURRENT_STATUS_INSTANCE : current workflow status instance
• SUBJECT : workflow subject

Parameters:

mgobjWorkflowInstance - MegaObject

strProperty - String

Returns:

property value

Throws:

com.mega.modeling.api.MegaException - if the object is not a workflow instance

getPropertyForWorkflowTransitionInstance

public java.lang.Object getPropertyForWorkflowTransitionInstance(com.mega.modeling.api.MegaObject mgobjWorkflowTransitionInstance,
                                                                 java.lang.String strProperty)
                                                          throws com.mega.modeling.api.MegaException

Get property for a workflow transition instance

• ASSIGNED_PERSONS : persons assigned for this transition instance
,

Parameters:

mgobjWorkflowTransitionInstance - MegaObject

strProperty - String

Returns:

property value

Throws:

com.mega.modeling.api.MegaException - if the object is not a workflow transition instance

isUserActive

public boolean isUserActive(com.mega.modeling.api.MegaObject mgobjUser)
                     throws com.mega.modeling.api.MegaException

is a Workflow User active ?

Parameters:

mgobjUser - : Person (System) whose status is to be tested MegaObject

Returns:

true if user active, false if inactive Boolean

Throws:

com.mega.modeling.api.MegaException - if the object is not a Person (System)

recomputeParticipants

public void recomputeParticipants(com.mega.modeling.api.MegaObject object)
                           throws com.mega.modeling.api.MegaException

Throws:

com.mega.modeling.api.MegaException