Package org.silverpeas.core.workflow.engine.instance

Class ProcessInstanceImpl

java.lang.Object

org.silverpeas.core.persistence.datasource.model.jpa.AbstractJpaEntity<E,I>

org.silverpeas.core.persistence.datasource.model.jpa.BasicJpaEntity<ProcessInstanceImpl,UniqueIntegerIdentifier>

org.silverpeas.core.workflow.engine.instance.ProcessInstanceImpl

All Implemented Interfaces:

Serializable, IdentifiableEntity, ProcessInstance, UpdatableProcessInstance

@Entity
public class ProcessInstanceImpl
extends BasicJpaEntity<ProcessInstanceImpl,UniqueIntegerIdentifier>
implements UpdatableProcessInstance

This class is one implementation of interface UpdatableProcessInstance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceImpl()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	addActiveState(State state)	Adds the specified state as an active one in this process instance.
void	addActiveState(ActiveState activeState)	Add active state to the process instance
void	addHistoryStep(HistoryStep step)	Add a step in the history of actions performed in this process instance.
void	addInterestedUser(Actor actor, State state)
void	addInterestedUser(User user, State state, String role)	Add an user in the interested user list
State	addQuestion(String content, String stepId, State fromState, User fromUser)	Add a question
void	addQuestion(Question question)	Add a question to this instance
void	addTimeout(State state)	Adds a timeout to the specified active state.
void	addWorkingUser(Actor actor, State state)	Adds the specified actor to the given state.
void	addWorkingUser(User user, State state, String role)	Adds the specified working user to the given state with the specified role.
State	answerQuestion(String content, String questionId)	Answer a question
void	cancelQuestion(Question question)	Cancel a question without response
void	computeValid()
boolean	equals(Object obj)
DataRecord	getActionRecord(String actionName)	Gets the data that were provided to the specified action when it was was performed.
String[]	getActiveStates()	Gets all the active states of this process instance.
Actor[]	getActors(QualifiedUsers qualifiedUsers, State state)	Computes tuples role/user (stored in an Actor object) from a QualifiedUsers object
String[]	getAllAssignedStates(User user)	Gets all the states that are assigned to the specified user.
DataRecord	getAllDataRecord(String role, String lang)
String[]	getAssignedStates(User user, String roleName)	Gets all the states that are assigned to the specified user with given role.
HistoryStep[]	getBackSteps(User user, String roleName, String stateName)	Get all the steps where given user (with given role) can go back from the given state
boolean	getErrorStatus()	Is this process instance in error by an action?
Field	getField(String fieldName)	Gets the specified field.
DataRecord	getFolder()	Gets the folder of this process instance.
DataRecord	getFormRecord(String formName, String role, String lang)	Gets the data record of the specified form for the given role and written in the specified language.
HistoryStep	getHistoryStep(String stepId)	Gets the step with the specified identifier in the history of this process instance.
HistoryStep[]	getHistorySteps()	Gets the different steps in the history of this process instance.
String	getInstanceId()	Get the workflow instance id
LockingUser	getLockingUser(String state)	Gets the user that has locked the specified state.
String	getModelId()	Get the workflow model id
HistoryStep	getMostRecentStep(String actionName)	Recent the most recent step where the named action has been performed.
DataRecord	getNewActionRecord(String actionName, String language)	Gets a new data record associated with the given action.
Participant	getParticipant(String resolvedState)	Get the last user who resolved the given state
List<Participant>	getParticipants()	Gets all the participants in this process instance.
Question[]	getPendingQuestions(String stateName)	Get all the questions asked in the given state
ProcessModel	getProcessModel()	Gets the model of the process from which it was spawned.
Question[]	getQuestions()	Get all the questions asked in this processInstance
Question[]	getRelevantQuestions(String stateName)	Get all the questions asked from the given state and that have been answered
DataRecord	getRowDataRecord(String role, String lang)	Gets a data record which will be used to render this process instance as a row in a list of process instances.
HistoryStep	getSavedStep(String userId)	Get step saved by given user id.
Question[]	getSentQuestions(String stateName)	Get all the questions asked from the given state
ActionAndState	getTimeOutAction(Date dateRef)	Gets the timeout action to be launched after the given datetime.
boolean	getTimeoutStatus()	Gets the timeout status of this instance
String	getTitle(String role, String lang)	Returns this instance title.
List<User>	getUsersInGroup(String groupId)	Gets concrete users affected to given group at runtime
List<User>	getUsersInRole(String role)	Gets concrete users affected to given role at runtime
Actor[]	getWorkingUsers()	Gets all the users working on this process instance.
Actor[]	getWorkingUsers(String state)	Gets all the users working on the specified state of this instance state.
Actor[]	getWorkingUsers(String state, String role)	Gets all the users working on the specified state of this instance state with the given role.
int	hashCode()
boolean	isLockedByAdmin()	Is this process instance has been locked by the supervisor?
boolean	isStateInBackStatus(String stateName)	Test is a active state is in back status
boolean	isValid()	Is this process instance valid?
void	lock()	Lock this instance by admin for all states
void	lock(State state, User user)	Locks this instance for the given instance and state
void	reDoState(String state, Date actionDate)	Cancel all the atomic operations since the step where first action had occurred
void	removeActiveState(State state)	Removes the specified state as an active one.
void	removeInterestedUser(User user, State state, String role)	Remove an user from the interested user list
void	removeInterestedUsers(State state)	Remove all interested users for given state
void	removeTimeout(State state)	Removes the timeout from the specified active state.
void	removeWorkingUser(User user, State state, String role)	Removes the specified user from the working users of the specified state and with the given role.
void	removeWorkingUsers(State state)	Remove all working users for given state
void	saveActionRecord(HistoryStep step, DataRecord actionData)	Save a new version of given form (including values)
void	setErrorStatus(boolean errorStatus)	Set the error status of this instance
void	setField(String fieldName, Field copiedField)	Sets the specified field in the process instance.
void	setInstanceId(String instanceId)	Set the workflow instance id
void	setLockedByAdmin(boolean locked)	Set the lock Admin status of this instance
void	setModelId(String modelId)	Set the workflow model id
void	setTimeoutStatus(boolean timeoutStatus)	Set the timeout status of this instance
void	unLock()	Lock this instance by admin for all states
void	unLock(State state, User user)	Un-locks this instance for the given instance and state
void	updateFolder(DataRecord actionData)	Updates the folder of this process instance with the specified one.
void	updateHistoryStep(HistoryStep step)	Update the related history step by the given one.

