org.demac.process.base.dpdl
Interface ActivityRef

All Known Implementing Classes:
ActivityRefImpl

public interface ActivityRef

A unique reference to a Activity, so that an activity can be reused within the process. An ActivityRef contains all the properties, which depend on the Activity´s position in the control flow, such as its state, participant, exception or priority.

Since:
1.0
See Also:
Activity

Field Summary
static java.lang.String ALL
          editable = ALL.
static java.lang.String EDIT
          editable = EDIT.
static java.lang.String ERROR
          state = ERROR.
static java.lang.String EXECUTED
          state = EXECUTED.
static java.lang.String EXECUTING
          state = EXECUTING.
static java.lang.String EXPIRED
          state = EXPIRED.
static java.lang.String FINISHED
          state = FINISHED, The org.demac.process.base.dpdl.ActivityRef was executed and is finished now.
static java.lang.String INACTIVE
          state = INACTIVE.
static java.lang.String LOCKED
          state = LOCKED.
static java.lang.String NO
          editable = NO.
static java.lang.String READY
          state = READY, The org.demac.process.base.dpdl.ActivityRef is set ready, that means it is ready for execution.
static java.lang.String REMOVE
          editable = REMOVE.
static java.lang.String SKIPPED
          state = SKIPPED.
 
Method Summary
 Activity getActivity()
           
 ConnectionResetHandler getConnectionResetHandler()
           
 Deadline getDeadline()
           
 java.lang.String getEditable()
           
 Exception getException()
           
 java.lang.String getId()
           
 Participant getParticipant()
           
 int getPriority()
           
 java.lang.String getState()
           
 Strategy getStrategy()
           
 java.lang.String getUsedUUID()
          Retrieves UUID used by the last invocation of this ActivityRef ServiceOject.
 void setState(java.lang.String state)
           
 void setUsedUUID(java.lang.String uuid)
          Set used UUID
 

Field Detail

NO

static final java.lang.String NO
editable = NO. This means that no modification of the org.demac.process.base.dpdl.ActivityRef is allowed.

See Also:
Constant Field Values

ALL

static final java.lang.String ALL
editable = ALL. This includes the permission to edit and to remove an org.demac.process.base.dpdl.ActivityRef

See Also:
Constant Field Values

REMOVE

static final java.lang.String REMOVE
editable = REMOVE. Only removal of an org.demac.process.base.dpdl.ActivityRef is allowed.

See Also:
Constant Field Values

EDIT

static final java.lang.String EDIT
editable = EDIT. Only editing in form of exchanging the org.demac.process.base.dpdl.ActivityRef against a new activity is allowed. Removing the org.demac.process.base.dpdl.ActivityRef is not permitted.

See Also:
Constant Field Values

INACTIVE

static final java.lang.String INACTIVE
state = INACTIVE. The org.demac.process.base.dpdl.ActivityRef has not been executed yet.

See Also:
Constant Field Values

READY

static final java.lang.String READY
state = READY, The org.demac.process.base.dpdl.ActivityRef is set ready, that means it is ready for execution.

See Also:
Constant Field Values

EXECUTING

static final java.lang.String EXECUTING
state = EXECUTING. The org.demac.process.base.dpdl.ActivityRef is presently executed by another participant.

See Also:
Constant Field Values

EXECUTED

static final java.lang.String EXECUTED
state = EXECUTED. The org.demac.process.base.dpdl.ActivityRef was already executed, but may be executed once again.

See Also:
Constant Field Values

FINISHED

static final java.lang.String FINISHED
state = FINISHED, The org.demac.process.base.dpdl.ActivityRef was executed and is finished now. It must not be executed again.

See Also:
Constant Field Values

EXPIRED

static final java.lang.String EXPIRED
state = EXPIRED. The org.demac.process.base.dpdl.ActivityRef is expired, because its deadline is exceeded.

See Also:
Constant Field Values

SKIPPED

static final java.lang.String SKIPPED
state = SKIPPED. The org.demac.process.base.dpdl.ActivityRef is skipped because its start condition is evaluated to false.

See Also:
Constant Field Values

ERROR

static final java.lang.String ERROR
state = ERROR. The org.demac.process.base.dpdl.ActivityRef has failed because of an error.

See Also:
Constant Field Values

LOCKED

static final java.lang.String LOCKED
state = LOCKED. The org.demac.process.base.dpdl.ActivityRef is Locked till the end or abbort of transaction.

See Also:
Constant Field Values
Method Detail

getConnectionResetHandler

ConnectionResetHandler getConnectionResetHandler()
Returns:
Returns the assigned org.demac.process.base.dpdl.ConnectionResetHandler of the org.demac.process.base.dpdl.ActivityRef. Returns null, if no org.demac.process.base.dpdl.ConnectionResetHandler is specified.

getDeadline

Deadline getDeadline()
Returns:
Returns the deadline of the org.demac.process.base.dpdl.ActivityRef Returns null, if no deadline is specified.

getState

java.lang.String getState()
Returns:
Returns the state of the org.demac.process.base.dpdl.ActivityRef The state defines the state of execution of a single task. Possible states are INACTIVE, READY, EXECUTING, EXECUTED, FINISHED, LOCKED, EXPIRED, SKIPPED and ERROR.

setState

void setState(java.lang.String state)
Parameters:
state - the state to be set. The state defines the state of execution of a single task. Possible states are INACTIVE, READY, EXECUTING, EXECUTED, FINISHED, LOCKED, EXPIRED, SKIPPED and ERROR.

getStrategy

Strategy getStrategy()
Returns:
Returns the org.demac.process.core.dpdl.Strategy of the org.demac.process.base.dpdl.ActivityRef Returns null, if no org.demac.process.core.dpdl.Strategy is specified.

getParticipant

Participant getParticipant()
Returns:
Returns the org.demac.process.core.dpdl.Participant of the org.demac.process.base.dpdl.ActivityRef Returns null, if no org.demac.process.core.dpdl.Participant is specified.

getPriority

int getPriority()
Returns:
Returns the priority of the org.demac.process.base.dpdl.ActivityRef Priority is a non-negative Integer.

getEditable

java.lang.String getEditable()
Returns:
Returns the permission to change the org.demac.process.base.dpdl.ActivityRef Possible permission types are NO, EDIT, REMOVE, ALL. Default permission is NO.

getException

Exception getException()
Returns:
Returns the org.demac.process.base.dpdl.Exception of the org.demac.process.base.dpdl.ActivityRef Returns null, if no org.demac.process.base.dpdl.Exception is specified.

getActivity

Activity getActivity()
Returns:
Returns the org.demac.process.base.dpdl.Activity which is referenced by the org.demac.process.base.dpdl.ActivityRef This a is mandatory attribute of org.demac.process.base.dpdl.ActivityRef

getUsedUUID

java.lang.String getUsedUUID()
Retrieves UUID used by the last invocation of this ActivityRef ServiceOject. UUID is available if CompensableServiceObject was used.

Returns:
used UUID

setUsedUUID

void setUsedUUID(java.lang.String uuid)
Set used UUID

Parameters:
UUID - of the CompensableServiceObject

getId

java.lang.String getId()
Returns:
Returns the ID of the org.demac.process.base.dpdl.ActivityRef