com.groiss.wf
Interface ActivityInstance

All Known Subinterfaces:

ProcessInstance

public interface ActivityInstance

The activity instance represents a step of a process instance. This interface contains only getters, use the WfEngine interface to manipulate this object.

Field Summary

static short	ABORTED Instance has been aborted.
static short	ACTIVE Instance is active.
static int	ANDJOIN An andjoin node, end of andpar.
static int	BATCH batch
static int	BEGIN A begin node.
static int	BRANCH A branch node.
static int	CHOICE Start of a choice construct.
static int	CHOICE_BRANCH A branch of a choice.
static short	COMPENSATED Instance has been compensated.
static short	COMPENSATING Step is currently beeing compensated
static int	ELSIF An else-if node.
static int	END An end node.
static int	END_BRANCH A branch end node.
static int	END_COMPENSATION
static int	END_SCOPE end scope
static int	ENDFOR parallel for end
static short	ERROR Step is in error state
static int	EXIT_WHEN An exit-when node.
static short	FINISHED Instance is finished.
static int	GOTO A goto node.
static int	IF An if node.
static int	LOOP A loop node, starts a loop construct.
static short	ORIGIN_DIRECT The user sees the instance because of assignment to himself or one of his roles
static short	ORIGIN_SUBSTITUTION The user sees the instance via substitution
static short	ORIGIN_UNKNOWN The origin of the instance is unknown
static int	ORJOIN An orjoin node, end of orpar.
static int	PAR A par node, start of orpar or andpar.
static int	PARFOR parallel for
static int	PROCESS A (sub)process node.
static int	SCOPE start a new scope
static short	STARTED Instance is in idle state.
static short	SUSPENDED Instance is in suspension list.
static int	SYSTEM_INTERN A system step which is translated in another wdl expression, e.g.
static int	SYSTEM_TASK A system task.
static int	SYSTEM_WAIT A system step which makes no finish
static int	TASK A task node.
static short	WAITING Instance is finished, but post finish actions are pending (for example selection of choice path).
static int	WHILE A while node.
static int	WS_INVOKE
static int	WS_RECEIVE
static int	WS_REPLY

Method Summary

Agent	getAgent() Returns the agent of the object
Application	getApplication() Returns the application the activity belogs to.
java.lang.String	getDescription() Returns the description
java.util.Date	getDuedate() Returns the duedate
java.util.Date	getFinished() Returns the finish date.
java.lang.String	getId() Returns the id of the activity instance.
long	getOid() Returns the unique oid of the object.
OrgUnit	getOrgUnit() Returns the organizational unit.
short	getOrigin() Returns the origin od this ActivityInstance.
ActivityInstance	getParent() Returns the parent node in the process execution graph, normally the process instance, but for example in parfors, the parfor node
ProcessDefinition	getProcessDefinition() Returns the process definition the activity instance belongs to.
ProcessInstance	getProcessInstance() Returns the process instance the activity instance belongs to.
java.util.Date	getStarted() Returns the start date.
short	getStatus() Returns the status of the activity instance.
Agent	getStepAgent() Returns the step-agent of the object.
java.lang.String	getStepName() Get the name of the step the activity belongs to.
java.util.Date	getTaken() Returns the date when a user has taken the activity.
Task	getTask() Returns the task
int	getType() Returns the type of the activity instance.
boolean	isCheckedOut() Returns true is the activity is checked out (on mobile server).
boolean	isInGoBack() Returns true if the activity instance has been created in a go back action.
boolean	isInReactivate() Returns true if the activity instance has been created in a reactivate action.

Field Detail

BEGIN

static final int BEGIN

A begin node.

See Also:

Constant Field Values

END

static final int END

An end node.

See Also:

Constant Field Values

IF

static final int IF

An if node.

See Also:

Constant Field Values

ELSIF

static final int ELSIF

An else-if node.

See Also:

Constant Field Values

LOOP

static final int LOOP

A loop node, starts a loop construct.

See Also:

Constant Field Values

EXIT_WHEN

static final int EXIT_WHEN

An exit-when node.

See Also:

Constant Field Values

WHILE

static final int WHILE

A while node.

See Also:

Constant Field Values

PAR

static final int PAR

A par node, start of orpar or andpar.

See Also:

Constant Field Values

ANDJOIN

static final int ANDJOIN

An andjoin node, end of andpar.

See Also:

Constant Field Values

ORJOIN

static final int ORJOIN

An orjoin node, end of orpar.

See Also:

Constant Field Values

CHOICE

static final int CHOICE

Start of a choice construct.

See Also:

Constant Field Values

CHOICE_BRANCH

static final int CHOICE_BRANCH

A branch of a choice.

See Also:

Constant Field Values

GOTO

static final int GOTO

A goto node.

See Also:

Constant Field Values

TASK

static final int TASK

A task node.

See Also:

Constant Field Values

SYSTEM_TASK

static final int SYSTEM_TASK

A system task.

See Also:

Constant Field Values

PROCESS

static final int PROCESS

A (sub)process node.

See Also:

Constant Field Values

BRANCH

static final int BRANCH

A branch node.

See Also:

Constant Field Values