Methods inherited from class org.silverpeas.core.persistence.datasource.model.jpa.BasicJpaEntity

performBeforePersist, performBeforeRemove, performBeforeUpdate

Methods inherited from class org.silverpeas.core.persistence.datasource.model.jpa.AbstractJpaEntity

getId, getNativeId, isPersisted, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessInstanceImpl

public ProcessInstanceImpl()

Default constructor

Method Detail

getInstanceId

public String getInstanceId()

Description copied from interface: ProcessInstance

Get the workflow instance id

Specified by:

getInstanceId in interface ProcessInstance

Returns:

instance id

setInstanceId

public void setInstanceId(String instanceId)

Description copied from interface: UpdatableProcessInstance

Set the workflow instance id

Specified by:

setInstanceId in interface UpdatableProcessInstance

Parameters:

instanceId - instance id

getModelId

public String getModelId()

Description copied from interface: ProcessInstance

Get the workflow model id

Specified by:

getModelId in interface ProcessInstance

Returns:

model id

setModelId

public void setModelId(String modelId)

Description copied from interface: UpdatableProcessInstance

Set the workflow model id

Specified by:

setModelId in interface UpdatableProcessInstance

Parameters:

modelId - model id

addHistoryStep

public void addHistoryStep(HistoryStep step)

Description copied from interface: UpdatableProcessInstance

Add a step in the history of actions performed in this process instance.

Specified by:

addHistoryStep in interface UpdatableProcessInstance

Parameters:

step - a step in the workflow process history.

updateHistoryStep

public void updateHistoryStep(HistoryStep step)

Description copied from interface: UpdatableProcessInstance

Update the related history step by the given one.

