|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowEngine
The engine that executes and monitors WorkflowInstance
s, which are
the physical executing representation of the abtract Workflow
s
provided.
Field Summary | |
---|---|
static String |
X_POINT_ID
|
Method Summary | |
---|---|
double |
getCurrentTaskWallClockMinutes(String workflowInstId)
Gets the amount of wall clock minutes that the particular WorkflowTask within a WorkflowInstance has been executing
for. |
WorkflowInstanceRepository |
getInstanceRepository()
Gets the WorkflowInstanceRepository used by this
WorkflowEngine . |
double |
getWallClockMinutes(String workflowInstId)
Gets the amount of wall clock minutes that a particular WorkflowInstance (identified by its workflowInst )
has been executing. |
org.apache.oodt.cas.metadata.Metadata |
getWorkflowInstanceMetadata(String workflowInstId)
Gets the Metadata associated with the WorkflowInstance
identified by the given identifier. |
void |
pauseWorkflowInstance(String workflowInstId)
Pauses the WorkflowInstance specified by its
workflowInstId . |
void |
resumeWorkflowInstance(String workflowInstId)
Resumes Execution of the specified WorkflowInstance identified by
its workflowInstId . |
void |
setWorkflowManagerUrl(URL url)
Sets a pointer to the Workflow Manager that this WorkflowEngine
belongs to. |
WorkflowInstance |
startWorkflow(Workflow workflow,
org.apache.oodt.cas.metadata.Metadata metadata)
Starts the specified Workflow by creating a
WorkflowInstance , and then running that instance. |
void |
stopWorkflow(String workflowInstId)
Stops the WorkflowInstance identified by the given
workflowInstId . |
boolean |
updateMetadata(String workflowInstId,
org.apache.oodt.cas.metadata.Metadata met)
Updates the Metadata context for the WorkflowInstance
identified by the given workflowInstId |
Field Detail |
---|
static final String X_POINT_ID
Method Detail |
---|
WorkflowInstance startWorkflow(Workflow workflow, org.apache.oodt.cas.metadata.Metadata metadata) throws EngineException
Starts the specified Workflow
by creating a
WorkflowInstance
, and then running that instance. The started
WorkflowInstance
which is returned, will have its status updated
by the workflow engine, including its status field, and its
currentTaskId.
workflow
- The abstract representation of the Workflow
to start.metadata
- Any metadata that needs to be shared between the tasks in the
WorkflowInstance
.
WorkflowInstance
which can be used to monitor the
execution of the Workflow
through the Engine.
EngineException
- If any error occurs.void stopWorkflow(String workflowInstId)
WorkflowInstance
identified by the given
workflowInstId
.
workflowInstId
- The identifier of the WorkflowInstance
to stop.void pauseWorkflowInstance(String workflowInstId)
Pauses the WorkflowInstance
specified by its
workflowInstId
.
workflowInstId
- The ID of the Workflow Instance to pause.void resumeWorkflowInstance(String workflowInstId)
Resumes Execution of the specified WorkflowInstance
identified by
its workflowInstId
.
workflowInstId
- The ID of the WorkflowInstance
to resume.WorkflowInstanceRepository getInstanceRepository()
WorkflowInstanceRepository
used by this
WorkflowEngine
.
WorkflowInstanceRepository
used by this
WorkflowEngine
.boolean updateMetadata(String workflowInstId, org.apache.oodt.cas.metadata.Metadata met)
Metadata
context for the WorkflowInstance
identified by the given workflowInstId
workflowInstId
- Identifies the WorkflowInstance
whose Metadata
context will be updated.met
- The new Metadata
context.
void setWorkflowManagerUrl(URL url)
WorkflowEngine
belongs to.
url
- The URL
pointer to the Workflow Manager that this
WorkflowEngine
belongs to.double getWallClockMinutes(String workflowInstId)
WorkflowInstance
(identified by its workflowInst
)
has been executing. This includes time spent QUEUED
, time
spent WAITING
, throughout its entire lifecycle.
workflowInstId
- The identifier of the WorkflowInstance
to measure wall
clock time for.
WorkflowInstance
has been executing for.double getCurrentTaskWallClockMinutes(String workflowInstId)
WorkflowTask
within a WorkflowInstance
has been executing
for.
workflowInstId
- The identifier of the WorkflowInstance
to measure wall
clock time for its current WorkflowTask
.
WorkflowInstance
's current WorkflowTask
has been
executing for.org.apache.oodt.cas.metadata.Metadata getWorkflowInstanceMetadata(String workflowInstId)
Metadata
associated with the WorkflowInstance
identified by the given identifier.
workflowInstId
- The identifier of the WorkflowInstance
to obtain the
Metadata
for.
Metadata
shared context of the
WorkflowInstance
with the given identifier.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |