Interface UpdatableProcessInstance
-
- All Superinterfaces:
ProcessInstance
,Serializable
- All Known Implementing Classes:
ProcessInstanceImpl
public interface UpdatableProcessInstance extends ProcessInstance
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addActiveState(State state)
void
addHistoryStep(HistoryStep step)
void
addInterestedUser(Actor actor, State state)
void
addInterestedUser(User user, State state, String role)
Add an user in the interested user listvoid
addTimeout(State state)
void
addWorkingUser(Actor actor, State state)
void
addWorkingUser(User user, State state, String role)
void
cancelQuestion(Question question)
Cancel a question without responsevoid
computeValid()
void
lock()
Lock this instance by admin for all statesvoid
reDoState(String state, Date actionDate)
Cancel all the atomic operations since the step where first action had occuredvoid
removeActiveState(State state)
void
removeInterestedUser(User user, State state, String role)
Remove an user from the interested user listvoid
removeInterestedUsers(State state)
Remove all interested users for given statevoid
removeTimeout(State state)
void
removeWorkingUser(User user, State state, String role)
void
removeWorkingUsers(State state)
Remove all working users for given statevoid
saveActionRecord(HistoryStep step, DataRecord formData)
Save a new version of given form (including values)void
setErrorStatus(boolean errorStatus)
Set the error status of this instancevoid
setField(String name, Field value)
void
setInstanceId(String instanceId)
Set the workflow instance idvoid
setModelId(String modelId)
Set the workflow model idvoid
setTimeoutStatus(boolean timeoutStatus)
Set the timeout status of this instancevoid
unLock()
Lock this instance by admin for all statesvoid
updateHistoryStep(HistoryStep step)
-
Methods inherited from interface org.silverpeas.core.workflow.api.instance.ProcessInstance
addQuestion, answerQuestion, getActionRecord, getActiveStates, getActors, getAllDataRecord, getAssignedStates, getBackSteps, getErrorStatus, getField, getFolder, getFormRecord, getHistoryStep, getHistorySteps, getInstanceId, getLockingUser, getModelId, getMostRecentStep, getNewActionRecord, getParticipant, getParticipants, getPendingQuestions, getProcessModel, getQuestions, getRelevantQuestions, getRowDataRecord, getSavedStep, getSentQuestions, getTimeOutAction, getTimeoutStatus, getTitle, getUsersInGroup, getUsersInRole, getWorkingUsers, getWorkingUsers, getWorkingUsers, isLockedByAdmin, isStateInBackStatus, isValid, lock, unLock, updateFolder
-
-
-
-
Method Detail
-
setInstanceId
void setInstanceId(String instanceId)
Set the workflow instance id- Parameters:
instanceId
- instance id
-
setModelId
void setModelId(String modelId)
Set the workflow model id- Parameters:
modelId
- model id
-
addHistoryStep
void addHistoryStep(HistoryStep step) throws WorkflowException
- Parameters:
step
-- Throws:
WorkflowException
-
updateHistoryStep
void updateHistoryStep(HistoryStep step)
- Parameters:
step
-
-
reDoState
void reDoState(String state, Date actionDate) throws WorkflowException
Cancel all the atomic operations since the step where first action had occured- Parameters:
state
- the name of state where ac action has been discussedactionDate
- date of state re-resolving- Throws:
WorkflowException
-
setField
void setField(String name, Field value) throws WorkflowException
- Parameters:
name
-value
-- Throws:
WorkflowException
-
saveActionRecord
void saveActionRecord(HistoryStep step, DataRecord formData) throws WorkflowException
Save a new version of given form (including values)- Parameters:
step
- the new stepformData
- Form's values as a DataRecord object- Throws:
WorkflowException
-
addActiveState
void addActiveState(State state) throws WorkflowException
- Parameters:
state
-- Throws:
WorkflowException
-
removeActiveState
void removeActiveState(State state) throws WorkflowException
- Parameters:
state
-- Throws:
WorkflowException
-
addTimeout
void addTimeout(State state) throws WorkflowException
- Parameters:
state
-- Throws:
WorkflowException
-
removeTimeout
void removeTimeout(State state) throws WorkflowException
- Parameters:
state
-- Throws:
WorkflowException
-
addWorkingUser
void addWorkingUser(User user, State state, String role) throws WorkflowException
- Parameters:
user
-- Throws:
WorkflowException
-
addWorkingUser
void addWorkingUser(Actor actor, State state) throws WorkflowException
- Throws:
WorkflowException
-
removeWorkingUser
void removeWorkingUser(User user, State state, String role) throws WorkflowException
- Parameters:
user
-- Throws:
WorkflowException
-
removeWorkingUsers
void removeWorkingUsers(State state) throws WorkflowException
Remove all working users for given state- Parameters:
state
- state for which the user is interested- Throws:
WorkflowException
-
addInterestedUser
void addInterestedUser(User user, State state, String role) throws WorkflowException
Add an user in the interested user list- Parameters:
user
- user to addstate
- state for which the user is interestedrole
- role name under which the user is interested- Throws:
WorkflowException
-
addInterestedUser
void addInterestedUser(Actor actor, State state) throws WorkflowException
- Throws:
WorkflowException
-
removeInterestedUser
void removeInterestedUser(User user, State state, String role) throws WorkflowException
Remove an user from the interested user list- Parameters:
user
- user to removestate
- state for which the user is interestedrole
- role name under which the user is interested- Throws:
WorkflowException
-
removeInterestedUsers
void removeInterestedUsers(State state) throws WorkflowException
Remove all interested users for given state- Parameters:
state
- state for which the user is interested- Throws:
WorkflowException
-
lock
void lock() throws WorkflowException
Lock this instance by admin for all states- Throws:
WorkflowException
-
unLock
void unLock() throws WorkflowException
Lock this instance by admin for all states- Throws:
WorkflowException
-
setErrorStatus
void setErrorStatus(boolean errorStatus)
Set the error status of this instance- Parameters:
errorStatus
- true if this instance is in error
-
computeValid
void computeValid()
-
cancelQuestion
void cancelQuestion(Question question) throws WorkflowException
Cancel a question without response- Parameters:
question
- the question to cancel- Throws:
WorkflowException
-
setTimeoutStatus
void setTimeoutStatus(boolean timeoutStatus)
Set the timeout status of this instance- Parameters:
timeoutStatus
- true if this instance is in an active state for a long long time
-
-