Specified by:

updateHistoryStep in interface UpdatableProcessInstance

Parameters:

step - a step in the workflow process history.

addActiveState

public void addActiveState(State state)

Description copied from interface: UpdatableProcessInstance

Adds the specified state as an active one in this process instance. An active state is the current state of the process instance; that is to say a state that is currently waiting for actions by working users. A process instance can have several active states in parallel.

Specified by:

addActiveState in interface UpdatableProcessInstance

Parameters:

state - the active state.

removeActiveState

public void removeActiveState(State state)

Description copied from interface: UpdatableProcessInstance

Removes the specified state as an active one. An active state is the current state of the process instance; that is to say a state that is currently waiting for actions by working users. A process instance can have several active states in parallel.

Specified by:

removeActiveState in interface UpdatableProcessInstance

Parameters:

state - the active state.

addTimeout

public void addTimeout(State state)

Description copied from interface: UpdatableProcessInstance

Adds a timeout to the specified active state. A timeout is a way to avoid a long time state. The time out is defined by a TimeOutAction provided by the specified state.

Specified by:

addTimeout in interface UpdatableProcessInstance

Parameters:

state - the state for which a time out has to be added.

removeTimeout

public void removeTimeout(State state)

Description copied from interface: UpdatableProcessInstance

Removes the timeout from the specified active state. A timeout is a way to avoid a long time state.

Specified by:

removeTimeout in interface UpdatableProcessInstance

Parameters:

state - the state for which a time out has to be removed.

addWorkingUser

public void addWorkingUser(User user,
                           State state,
                           String role)

Description copied from interface: UpdatableProcessInstance

Adds the specified working user to the given state with the specified role.

Specified by:

addWorkingUser in interface UpdatableProcessInstance

Parameters:

user - the working user to add

state - the state on which the user will work

role - the role the user will play in the above state

addWorkingUser

public void addWorkingUser(Actor actor,
                           State state)

Description copied from interface: UpdatableProcessInstance

Adds the specified actor to the given state.

Specified by:

addWorkingUser in interface UpdatableProcessInstance

Parameters:

actor - the actor to add

state - the state for which the actor has to be defined

removeWorkingUser

public void removeWorkingUser(User user,
                              State state,
                              String role)

Description copied from interface: UpdatableProcessInstance

Removes the specified user from the working users of the specified state and with the given role.

Specified by:

removeWorkingUser in interface UpdatableProcessInstance

Parameters:

user - the user to remove.

state - the state from which the user has to be removed

role - the role the user plays in the above state

addInterestedUser

public void addInterestedUser(User user,
                              State state,
                              String role)

Description copied from interface: UpdatableProcessInstance

Add an user in the interested user list

Specified by:

addInterestedUser in interface UpdatableProcessInstance

Parameters:

user - user to add

state - state for which the user is interested

role - role name under which the user is interested

addInterestedUser

public void addInterestedUser(Actor actor,
                              State state)

Specified by:

addInterestedUser in interface UpdatableProcessInstance

removeInterestedUser

public void removeInterestedUser(User user,
                                 State state,
                                 String role)

Description copied from interface: UpdatableProcessInstance

Remove an user from the interested user list

Specified by:

removeInterestedUser in interface UpdatableProcessInstance

Parameters:

user - user to remove

state - state for which the user is interested

role - role name under which the user is interested

addQuestion

public void addQuestion(Question question)

Add a question to this instance

Parameters:

question - the question to add

computeValid

public void computeValid()

Specified by:

computeValid in interface UpdatableProcessInstance

getProcessModel

public ProcessModel getProcessModel()
                             throws WorkflowException

Description copied from interface: ProcessInstance

Gets the model of the process from which it was spawned.

Specified by:

getProcessModel in interface ProcessInstance

Returns:

the ProcessModel of this process instance.

Throws:

WorkflowException

getHistorySteps

public HistoryStep[] getHistorySteps()

Description copied from interface: ProcessInstance

Gets the different steps in the history of this process instance. A history step defines the change of a state by an action performed by a given working user.

Specified by:

getHistorySteps in interface ProcessInstance

Returns:

