org.obe.spi.model
Interface ActivityInstance

All Superinterfaces:

AttributedEntity

public interface ActivityInstance

extends AttributedEntity

Holds the persistent state of an activity 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:

ActivityInstanceAttributes

Field Summary

static java.lang.String[]	attributes Attributes for ActivityInstance.
static java.beans.PropertyDescriptor[]	propertyDescriptors Property descriptors for ActivityInstance.

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

ACTIVITY_INSTANCE_TYPE, PROCESS_INSTANCE_TYPE, WORKITEM_TYPE

Method Summary

java.lang.String	getActivityDefinitionId()
java.lang.String	getActivityInstanceId()
java.lang.String	getBlockActivityInstanceId() Returns the ID of the encompassing block activity instance.
PersistentIterator	getBlockActivityIterator() Returns an iterator for the block activity owned by the instance.
java.util.Collection	getChildProcessInstances() Returns a collection of sub-process instance(s) associated with a SubFlow-implementation activity.
java.util.Date	getCompletedDate()
java.util.Date	getDueDate()
JoinInstance	getJoin()
java.lang.String	getName()
java.lang.String[]	getParticipants()
int	getPriority()
ProcessInstance	getProcessInstance() Returns the process instance to which this activity belongs.
java.util.Date	getStartedDate()
int	getState()
java.util.Date	getTargetDate()
java.util.Collection	getWorkItems() Returns a collection of work items for this activity.
void	setCompletedDate(java.util.Date completedDate)
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

Field Detail

propertyDescriptors

public static final java.beans.PropertyDescriptor[] propertyDescriptors

Property descriptors for ActivityInstance. N.B. DO NOT WRITE TO THIS ARRAY!!!

attributes

public static final java.lang.String[] attributes

Attributes for ActivityInstance. N.B. DO NOT WRITE TO THIS ARRAY!!!

Method Detail

getActivityDefinitionId

public java.lang.String getActivityDefinitionId()

getActivityInstanceId

public java.lang.String getActivityInstanceId()

getBlockActivityInstanceId

public java.lang.String getBlockActivityInstanceId()

Returns the ID of the encompassing block activity instance. N.B. This returns the activity instance ID, not the ActivitySet ID.

Returns:

The block activity instance ID, or null if this activity is not defined within an activity set.

getBlockActivityIterator

public PersistentIterator getBlockActivityIterator()

Returns an iterator for the block activity owned by the instance. The iterator returned is persistence-capable, and can resume iteration through a supplied array. This feature is required to support the ForEach, Until, and While explicit iteration constructs in an asynchronous mode.

Returns:

A persistent iterator.

See Also:

PersistentIterator

getState

public int getState()

setState

public void setState(int state)

getPriority

public int getPriority()

setPriority

public void setPriority(int priority)

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)

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)

getJoin

public JoinInstance getJoin()

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)

getProcessInstance

public ProcessInstance getProcessInstance()

Returns the process instance to which this activity belongs.

Returns:

The process instance.

getChildProcessInstances

public java.util.Collection getChildProcessInstances()

Returns a collection of sub-process instance(s) associated with a SubFlow-implementation activity. For synchronous sub-flow activities, the collection will contain at most one open process instance; any others will be in the closed state. Asynchronous subflow activities can have any number of open subflow instances. Only subflow activities in loops will have multiple child process instances.

Returns:

An immutable collection of process instances.

getWorkItems

public java.util.Collection getWorkItems()

Returns a collection of work items for this activity.

Returns:

An immutable collection of work items.