Package org.silverpeas.core.workflow.api.instance

Interface HistoryStep

All Superinterfaces:

Comparable<HistoryStep>

All Known Subinterfaces:

UpdatableHistoryStep

All Known Implementing Classes:

HistoryStepImpl

public interface HistoryStep
extends Comparable<HistoryStep>

Method Summary

Modifier and Type	Method	Description
void	deleteActionRecord()	Delete the data filled at this step
String	getAction()
Date	getActionDate()
DataRecord	getActionRecord()	Get the data filled at this step
ActionStatus	getActionStatus()
String	getId()	Get the step id
ProcessInstance	getProcessInstance()
String	getResolvedState()
String	getResultingState()
String	getSubstituteId()
User	getUser()
String	getUserRoleName()	Get the role under which the user did the action
void	setActionRecord(DataRecord data)	Set the data filled at this step

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getProcessInstance

ProcessInstance getProcessInstance()

Returns:

ProcessInstance

getUser

User getUser()
      throws WorkflowException

Returns:

the actor

Throws:

WorkflowException

getId

String getId()

Get the step id

Returns:

the step id

getUserRoleName

String getUserRoleName()

Get the role under which the user did the action

Returns:

the role's name

getAction

String getAction()

Returns:

the action name

getActionDate

Date getActionDate()

Returns:

the action date

getResolvedState

String getResolvedState()

Returns:

the resolved state name

getResultingState

String getResultingState()

Returns:

the resulting state name

getActionStatus

ActionStatus getActionStatus()

Returns:

int

getActionRecord

DataRecord getActionRecord()
                    throws WorkflowException

Get the data filled at this step

Throws:

WorkflowException

setActionRecord

void setActionRecord(DataRecord data)
              throws WorkflowException

Set the data filled at this step

Throws:

WorkflowException

deleteActionRecord

void deleteActionRecord()
                 throws WorkflowException

Delete the data filled at this step

Throws:

WorkflowException

getSubstituteId

String getSubstituteId()

Returns:

the optional substitute