an array of HistoryStep objects.

getHistoryStep

public HistoryStep getHistoryStep(String stepId)
                           throws WorkflowException

Description copied from interface: ProcessInstance

Gets the step with the specified identifier in the history of this process instance.

Specified by:

getHistoryStep in interface ProcessInstance

Parameters:

stepId - the unique identifier of a history step.

Returns:

the asked history step.

Throws:

WorkflowException - if no such history step can be found.

getParticipants

public List<Participant> getParticipants()
                                  throws WorkflowException

Description copied from interface: ProcessInstance

Gets all the participants in this process instance.

Specified by:

getParticipants in interface ProcessInstance

Returns:

the list of participants in this process instance.

Throws:

WorkflowException - if an error occurs.

getParticipant

public Participant getParticipant(String resolvedState)
                           throws WorkflowException

Description copied from interface: ProcessInstance

Get the last user who resolved the given state

Specified by:

getParticipant in interface ProcessInstance

Parameters:

resolvedState - the resolved state

Returns:

the user as a Participant object

Throws:

WorkflowException - if an error occurs.

getFolder

public DataRecord getFolder()
                     throws WorkflowException

Description copied from interface: ProcessInstance

Gets the folder of this process instance.

Specified by:

getFolder in interface ProcessInstance

Returns:

the folder as a DataRecord object.

Throws:

WorkflowException - if an error occurs.

getAllDataRecord

public DataRecord getAllDataRecord(String role,
                                   String lang)
                            throws WorkflowException

Specified by:

getAllDataRecord in interface ProcessInstance

Parameters:

role - a role a user can play in this process instance.

lang - the ISO-631 code of a language in which data have to be.

Returns:

a record with all the data.

Throws:

WorkflowException - if an error occurs.

getRowDataRecord

public DataRecord getRowDataRecord(String role,
                                   String lang)
                            throws WorkflowException

Description copied from interface: ProcessInstance

Gets a data record which will be used to render this process instance as a row in a list of process instances. The information set in the record are filtered by what is allowed to be rendered for the given role.

Specified by:

getRowDataRecord in interface ProcessInstance

Parameters:

role - a role a user can play in this process instance.

lang - the ISO-631 code of the language in which data have to be.

Throws:

WorkflowException - if an error occurs.

updateFolder

public void updateFolder(DataRecord actionData)
                  throws WorkflowException

Description copied from interface: ProcessInstance

Updates the folder of this process instance with the specified one.

Specified by:

updateFolder in interface ProcessInstance

Parameters:

actionData - the data record with which the folder has to be updated.

Throws:

WorkflowException - if the update fails.

getField

public Field getField(String fieldName)
               throws WorkflowException

Description copied from interface: ProcessInstance

Gets the specified field.

Specified by:

getField in interface ProcessInstance

Parameters:

fieldName - the name that identifies a field in this process instance.

Returns:

the corresponding field.

Throws:

WorkflowException - if the field cannot be found or if an error occurs.

setField

public void setField(String fieldName,
                     Field copiedField)
              throws WorkflowException

Description copied from interface: UpdatableProcessInstance

Sets the specified field in the process instance.

Specified by:

setField in interface UpdatableProcessInstance

Parameters:

fieldName - the name of the field

copiedField - the field to set

Throws:

WorkflowException

getActionRecord

public DataRecord getActionRecord(String actionName)
                           throws WorkflowException

Description copied from interface: ProcessInstance

Gets the data that were provided to the specified action when it was was performed. The most recent data is returned in the case the action has been done several times.

Specified by:

getActionRecord in interface ProcessInstance

Parameters:

actionName - action name the name of the performed action.

Returns:

the data record.

Throws:

WorkflowException

getFormRecord

public DataRecord getFormRecord(String formName,
                                String role,
                                String lang)
                         throws WorkflowException

Description copied from interface: ProcessInstance

Gets the data record of the specified form for the given role and written in the specified language. The information set in the record are filtered by what is allowed to be accessed for the given role.

Specified by:

getFormRecord in interface ProcessInstance

Parameters:

formName - the name of the form to get.

role - a role a user can play in this process instance.

