org.obe.spi.model
Interface ProcessInstance

All Superinterfaces:

AttributedEntity

public interface ProcessInstance

extends AttributedEntity

Holds the persistent state of a workflow process instance. This interface uses only standard Java data types; it does not need to know about WAPI data types - conversions are handled externally to the persistence service. No parameter validation need be performed by implementations.

Author:

Adrian Price

See Also:

ProcessInstanceAttributes

Field Summary

Fields inherited from interface org.obe.spi.model.AttributedEntity

ACTIVITY_INSTANCE_TYPE, PROCESS_INSTANCE_TYPE, WORKITEM_TYPE

Method Summary

java.util.Date	getActivityDueDate()
java.util.Collection	getActivityInstances() Returns a collection of activity instances.
java.util.Date	getActivityTargetDate()
java.util.Date	getCompletedDate()
java.util.Date	getCreatedDate()
java.util.Date	getDueDate()
java.lang.String	getName()
ActivityInstance	getParentActivityInstance() Returns the activity instance that started this process as a subflow.
java.lang.String	getParentActivityInstanceId()
java.lang.String[]	getParticipants()
int	getPriority()
java.util.Date	getStartedDate()
int	getState()
java.util.Date	getTargetDate()
void	setActivityDueDate(java.util.Date dueDate)
void	setActivityTargetDate(java.util.Date targetDate)
void	setCompletedDate(java.util.Date completedDate)
void	setCreatedDate(java.util.Date createdDate)
void	setDueDate(java.util.Date dueDate)
void	setName(java.lang.String name)
void	setParticipants(java.lang.String[] participants)
void	setPriority(int priority)
void	setStartedDate(java.util.Date startedDate)
void	setState(int state)
void	setTargetDate(java.util.Date targetDate)

Methods inherited from interface org.obe.spi.model.AttributedEntity

getAttributeInstance, getAttributeInstances, getEntityId, getProcessDefinitionId, getProcessInstanceId

Method Detail

getState

public int getState()

setState

public void setState(int state)

getPriority

public int getPriority()

setPriority

public void setPriority(int priority)

getCreatedDate

public java.util.Date getCreatedDate()

setCreatedDate

public void setCreatedDate(java.util.Date createdDate)

getActivityTargetDate

public java.util.Date getActivityTargetDate()

setActivityTargetDate

public void setActivityTargetDate(java.util.Date targetDate)

getActivityDueDate

public java.util.Date getActivityDueDate()

setActivityDueDate

public void setActivityDueDate(java.util.Date dueDate)

getTargetDate

public java.util.Date getTargetDate()

setTargetDate

public void setTargetDate(java.util.Date targetDate)

getDueDate

public java.util.Date getDueDate()

setDueDate

public void setDueDate(java.util.Date dueDate)

getStartedDate

public java.util.Date getStartedDate()

setStartedDate

public void setStartedDate(java.util.Date startedDate)

getCompletedDate

public java.util.Date getCompletedDate()

setCompletedDate

public void setCompletedDate(java.util.Date completedDate)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getParticipants

public java.lang.String[] getParticipants()

setParticipants

public void setParticipants(java.lang.String[] participants)

getActivityInstances

public java.util.Collection getActivityInstances()

Returns a collection of activity instances.

Returns:

An immutable collection of activity instances.

getParentActivityInstance

public ActivityInstance getParentActivityInstance()

Returns the activity instance that started this process as a subflow.

Returns:

The parent activity instance, or null if this process instance does not have a parent.

getParentActivityInstanceId

public java.lang.String getParentActivityInstanceId()