END_BRANCH

static final int END_BRANCH

A branch end node.

See Also:

Constant Field Values

SYSTEM_INTERN

static final int SYSTEM_INTERN

A system step which is translated in another wdl expression, e.g. raiseEvent

See Also:

Constant Field Values

SYSTEM_WAIT

static final int SYSTEM_WAIT

A system step which makes no finish

See Also:

Constant Field Values

PARFOR

static final int PARFOR

parallel for

See Also:

Constant Field Values

ENDFOR

static final int ENDFOR

parallel for end

See Also:

Constant Field Values

BATCH

static final int BATCH

batch

See Also:

Constant Field Values

SCOPE

static final int SCOPE

start a new scope

See Also:

Constant Field Values

END_SCOPE

static final int END_SCOPE

end scope

See Also:

Constant Field Values

END_COMPENSATION

static final int END_COMPENSATION

See Also:

Constant Field Values

WS_INVOKE

static final int WS_INVOKE

See Also:

Constant Field Values

WS_RECEIVE

static final int WS_RECEIVE

See Also:

Constant Field Values

WS_REPLY

static final int WS_REPLY

See Also:

Constant Field Values

STARTED

static final short STARTED

Instance is in idle state.

See Also:

Constant Field Values

ACTIVE

static final short ACTIVE

Instance is active.

See Also:

Constant Field Values

SUSPENDED

static final short SUSPENDED

Instance is in suspension list.

See Also:

Constant Field Values

FINISHED

static final short FINISHED

Instance is finished.

See Also:

Constant Field Values

ABORTED

static final short ABORTED

Instance has been aborted.

See Also:

Constant Field Values

WAITING

static final short WAITING

Instance is finished, but post finish actions are pending (for example selection of choice path).

See Also:

Constant Field Values

COMPENSATED

static final short COMPENSATED

Instance has been compensated.

See Also:

Constant Field Values

COMPENSATING

static final short COMPENSATING

Step is currently beeing compensated

See Also:

Constant Field Values

ERROR

static final short ERROR

Step is in error state

See Also:

Constant Field Values

ORIGIN_UNKNOWN

static final short ORIGIN_UNKNOWN

The origin of the instance is unknown

See Also:

Constant Field Values

ORIGIN_DIRECT

static final short ORIGIN_DIRECT

The user sees the instance because of assignment to himself or one of his roles

See Also:

Constant Field Values

ORIGIN_SUBSTITUTION

static final short ORIGIN_SUBSTITUTION

The user sees the instance via substitution

See Also:

Constant Field Values

Method Detail

getOid

long getOid()

Returns the unique oid of the object.

Returns:

the oid

getAgent

Agent getAgent()

Returns the agent of the object

Returns:

the agent (User or Role)

getStepAgent

Agent getStepAgent()

Returns the step-agent of the object. This is the agent, as it appears in the process definition, normally a role

Returns:

the step-agent (User or Role)

getStarted

java.util.Date getStarted()

Returns the start date.

Returns:

a date object

getTaken

java.util.Date getTaken()

Returns the date when a user has taken the activity.

Returns:

a date object or null if not yet taken.

getFinished

java.util.Date getFinished()

Returns the finish date.

Returns:

a date object, is null when the activity is not finished.

getDuedate

java.util.Date getDuedate()

Returns the duedate

Returns:

a date, null when no duedate is set.

getDescription

java.lang.String getDescription()

Returns the description

Returns:

a string object, may be null

getStatus

short getStatus()

Returns the status of the activity instance. See the programming guide for the possible values.

Returns:

the status

getOrgUnit

OrgUnit getOrgUnit()

Returns the organizational unit.

Returns:

the OrgUnit

getApplication

Application getApplication()

Returns the application the activity belogs to.

Returns:

the application

getType

int getType()

Returns the type of the activity instance.

Returns:

the type

getTask

Task getTask()

Returns the task

Returns:

the task, may be null if activity instance is not of type task.

getProcessDefinition

ProcessDefinition getProcessDefinition()

Returns the process definition the activity instance belongs to.

Returns:

the process definition

getProcessInstance

ProcessInstance getProcessInstance()

Returns the process instance the activity instance belongs to.

Returns:

the process instance

getStepName

java.lang.String getStepName()

Get the name of the step the activity belongs to.

Returns:

the step name, may be null.

isCheckedOut

boolean isCheckedOut()

Returns true is the activity is checked out (on mobile server).

Returns:

true if object is checked out

getParent

ActivityInstance getParent()

Returns the parent node in the process execution graph, normally the process instance, but for example in parfors, the parfor node

Returns:

an activity instance

getOrigin

short getOrigin()

Returns the origin od this ActivityInstance. Works only when the Instance was retrieved via the WorklistCache.

Returns:

ORIGIN_UNKNOWN, ORIGIN_DIRECT, ORIGIN_SUBSTITUTION

isInGoBack

boolean isInGoBack()

Returns true if the activity instance has been created in a go back action.

isInReactivate

boolean isInReactivate()

Returns true if the activity instance has been created in a reactivate action.

getId

java.lang.String getId()

Returns the id of the activity instance.

Returns:

the id