lang - the ISO-631 code of the language in which data have to be.

Returns:

DataRecord or null if no such form can be found.

Throws:

WorkflowException - if an error occurs.

getNewActionRecord

public DataRecord getNewActionRecord(String actionName,
                                     String language)
                              throws WorkflowException

Description copied from interface: ProcessInstance

Gets a new data record associated with the given action.

Specified by:

getNewActionRecord in interface ProcessInstance

Parameters:

actionName - action name

language - the ISO-631 code of the language in which the data will be.

Returns:

the new empty data record.

Throws:

WorkflowException

saveActionRecord

public void saveActionRecord(HistoryStep step,
                             DataRecord actionData)
                      throws WorkflowException

Description copied from interface: UpdatableProcessInstance

Save a new version of given form (including values)

Specified by:

saveActionRecord in interface UpdatableProcessInstance

Parameters:

step - the new step

actionData - Form's values as a DataRecord object

Throws:

WorkflowException

getMostRecentStep

public HistoryStep getMostRecentStep(String actionName)

Description copied from interface: ProcessInstance

Recent the most recent step where the named action has been performed.

Specified by:

getMostRecentStep in interface ProcessInstance

getSavedStep

public HistoryStep getSavedStep(String userId)
                         throws WorkflowException

Description copied from interface: ProcessInstance

Get step saved by given user id.

Specified by:

getSavedStep in interface ProcessInstance

Returns:

the history step or null if there is no such step.

Throws:

WorkflowException - if an error occurs.

getActiveStates

public String[] getActiveStates()

Description copied from interface: ProcessInstance

Gets all the active states of this process instance. An active state is the current state at which the process is and waiting for actions.

Specified by:

getActiveStates in interface ProcessInstance

Returns:

an array with the name of all the active states.

isStateInBackStatus

public boolean isStateInBackStatus(String stateName)

Description copied from interface: ProcessInstance

Test is a active state is in back status

Specified by:

isStateInBackStatus in interface ProcessInstance

Parameters:

stateName - name of active state

Returns:

true if resolution of active state involves a cancel of actions

getWorkingUsers

public Actor[] getWorkingUsers()
                        throws WorkflowException

Description copied from interface: ProcessInstance

Gets all the users working on this process instance.

Specified by:

getWorkingUsers in interface ProcessInstance

Returns:

an array of Actor objects.

Throws:

WorkflowException - if an error occurs.

getWorkingUsers

public Actor[] getWorkingUsers(String state)
                        throws WorkflowException

Description copied from interface: ProcessInstance

Gets all the users working on the specified state of this instance state.

Specified by:

getWorkingUsers in interface ProcessInstance

Parameters:

state - the name of a state in this process instance.

Returns:

an array of Actor objects.

Throws:

WorkflowException

removeWorkingUsers

public void removeWorkingUsers(State state)

Description copied from interface: UpdatableProcessInstance

Remove all working users for given state

Specified by:

removeWorkingUsers in interface UpdatableProcessInstance

Parameters:

state - state for which the user is interested

removeInterestedUsers

public void removeInterestedUsers(State state)

Description copied from interface: UpdatableProcessInstance

Remove all interested users for given state

Specified by:

removeInterestedUsers in interface UpdatableProcessInstance

Parameters:

state - state for which the user is interested

getWorkingUsers

public Actor[] getWorkingUsers(String state,
                               String role)
                        throws WorkflowException

Description copied from interface: ProcessInstance

Gets all the users working on the specified state of this instance state with the given role.

Specified by:

getWorkingUsers in interface ProcessInstance

Parameters:

state - the name of a state in this process instance.

Returns:

an array of Actor objects.

Throws:

WorkflowException

getAssignedStates

public String[] getAssignedStates(User user,
                                  String roleName)

Description copied from interface: ProcessInstance

Gets all the states that are assigned to the specified user with given role.

Specified by:

getAssignedStates in interface ProcessInstance

Parameters:

user - a user in the workflow.

roleName - a role the user has to play in this process instance.

Returns:

an array with the name of all the states assigned to the given user with the given role name.

getAllAssignedStates

public String[] getAllAssignedStates(User user)

