com.mega.modeling.workflowengine.api

Class WorkflowInstanceCreator

java.lang.Object

com.mega.modeling.workflowengine.api.WorkflowInstanceCreator

public class WorkflowInstanceCreator
extends java.lang.Object

Class to instantiate the workflow.

Version:

1.0

Author:

LCY

See Also:

WorkflowEngine

Method Summary

Modifier and Type	Method and Description
boolean	canBeInstanciated() Test if the current workflow can be instanciated
void	clean() This feature allows you to optimize the treatment by releasing including memory.
WorkflowResult	getResult() Get the result of instanciation
com.mega.modeling.api.MegaObject	getWorkflowInstance() Get the instance of workflow
com.mega.modeling.api.MegaObject	getWorkflowSubject() Get the subject
com.mega.modeling.api.MegaObject	instanciate() Instanciation of a workflow. The function returns an empty mega object if the instantiation failed otherwise it returns the workflow instance
void	setBatchMode(boolean bBatchMode) Set the batch mode for the instanciation

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.

canBeInstanciated

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

Test if the current workflow can be instanciated

Returns:

true if the workflow can be instanciated

Throws:

com.mega.modeling.api.MegaException

instanciate

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

Instanciation of a workflow.
The function returns an empty mega object if the instantiation failed otherwise it returns the workflow instance

Returns:

Workflow Instance Description

Throws:

com.mega.modeling.api.MegaException - MegaException

setBatchMode

public void setBatchMode(boolean bBatchMode)

Set the batch mode for the instanciation

Parameters:

bBatchMode - True for specify the batch mode

getResult

public WorkflowResult getResult()

Get the result of instanciation

Returns:

result of instanciation

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