org.apache.oodt.cas.workflow.structs

Class WorkflowInstance

java.lang.Object

org.apache.oodt.cas.workflow.structs.WorkflowInstance

public class WorkflowInstance
extends Object

A WorkflowInstance is an instantiation of the abstract description of a Workflow provided by the Workflow class. WorkflowInstances have status, and in general are data structures intended to be used as a means for monitoring the status of an executing Workflow. As of Apache OODT 0.4, the internal Workflow implementation uses ParentChildWorkflow, introduced as part of OODT-70, and the PackagedWorkflowRepository. Workflow instances given to the class will automatically convert to ParentChildWorkflow implementations internally, and the existing getWorkflow() and setWorkflow(Workflow) methods have been deprecated in favor of getParentChildWorkflow() and setParentChildWorkflow(ParentChildWorkflow) which will supersede those methods, and eventually turn into their concrete implementations. In addition, as of Apache OODT 0.4 the internal state member variable now uses WorkflowState for representation. This requires the use of WorkflowLifecycle which has now moved from being simply a UI utility class for the Worklow Monitor web application to actually being fully integrated with the Workflow Manager. For backwards compatibility the setStatus(String) and getStatus() methods are still supported, but are deprecated. Developers using this class should move towards using setState(WorkflowState) and getState().

Version:

$Revision$

Author:

mattmann, bfoster

Constructor Summary

Constructors

Constructor and Description
WorkflowInstance() Default Constructor.
WorkflowInstance(Workflow workflow, String id, WorkflowState state, String currentTaskId, Date startDate, Date endDate, Metadata sharedContext, int timesBlocked, Priority priority)

Method Summary

Modifier and Type	Method and Description
Date	getCreationDate() Convenience method to format and return the as a Date.
WorkflowTask	getCurrentTask() Returns the currently executing WorkflowTask part of this instance.
String	getCurrentTaskEndDateTimeIsoStr() Deprecated.
String	getCurrentTaskId()
String	getCurrentTaskStartDateTimeIsoStr() Deprecated.
Date	getEndDate()
String	getEndDateTimeIsoStr() Deprecated.
Date	getFinishDate() Convenience method to format and return the as a Date.
String	getId()
ParentChildWorkflow	getParentChildWorkflow()
Priority	getPriority()
Metadata	getSharedContext()
Date	getStartDate()
String	getStartDateTimeIsoStr() Deprecated.
WorkflowState	getState()
String	getStatus() Deprecated.
int	getTimesBlocked()
Workflow	getWorkflow() Deprecated.
void	setCurrentTaskEndDateTimeIsoStr(String currentTaskEndDateTimeIsoStr) Deprecated.
void	setCurrentTaskId(String currentTaskId)
void	setCurrentTaskStartDateTimeIsoStr(String currentTaskStartDateTimeIsoStr) Deprecated.
void	setEndDate(Date endDate)
void	setEndDateTimeIsoStr(String endDateTimeIsoStr) Deprecated.
void	setId(String id)
void	setParentChildWorkflow(ParentChildWorkflow workflow) Sets the Parent Child workflow.
void	setPriority(Priority priority)
void	setSharedContext(Metadata sharedContext)
void	setStartDate(Date startDate)
void	setStartDateTimeIsoStr(String startDateTimeIsoStr) Deprecated.
void	setState(WorkflowState state)
void	setStatus(String status) Deprecated.
void	setTimesBlocked(int timesBlocked)
void	setWorkflow(Workflow workflow) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowInstance

public WorkflowInstance()

Default Constructor.

WorkflowInstance

public WorkflowInstance(Workflow workflow,
                        String id,
                        WorkflowState state,
                        String currentTaskId,
                        Date startDate,
                        Date endDate,
                        Metadata sharedContext,
                        int timesBlocked,
                        Priority priority)

Method Detail

getId

public String getId()

Returns:

the id

setId

public void setId(String id)

Parameters:

id - the id to set

getStatus

@Deprecated
public String getStatus()

Deprecated.

Returns:

the status

setStatus

@Deprecated
public void setStatus(String status)

Deprecated.

Sets the current WorkflowState to the provided status.

Parameters:

status - The provided status to set.

getState

public WorkflowState getState()

Returns:

the state

setState

public void setState(WorkflowState state)

Parameters:

state - the state to set

getWorkflow

@Deprecated
public Workflow getWorkflow()

Deprecated.

Returns:

the workflow

setWorkflow

@Deprecated
public void setWorkflow(Workflow workflow)

Deprecated.

Parameters:

workflow - the workflow to set

getParentChildWorkflow

public ParentChildWorkflow getParentChildWorkflow()

Returns:

The workflow, with its parent/child relationships.

setParentChildWorkflow

public void setParentChildWorkflow(ParentChildWorkflow workflow)

Sets the Parent Child workflow.

Parameters:

workflow - The workflow to set.

getCurrentTaskId

public String getCurrentTaskId()

Returns:

the currentTaskId

setCurrentTaskId

public void setCurrentTaskId(String currentTaskId)

Parameters:

currentTaskId - the currentTaskId to set

getSharedContext

public Metadata getSharedContext()

Returns:

the sharedContext

setSharedContext

public void setSharedContext(Metadata sharedContext)

Parameters:

sharedContext - the sharedContext to set

getPriority

public Priority getPriority()

Returns:

the priority

setPriority

public void setPriority(Priority priority)

Parameters:

priority - the priority to set

getCreationDate

public Date getCreationDate()

Convenience method to format and return the as a Date.

Returns:

Date representation of getCurrentTaskStartDateTimeIsoStr().

getFinishDate

public Date getFinishDate()

Convenience method to format and return the as a Date.

Returns:

Date representation of getCurrentTaskEndDateTimeIsoStr().

getStartDate

public Date getStartDate()

Returns:

the startDate

setStartDate

public void setStartDate(Date startDate)

Parameters:

startDate - the startDate to set

getEndDate

public Date getEndDate()

Returns:

the endDate

setEndDate

public void setEndDate(Date endDate)

Parameters:

endDate - the endDate to set

getEndDateTimeIsoStr

@Deprecated
public String getEndDateTimeIsoStr()

Deprecated.

Returns:

the endDateTimeIsoStr

setEndDateTimeIsoStr

@Deprecated
public void setEndDateTimeIsoStr(String endDateTimeIsoStr)

Deprecated.

Parameters:

endDateTimeIsoStr - the endDateTimeIsoStr to set

getStartDateTimeIsoStr

@Deprecated
public String getStartDateTimeIsoStr()

Deprecated.

Returns:

the startDateTimeIsoStr

setStartDateTimeIsoStr

@Deprecated
public void setStartDateTimeIsoStr(String startDateTimeIsoStr)

Deprecated.

Parameters:

startDateTimeIsoStr - the startDateTimeIsoStr to set

getCurrentTaskEndDateTimeIsoStr

@Deprecated
public String getCurrentTaskEndDateTimeIsoStr()

Deprecated.

Returns:

the currentTaskEndDateTimeIsoStr

setCurrentTaskEndDateTimeIsoStr

@Deprecated
public void setCurrentTaskEndDateTimeIsoStr(String currentTaskEndDateTimeIsoStr)

Deprecated.

Parameters:

currentTaskEndDateTimeIsoStr - the currentTaskEndDateTimeIsoStr to set

getCurrentTaskStartDateTimeIsoStr

@Deprecated
public String getCurrentTaskStartDateTimeIsoStr()

Deprecated.

Returns:

the currentTaskStartDateTimeIsoStr

setCurrentTaskStartDateTimeIsoStr

@Deprecated
public void setCurrentTaskStartDateTimeIsoStr(String currentTaskStartDateTimeIsoStr)

Deprecated.

Parameters:

currentTaskStartDateTimeIsoStr - the currentTaskStartDateTimeIsoStr to set

getCurrentTask

public WorkflowTask getCurrentTask()

Returns the currently executing WorkflowTask part of this instance.

Returns:

The currently executing WorkflowTask part of this instance.

getTimesBlocked

public int getTimesBlocked()

Returns:

the timesBlocked

setTimesBlocked

public void setTimesBlocked(int timesBlocked)

Parameters:

timesBlocked - the timesBlocked to set