Description copied from interface: ProcessInstance

Gets all the states that are assigned to the specified user.

Specified by:

getAllAssignedStates in interface ProcessInstance

Parameters:

user - a user in the workflow.

Returns:

an array with the name of all the states assigned to the given user

getLockingUser

public LockingUser getLockingUser(String state)

Description copied from interface: ProcessInstance

Gets the user that has locked the specified state.

Specified by:

getLockingUser in interface ProcessInstance

Parameters:

state - the name of a state in this process instance.

Returns:

the user as a LockingUser instance.

lock

public void lock(State state,
                 User user)
          throws WorkflowException

Description copied from interface: ProcessInstance

Locks this instance for the given instance and state

Specified by:

lock in interface ProcessInstance

Parameters:

state - state that have to be locked

user - the locking user

Throws:

WorkflowException

unLock

public void unLock(State state,
                   User user)
            throws WorkflowException

Description copied from interface: ProcessInstance

Un-locks this instance for the given instance and state

Specified by:

unLock in interface ProcessInstance

Parameters:

state - state that have to be un-locked

user - the unlocking user

Throws:

WorkflowException

lock

public void lock()
          throws WorkflowException

Description copied from interface: UpdatableProcessInstance

Lock this instance by admin for all states

Specified by:

lock in interface UpdatableProcessInstance

Throws:

WorkflowException

unLock

public void unLock()

Description copied from interface: UpdatableProcessInstance

Lock this instance by admin for all states

Specified by:

unLock in interface UpdatableProcessInstance

isValid

public boolean isValid()

Description copied from interface: ProcessInstance

Is this process instance valid?

Specified by:

isValid in interface ProcessInstance

Returns:

true is this instance is valid. False otherwise.

isLockedByAdmin

public boolean isLockedByAdmin()

Description copied from interface: ProcessInstance

Is this process instance has been locked by the supervisor?

Specified by:

isLockedByAdmin in interface ProcessInstance

Returns:

true is this instance is locked by admin, false otherwise.

setLockedByAdmin

public void setLockedByAdmin(boolean locked)

Set the lock Admin status of this instance

Parameters:

locked - true is this instance is locked by admin

getErrorStatus

public boolean getErrorStatus()

Description copied from interface: ProcessInstance

Is this process instance in error by an action?

Specified by:

getErrorStatus in interface ProcessInstance

Returns:

true if this instance is in error, false otherwise.

setErrorStatus

public void setErrorStatus(boolean errorStatus)

Description copied from interface: UpdatableProcessInstance

Set the error status of this instance

Specified by:

setErrorStatus in interface UpdatableProcessInstance

Parameters:

errorStatus - true if this instance is in error

getTimeoutStatus

public boolean getTimeoutStatus()

Description copied from interface: ProcessInstance

Gets the timeout status of this instance

Specified by:

getTimeoutStatus in interface ProcessInstance

Returns:

true if this instance is in an active state for a long long time. False otherwise.

setTimeoutStatus

public void setTimeoutStatus(boolean timeoutStatus)

Description copied from interface: UpdatableProcessInstance

Set the timeout status of this instance

Specified by:

setTimeoutStatus in interface UpdatableProcessInstance

Parameters:

timeoutStatus - true if this instance is in an active state for a long long time

getUsersInRole

public List<User> getUsersInRole(String role)

Description copied from interface: ProcessInstance

Gets concrete users affected to given role at runtime

Specified by:

getUsersInRole in interface ProcessInstance

Parameters:

role - the name of the role

Returns:

users affected to given role

getUsersInGroup

public List<User> getUsersInGroup(String groupId)

Description copied from interface: ProcessInstance

Gets concrete users affected to given group at runtime

Specified by:

getUsersInGroup in interface ProcessInstance

Parameters:

groupId - the id of the group

Returns:

users in given group

getActors

public Actor[] getActors(QualifiedUsers qualifiedUsers,
                         State state)
                  throws WorkflowException

Description copied from interface: ProcessInstance

Computes tuples role/user (stored in an Actor object) from a QualifiedUsers object

Specified by:

getActors in interface ProcessInstance

