com.mega.modeling.workflowengine.api

Class WorkflowTransitionTrigger

java.lang.Object

com.mega.modeling.workflowengine.api.WorkflowTransitionTrigger

public class WorkflowTransitionTrigger
extends java.lang.Object

Class to trigger a transition for a workflow instance.

Version:

1.0

Author:

LCY

See Also:

WorkflowEngine

Method Summary

Modifier and Type	Method and Description
void	clean() This feature allows you to optimize the treatment by releasing including memory.
void	completeMultipleTransition() Complete a multiple transition return boolean True if the completion is a succes
WorkflowResult	getResult() Get the result of triggering
com.mega.modeling.api.MegaObject	getWorkflowInstance() Get the instance of workflow
com.mega.modeling.api.MegaObject	getWorkflowSubject() Get the subject
void	setBatchMode(boolean bBatchMode) Set the batch mode for the instanciation
void	setNextUserForTransition(com.mega.modeling.api.MegaObject ojobjWorkflowTransitionDescription, com.mega.modeling.api.MegaObject ojobjNextWorkflowTransitionDescription, com.mega.modeling.api.MegaCollection mgcolUser) Set the next users to trigger a next transition.
void	setPermissionPropertyForTransition(com.mega.modeling.api.MegaObject ojobjWorkflowTransitionDescription, java.lang.String strPropertyId, java.lang.String strPermission) Specify the permissions for the properties of transition to trigger. By default properties are updatable and not displayed.
void	setPropertyForTransition(com.mega.modeling.api.MegaObject ojobjWorkflowTransitionDescription, java.lang.String strPropertyId, java.lang.Object value) Assign values for the properties of transition to trigger.
boolean	stopTransition() Stop a workflow instance. The function returns an empty mega object if the s failed otherwise it returns the new workflow instance
com.mega.modeling.api.MegaObject	triggerTransition(com.mega.modeling.api.MegaObject mgobjWorkflowTransition) Trigger a transition of a workflow instance. The function returns an empty mega object if the triggering failed otherwise it returns the new workflow instance

Methods inherited from class java.lang.Object

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

Method Detail

clean

public void clean()

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

triggerTransition

public com.mega.modeling.api.MegaObject triggerTransition(com.mega.modeling.api.MegaObject mgobjWorkflowTransition)

Trigger a transition of a workflow instance.
The function returns an empty mega object if the triggering failed otherwise it returns the new workflow instance

Parameters:

mgobjWorkflowTransition - workflow transition to trigger

Returns:

Workflow Instance Description

setNextUserForTransition

public void setNextUserForTransition(com.mega.modeling.api.MegaObject ojobjWorkflowTransitionDescription,
                                     com.mega.modeling.api.MegaObject ojobjNextWorkflowTransitionDescription,
                                     com.mega.modeling.api.MegaCollection mgcolUser)
                              throws com.mega.modeling.api.MegaException

Set the next users to trigger a next transition.

Parameters:

ojobjWorkflowTransitionDescription - workflow transition to trigger

ojobjNextWorkflowTransitionDescription - next workflow transition to trigger

mgcolUser - next users

Throws:

com.mega.modeling.api.MegaException

setPropertyForTransition

public void setPropertyForTransition(com.mega.modeling.api.MegaObject ojobjWorkflowTransitionDescription,
                                     java.lang.String strPropertyId,
                                     java.lang.Object value)
                              throws com.mega.modeling.api.MegaException

Assign values for the properties of transition to trigger.

Parameters:

ojobjWorkflowTransitionDescription - workflow transition to trigger

strPropertyId - property to assign (id)

value - value of a property

Throws:

com.mega.modeling.api.MegaException

setPermissionPropertyForTransition

public void setPermissionPropertyForTransition(com.mega.modeling.api.MegaObject ojobjWorkflowTransitionDescription,
                                               java.lang.String strPropertyId,
                                               java.lang.String strPermission)
                                        throws com.mega.modeling.api.MegaException

Specify the permissions for the properties of transition to trigger.
By default properties are updatable and not displayed.

Parameters:

ojobjWorkflowTransitionDescription - workflow transition to trigger

strPropertyId - property to assign (id)

strPermission - permission of a property (R=read only,U=updatable,M=Mandatory,empty=no display)

Throws:

com.mega.modeling.api.MegaException

setBatchMode

public void setBatchMode(boolean bBatchMode)

Set the batch mode for the instanciation

Parameters:

bBatchMode - True for specify the batch mode

completeMultipleTransition

public void completeMultipleTransition()
                                throws com.mega.modeling.api.MegaException

Complete a multiple transition return boolean True if the completion is a succes

Throws:

com.mega.modeling.api.MegaException

getResult

public WorkflowResult getResult()

Get the result of triggering

Returns:

result of triggering

getWorkflowSubject

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

Get the subject

Returns:

MegaObject

getWorkflowInstance

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

Get the instance of workflow

Returns:

MegaObject

stopTransition

public boolean stopTransition()
                       throws com.mega.modeling.api.MegaException

Stop a workflow instance.
The function returns an empty mega object if the s failed otherwise it returns the new workflow instance

Returns:

Workflow Instance Description

Throws:

com.mega.modeling.api.MegaException