Parameters:

qualifiedUsers - Users defined by their role or by a relation with a participant

state - state for which these user were/may be actors

Returns:

tuples role/user as an array of Actor objects

Throws:

WorkflowException - if an error occurs

reDoState

public void reDoState(String state,
                      Date actionDate)
               throws WorkflowException

Description copied from interface: UpdatableProcessInstance

Cancel all the atomic operations since the step where first action had occurred

Specified by:

reDoState in interface UpdatableProcessInstance

Parameters:

state - the name of state where ac action has been discussed

actionDate - date of state re-resolving

Throws:

WorkflowException

getBackSteps

public HistoryStep[] getBackSteps(User user,
                                  String roleName,
                                  String stateName)
                           throws WorkflowException

Description copied from interface: ProcessInstance

Get all the steps where given user (with given role) can go back from the given state

Specified by:

getBackSteps in interface ProcessInstance

Parameters:

user - user that can do the back actions

roleName - role name of this user

stateName - name of state where user want to go back from

Returns:

an array of HistoryStep objects

Throws:

WorkflowException

addQuestion

public State addQuestion(String content,
                         String stepId,
                         State fromState,
                         User fromUser)
                  throws WorkflowException

Description copied from interface: ProcessInstance

Add a question

Specified by:

addQuestion in interface ProcessInstance

Parameters:

content - question text

stepId - id of destination step for the question

fromState - the state where the question was asked

fromUser - the user who asked the question

Returns:

The state to which the question is

Throws:

WorkflowException

answerQuestion

public State answerQuestion(String content,
                            String questionId)
                     throws WorkflowException

Description copied from interface: ProcessInstance

Answer a question

Specified by:

answerQuestion in interface ProcessInstance

Parameters:

content - response text

questionId - id of question corresponding to this response

Returns:

The state where the question was asked

Throws:

WorkflowException

getPendingQuestions

public Question[] getPendingQuestions(String stateName)

Description copied from interface: ProcessInstance

Get all the questions asked in the given state

Specified by:

getPendingQuestions in interface ProcessInstance

Parameters:

stateName - given state name

Returns:

all the questions (not yet answered) asked in the given state

getSentQuestions

public Question[] getSentQuestions(String stateName)

Description copied from interface: ProcessInstance

Get all the questions asked from the given state

Specified by:

getSentQuestions in interface ProcessInstance

Parameters:

stateName - given state name

Returns:

all the questions (not yet answered) asked from the given state

getRelevantQuestions

public Question[] getRelevantQuestions(String stateName)

Description copied from interface: ProcessInstance

Get all the questions asked from the given state and that have been answered

Specified by:

getRelevantQuestions in interface ProcessInstance

Parameters:

stateName - given state name

Returns:

all the answered questions asked from the given state

cancelQuestion

public void cancelQuestion(Question question)
                    throws WorkflowException

Description copied from interface: UpdatableProcessInstance

Cancel a question without response

Specified by:

cancelQuestion in interface UpdatableProcessInstance

Parameters:

question - the question to cancel

Throws:

WorkflowException

getQuestions

public Question[] getQuestions()

Description copied from interface: ProcessInstance

Get all the questions asked in this processInstance

Specified by:

getQuestions in interface ProcessInstance

Returns:

all the questions

addActiveState

public void addActiveState(ActiveState activeState)

Add active state to the process instance

Parameters:

activeState - state to add.

getTitle

public String getTitle(String role,
                       String lang)

Description copied from interface: ProcessInstance

Returns this instance title.

Specified by:

getTitle in interface ProcessInstance

getTimeOutAction

public ActionAndState getTimeOutAction(Date dateRef)
                                throws WorkflowException

Description copied from interface: ProcessInstance

Gets the timeout action to be launched after the given datetime.

Specified by:

getTimeOutAction in interface ProcessInstance

Returns:

the asked ActionAndState or null if no such action is found.

Throws:

WorkflowException - if an error occurs

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractJpaEntity<ProcessInstanceImpl,UniqueIntegerIdentifier>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractJpaEntity<ProcessInstanceImpl,UniqueIntegerIdentifier>