com.silverpeas.processManager
Class ProcessManagerSessionController

java.lang.Object
  com.stratelia.silverpeas.peasCore.AbstractComponentSessionController
      com.silverpeas.processManager.ProcessManagerSessionController

All Implemented Interfaces:

com.stratelia.silverpeas.peasCore.ComponentSessionController

public class ProcessManagerSessionController
extends com.stratelia.silverpeas.peasCore.AbstractComponentSessionController

The ProcessManager Session controller

Field Summary

Fields inherited from class com.stratelia.silverpeas.peasCore.AbstractComponentSessionController

CHARACTER_ENCODING, context

Constructor Summary

ProcessManagerSessionController(com.stratelia.silverpeas.peasCore.MainSessionController mainSessionCtrl, com.stratelia.silverpeas.peasCore.ComponentContext context)
Builds and init a new session controller

ProcessManagerSessionController(com.stratelia.silverpeas.peasCore.MainSessionController mainSessionCtrl, com.stratelia.silverpeas.peasCore.ComponentContext context, ProcessManagerException fatal)
Builds a ill session controller.

Method Summary

String	createProcessInstance(com.silverpeas.form.DataRecord data, boolean isDraft, boolean firstTimeSaved) Create a new process instance with the filled form.
String	exportListAsCSV()
boolean	filterHistory() L'historique peut être filtré.
com.silverpeas.workflow.api.model.Action	getAction(String actionName) Get the named action
com.silverpeas.form.Form	getActionForm(String stateName, String actionName) Returns the form associated to the named action.
String	getActionLabel(String actionName) Get the label of given action
com.silverpeas.form.DataRecord	getActionRecord(String stateName, String actionName) Returns a new DataRecord filled whith the folder data and which will be be completed by the action form.
String[]	getActiveRoles()
String[]	getActiveStates() Get the active states.
com.silverpeas.form.Form	getAssignForm() Get assign form (for the re-affectations)
com.silverpeas.form.DataRecord	getAssignRecord() Get assign data (for the re-affectations)
com.silverpeas.form.record.GenericRecordTemplate	getAssignTemplate() Get assign template (for the re-affectations)
com.silverpeas.form.Form	getCreationForm() Returns the form which starts a new instance.
boolean	getCreationRights() Get the creation rights
com.silverpeas.workflow.api.task.Task	getCreationTask() Returns the creation task.
ProcessFilter	getCurrentFilter() Returns the current ProcessFilter.
com.silverpeas.workflow.api.instance.ProcessInstance	getCurrentProcessInstance() Get the current process instance
com.silverpeas.form.DataRecord[]	getCurrentProcessList() Returns the current process instance list.
String	getCurrentRole() Returns the current role name.
String	getCurrentTokenId() Get the current tokenId.
String[]	getDeleteAction() Search for an hypothetic action of kind "delete", allowed for the current user with the given role
com.silverpeas.form.DataRecord	getEmptyCreationRecord() Returns the an empty creation record which will be filled with the creation form.
com.silverpeas.form.DataRecord	getEmptyQuestionRecord() Returns the an empty question record which will be filled with the question form.
com.silverpeas.form.DataRecord	getEmptyUserSettingsRecord() Returns the an empty date record which will be filled with the user settings form.
ProcessManagerException	getFatalException() Returns the last fatal exception
com.silverpeas.workflow.api.model.Item[]	getFolderItems()
com.silverpeas.form.DataRecord	getFolderRecord() Returns the folder data of the current process instance.
List<LockVO>	getLockingUsers() Get locking users list
com.silverpeas.form.Form	getPresentationForm() Returns the form presenting the folder of the current process instance.
com.silverpeas.form.Form	getPresentationForm(String name) Returns the named form (Read only).
com.silverpeas.form.Form	getPrintForm(javax.servlet.http.HttpServletRequest request) Returns the form defined to print
com.silverpeas.form.DataRecord	getPrintRecord() Returns the data of instance
com.silverpeas.workflow.api.error.WorkflowError[]	getProcessInstanceErrors(String processId) Get all the errors occured while processing the current process instance
String	getProcessInstanceIdFromExternalTodoId(String externalTodoId) Get the process instance Id referred by the todo with the given todo id
com.silverpeas.form.RecordTemplate	getProcessListHeaders() Returns the current instance list rows template.
com.silverpeas.workflow.api.model.ProcessModel	getProcessModel(String modelId) Returns the process model having the given id.
com.silverpeas.workflow.api.instance.Question	getQuestion(String questionId) get the question with the given id
com.silverpeas.form.Form	getQuestionForm(boolean readonly) Returns the form to ask a question
com.silverpeas.form.DataRecord	getQuestionRecord(String questionId) Returns the an empty question record which will be filled with the question form.
String	getRoleNameFromExternalTodoId(String externalTodoId) Get the role name of task referred by the todo with the given todo id
com.silverpeas.workflow.api.instance.HistoryStep	getSavedStep() Get step saved by given user id.
com.silverpeas.form.DataRecord	getSavedStepRecord(com.silverpeas.workflow.api.instance.HistoryStep savedStep) Get step data record saved.
com.silverpeas.workflow.api.instance.HistoryStep[]	getSortedHistorySteps(boolean ascending)
com.silverpeas.workflow.api.model.State	getState(String stateName) Get the state with the given name
com.silverpeas.workflow.api.instance.HistoryStep	getStep(String stepId) Returns the required step
String	getStepAction(com.silverpeas.workflow.api.instance.HistoryStep step) Get the list of actions in History Step of current process instance
String	getStepActor(com.silverpeas.workflow.api.instance.HistoryStep step) Get the list of actors in History Step of current process instance
com.silverpeas.form.Form	getStepForm(com.silverpeas.workflow.api.instance.HistoryStep step) Returns the form used to display the i-th step.
com.silverpeas.form.DataRecord	getStepRecord(com.silverpeas.workflow.api.instance.HistoryStep step) Returns the data filled during the given step.
List<StepVO>	getSteps(String strEnlightedStep)
com.silverpeas.workflow.api.task.Task	getTask(String stateName) Returns the named task.
com.silverpeas.workflow.api.task.Task[]	getTasks() Get all tasks assigned for current user on current process instance
String	getTrace(String function, String extraParam)
com.silverpeas.workflow.api.user.User	getUser(String userId) Returns the workflow user having the given id.
NamedValue[]	getUserRoleLabels() Returns the user roles as a list of (name, label) pair.
List<String>	getUsers(com.silverpeas.workflow.api.model.QualifiedUsers qualifiedUsers)
List<String>	getUsers(com.silverpeas.workflow.api.model.QualifiedUsers qualifiedUsers, boolean useCurrentRole)
com.silverpeas.form.Form	getUserSettingsForm() Returns the form to fill user settings
com.silverpeas.form.DataRecord	getUserSettingsRecord() Returns the an empty data record which will be filled with the user settings form.
boolean	hasPendingQuestions() Tests if there is some question for current user in current processInstance
boolean	hasUserSettings() Returns true if : the model has any user settings.
boolean	isActiveUser() Get the active user names
boolean	isAttachmentTabEnable()
boolean	isCSVExportEnabled()
boolean	isCurrentUserIsLockingUser() Is current user is part of the locking users for current process instance ?
boolean	isHistoryTabVisible()
boolean	isPrintButtonEnabled() Print button on an action can be disabled.
boolean	isProcessIdVisible()
boolean	isResumingInstance()
boolean	isSaveButtonEnabled() Save button on an action can be disabled.
boolean	isStepVisible(com.silverpeas.workflow.api.instance.HistoryStep step)
boolean	isUserAllowedOnActiveStates()
boolean	isUserSettingsOK() Returns true if : the user settings are correct
boolean	isVersionControlled()
boolean	isViewReturn()
void	lock(String stateName) Lock the current instance for current user and given state
void	processAction(String stateName, String actionName, com.silverpeas.form.DataRecord data, boolean isDraft, boolean isFirstTimeSaved) Create a new history step instance with the filled form.
void	processQuestion(String stepId, String state, com.silverpeas.form.DataRecord data) Send the question as a QuestionEvent to the workflowEngine.
void	processResponse(String questionId, com.silverpeas.form.DataRecord data) Send the answer as a ResponseEvent to the workflowEngine.
void	reAssign(com.silverpeas.form.DataRecord data) Get assign data (for the re-affectations)
void	removeProcess(String processId) Remove process instance with given id
void	resetCreationRights() Compute the creation rights set creationRight to true if user can do the "Creation" action
void	resetCurrentProcessInstance() Set current Process instance to null
com.silverpeas.workflow.api.instance.ProcessInstance	resetCurrentProcessInstance(String instanceId) Updates the current process instance from the given id and returns the associated ProcessInstance object.
com.silverpeas.form.DataRecord[]	resetCurrentProcessList() Updates the current process instance list with current filter and returns this list.
void	resetCurrentProcessListHeaders() Reset the current instance list rows template.
void	resetCurrentRole(String role) Returns the current role name.
void	resetProcessFilter() Reset the current ProcessFilter.
void	saveUserSettings(com.silverpeas.form.DataRecord data) Save the user settings which have been filled with the user settings form.
void	setCurrentTokenId(String newTokenId) Set the current tokenId.
void	setResumingInstance(boolean isResumingInstance)
void	unlock(String stateName) Un-Lock the current instance for current user and given state
void	unlock(String userId, String stateName) Un-Lock the current instance for given user and given state

Methods inherited from class com.stratelia.silverpeas.peasCore.AbstractComponentSessionController

addClipboardSelection, clipboardPasteDone, close, getAlertUser, getClipboardCount, getClipboardErrorMessage, getClipboardExceptionError, getClipboardName, getClipboardObjects, getClipboardSelectedObjects, getClipboardSize, getComponentAccessController, getComponentId, getComponentLabel, getComponentName, getComponentParameters, getComponentParameterValue, getComponentParameterValue, getComponentRootName, getComponentUrl, getFavoriteSpace, getGenericPanel, getHighestSilverpeasUserRole, getIcon, getLanguage, getLastResults, getLook, getMultilang, getOrganisationController, getPersonalization, getRSSUrl, getSelection, getServerNameAndPort, getSettings, getSilverpeasUserRoles, getSpaceId, getSpaceLabel, getString, getSubscriptionContext, getUrlEncodedParameter, getUserAccessLevel, getUserAvailComponentIds, getUserAvailSpaceIds, getUserDetail, getUserDetail, getUserId, getUserManageableGroupIds, getUserManageableSpaceIds, getUserRoleLevel, getUserRoles, isAppInMaintenance, isGroupManager, isPasswordChangeAllowed, isSpaceInMaintenance, removeClipboardElement, setAppModeMaintenance, setClipboardError, setClipboardSelectedElement, setComponentRootName, setFavoriteSpaceToMainSessionController, setGenericPanel, setIconFileName, setLastResults, setMultilangFileName, setResourceFileName, setSpaceModeMaintenance

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessManagerSessionController

public ProcessManagerSessionController(com.stratelia.silverpeas.peasCore.MainSessionController mainSessionCtrl,
                                       com.stratelia.silverpeas.peasCore.ComponentContext context)
                                throws ProcessManagerException

Builds and init a new session controller

Parameters:

mainSessionCtrl -

context -

Throws:

ProcessManagerException

ProcessManagerSessionController

public ProcessManagerSessionController(com.stratelia.silverpeas.peasCore.MainSessionController mainSessionCtrl,
                                       com.stratelia.silverpeas.peasCore.ComponentContext context,
                                       ProcessManagerException fatal)

Builds a ill session controller. Initialization is skipped and this session controller can only display the fatal exception. Used by the request router when a full session controller can't be built.

Parameters:

mainSessionCtrl -

context -

fatal -

Method Detail

getCreationRights

public boolean getCreationRights()

Get the creation rights

Returns:

true if user can do the "Creation" action

resetCreationRights

public final void resetCreationRights()

Compute the creation rights set creationRight to true if user can do the "Creation" action

filterHistory

public boolean filterHistory()

L'historique peut être filtré. Dans ce cas, les formulaires associés à chaque état sont visibles uniquement si l'utilisateur courant était un working user ou un interested user.

isHistoryTabVisible

public boolean isHistoryTabVisible()

isCSVExportEnabled

public boolean isCSVExportEnabled()

isPrintButtonEnabled

public boolean isPrintButtonEnabled()

Print button on an action can be disabled. So it's return the visibility status of that button.

Returns:

true is print button is visible

isSaveButtonEnabled

public boolean isSaveButtonEnabled()

Save button on an action can be disabled. So it's return the visibility status of that button.

Returns:

true is save button is visible

getFatalException

public ProcessManagerException getFatalException()

Returns the last fatal exception

resetCurrentProcessInstance

public void resetCurrentProcessInstance()

Set current Process instance to null

resetCurrentProcessInstance

public com.silverpeas.workflow.api.instance.ProcessInstance resetCurrentProcessInstance(String instanceId)
                                                                                 throws ProcessManagerException

Updates the current process instance from the given id and returns the associated ProcessInstance object. If the instanceId parameter is null, updates nothing and returns the current ProcessInstance. Throws ProcessManagerException when the instanceId is unkwown and when the current user is not allowed to access the instance. Doesn't change the current process instance when an error occures.

Throws:

ProcessManagerException

getCurrentProcessInstance

public com.silverpeas.workflow.api.instance.ProcessInstance getCurrentProcessInstance()

Get the current process instance

getProcessListHeaders

public com.silverpeas.form.RecordTemplate getProcessListHeaders()

Returns the current instance list rows template.

resetCurrentProcessListHeaders

public void resetCurrentProcessListHeaders()

Reset the current instance list rows template.

getCurrentProcessList

public com.silverpeas.form.DataRecord[] getCurrentProcessList()
                                                       throws ProcessManagerException

Returns the current process instance list.

Throws:

ProcessManagerException

resetCurrentProcessList

public com.silverpeas.form.DataRecord[] resetCurrentProcessList()
                                                         throws ProcessManagerException

Updates the current process instance list with current filter and returns this list. Doesn't change the current process instance when an error occurs.

Throws:

ProcessManagerException

getRoleNameFromExternalTodoId

public String getRoleNameFromExternalTodoId(String externalTodoId)
                                     throws ProcessManagerException

Get the role name of task referred by the todo with the given todo id

Throws:

ProcessManagerException

getProcessInstanceIdFromExternalTodoId

public String getProcessInstanceIdFromExternalTodoId(String externalTodoId)
                                              throws ProcessManagerException

Get the process instance Id referred by the todo with the given todo id

Parameters:

externalTodoId -

Returns:

the process instance Id referred by the todo with the given todo id.

Throws:

ProcessManagerException

isUserAllowedOnActiveStates

public boolean isUserAllowedOnActiveStates()

getActiveStates

public String[] getActiveStates()

Get the active states.

Returns:

the active states.

getActiveRoles

public String[] getActiveRoles()

isActiveUser

public boolean isActiveUser()

Get the active user names

getUsers

public List<String> getUsers(com.silverpeas.workflow.api.model.QualifiedUsers qualifiedUsers)

getUsers

public List<String> getUsers(com.silverpeas.workflow.api.model.QualifiedUsers qualifiedUsers,
                             boolean useCurrentRole)

getUser

public com.silverpeas.workflow.api.user.User getUser(String userId)
                                              throws ProcessManagerException

Returns the workflow user having the given id.

Parameters:

userId -

Returns:

the workflow user having the given id.

Throws:

ProcessManagerException

getProcessModel

public final com.silverpeas.workflow.api.model.ProcessModel getProcessModel(String modelId)
                                                                     throws ProcessManagerException

Returns the process model having the given id.

Parameters:

modelId -

Returns:

the process model having the given id.

Throws:

ProcessManagerException

getCurrentRole

public String getCurrentRole()

Returns the current role name.

Returns:

resetCurrentRole

public void resetCurrentRole(String role)
                      throws ProcessManagerException

Returns the current role name.

Parameters:

role -

Throws:

ProcessManagerException

getUserRoleLabels

public NamedValue[] getUserRoleLabels()

Returns the user roles as a list of (name, label) pair.

getPresentationForm

public com.silverpeas.form.Form getPresentationForm()
                                             throws ProcessManagerException

Returns the form presenting the folder of the current process instance.

Throws:

ProcessManagerException

getFolderItems

public com.silverpeas.workflow.api.model.Item[] getFolderItems()
                                                        throws ProcessManagerException

Throws:

ProcessManagerException

getFolderRecord

public com.silverpeas.form.DataRecord getFolderRecord()
                                               throws ProcessManagerException

Returns the folder data of the current process instance.

Throws:

ProcessManagerException

getCreationTask

public com.silverpeas.workflow.api.task.Task getCreationTask()
                                                      throws ProcessManagerException

Returns the creation task.

Throws:

ProcessManagerException

getCreationForm

public com.silverpeas.form.Form getCreationForm()
                                         throws ProcessManagerException

Returns the form which starts a new instance.

Throws:

ProcessManagerException

getEmptyCreationRecord

public com.silverpeas.form.DataRecord getEmptyCreationRecord()
                                                      throws ProcessManagerException

Returns the an empty creation record which will be filled with the creation form.

Throws:

ProcessManagerException

getQuestionForm

public com.silverpeas.form.Form getQuestionForm(boolean readonly)
                                         throws ProcessManagerException

Returns the form to ask a question

Throws:

ProcessManagerException

getEmptyQuestionRecord

public com.silverpeas.form.DataRecord getEmptyQuestionRecord()
                                                      throws ProcessManagerException

Returns the an empty question record which will be filled with the question form.

Throws:

ProcessManagerException

getQuestion

public com.silverpeas.workflow.api.instance.Question getQuestion(String questionId)

get the question with the given id

Parameters:

questionId - question id

Returns:

the found question

getQuestionRecord

public com.silverpeas.form.DataRecord getQuestionRecord(String questionId)
                                                 throws ProcessManagerException

Returns the an empty question record which will be filled with the question form.

Throws:

ProcessManagerException

getAssignTemplate

public com.silverpeas.form.record.GenericRecordTemplate getAssignTemplate()
                                                                   throws ProcessManagerException

Get assign template (for the re-affectations)

Throws:

ProcessManagerException

getAssignForm

public com.silverpeas.form.Form getAssignForm()
                                       throws ProcessManagerException

Get assign form (for the re-affectations)

Throws:

ProcessManagerException

getAssignRecord

public com.silverpeas.form.DataRecord getAssignRecord()

Get assign data (for the re-affectations)

reAssign

public void reAssign(com.silverpeas.form.DataRecord data)
              throws ProcessManagerException

Get assign data (for the re-affectations)

Throws:

ProcessManagerException

createProcessInstance

public String createProcessInstance(com.silverpeas.form.DataRecord data,
                                    boolean isDraft,
                                    boolean firstTimeSaved)
                             throws ProcessManagerException

Create a new process instance with the filled form.

Parameters:

data - the form data

isDraft - true if form has just been saved as draft

firstTimeSaved - true if form is saved as draft for the first time

Throws:

ProcessManagerException

getTasks

public com.silverpeas.workflow.api.task.Task[] getTasks()
                                                 throws ProcessManagerException

Get all tasks assigned for current user on current process instance

Throws:

ProcessManagerException

getDeleteAction

public String[] getDeleteAction()

Search for an hypothetic action of kind "delete", allowed for the current user with the given role

Returns:

an array of 2 String { action.name, state.name }, null if no action found

getTask

public com.silverpeas.workflow.api.task.Task getTask(String stateName)
                                              throws ProcessManagerException

Returns the named task.

Throws:

ProcessManagerException

getPresentationForm

public com.silverpeas.form.Form getPresentationForm(String name)
                                             throws ProcessManagerException

Returns the named form (Read only). Throws an exception if the form is unknown.

Throws:

ProcessManagerException

getActionForm

public com.silverpeas.form.Form getActionForm(String stateName,
                                              String actionName)
                                       throws ProcessManagerException

Returns the form associated to the named action. Returns null if this action has no form. Throws an exception if the action is unknown.

Throws:

ProcessManagerException

getActionRecord

public com.silverpeas.form.DataRecord getActionRecord(String stateName,
                                                      String actionName)
                                               throws ProcessManagerException

Returns a new DataRecord filled whith the folder data and which will be be completed by the action form.

Throws:

ProcessManagerException

processAction

public void processAction(String stateName,
                          String actionName,
                          com.silverpeas.form.DataRecord data,
                          boolean isDraft,
                          boolean isFirstTimeSaved)
                   throws ProcessManagerException

Create a new history step instance with the filled form.

Throws:

ProcessManagerException

getStep

public com.silverpeas.workflow.api.instance.HistoryStep getStep(String stepId)

Returns the required step

processQuestion

public void processQuestion(String stepId,
                            String state,
                            com.silverpeas.form.DataRecord data)
                     throws ProcessManagerException

Send the question as a QuestionEvent to the workflowEngine.

Throws:

ProcessManagerException

processResponse

public void processResponse(String questionId,
                            com.silverpeas.form.DataRecord data)
                     throws ProcessManagerException

Send the answer as a ResponseEvent to the workflowEngine.

Throws:

ProcessManagerException

getLockingUsers

public List<LockVO> getLockingUsers()
                             throws ProcessManagerException

Get locking users list

Throws:

ProcessManagerException

lock

public void lock(String stateName)
          throws ProcessManagerException

Lock the current instance for current user and given state

Parameters:

stateName - state name

Throws:

ProcessManagerException

unlock

public void unlock(String userId,
                   String stateName)
            throws ProcessManagerException

Un-Lock the current instance for given user and given state

Parameters:

userId - user Id

stateName - state name

Throws:

ProcessManagerException

unlock

public void unlock(String stateName)
            throws ProcessManagerException

Un-Lock the current instance for current user and given state

Parameters:

stateName - state name

Throws:

ProcessManagerException

getSteps

public List<StepVO> getSteps(String strEnlightedStep)

getSortedHistorySteps

public com.silverpeas.workflow.api.instance.HistoryStep[] getSortedHistorySteps(boolean ascending)

isStepVisible

public boolean isStepVisible(com.silverpeas.workflow.api.instance.HistoryStep step)

getStepActor

public String getStepActor(com.silverpeas.workflow.api.instance.HistoryStep step)

Get the list of actors in History Step of current process instance

Returns:

an array of string containing actors full name

getStepAction

public String getStepAction(com.silverpeas.workflow.api.instance.HistoryStep step)

Get the list of actions in History Step of current process instance

Returns:

an array of string containing actions names

getStepForm

public com.silverpeas.form.Form getStepForm(com.silverpeas.workflow.api.instance.HistoryStep step)
                                     throws ProcessManagerException

Returns the form used to display the i-th step. Returns null if the step is unkwown.

Throws:

ProcessManagerException

getStepRecord

public com.silverpeas.form.DataRecord getStepRecord(com.silverpeas.workflow.api.instance.HistoryStep step)

Returns the data filled during the given step. Returns null if the step is unkwown.

getSavedStep

public com.silverpeas.workflow.api.instance.HistoryStep getSavedStep()
                                                              throws ProcessManagerException

Get step saved by given user id.

Throws:

ProcessManagerException

getSavedStepRecord

public com.silverpeas.form.DataRecord getSavedStepRecord(com.silverpeas.workflow.api.instance.HistoryStep savedStep)
                                                  throws ProcessManagerException

Get step data record saved.

Throws:

ProcessManagerException

ProcessManagerException

getPrintForm

public com.silverpeas.form.Form getPrintForm(javax.servlet.http.HttpServletRequest request)
                                      throws ProcessManagerException

Returns the form defined to print

Throws:

ProcessManagerException

getPrintRecord

public com.silverpeas.form.DataRecord getPrintRecord()
                                              throws ProcessManagerException

Returns the data of instance

Throws:

ProcessManagerException

getActionLabel

public String getActionLabel(String actionName)

Get the label of given action

Parameters:

actionName - action name

Returns:

action label

getState

public com.silverpeas.workflow.api.model.State getState(String stateName)

Get the state with the given name

Parameters:

stateName - state name

Returns:

State object

getAction

public com.silverpeas.workflow.api.model.Action getAction(String actionName)

Get the named action

Parameters:

actionName - action name

Returns:

action

hasPendingQuestions

public boolean hasPendingQuestions()

Tests if there is some question for current user in current processInstance

Returns:

true if there is one or more question

getUserSettingsForm

public com.silverpeas.form.Form getUserSettingsForm()
                                             throws ProcessManagerException

Returns the form to fill user settings

Throws:

ProcessManagerException

getEmptyUserSettingsRecord

public com.silverpeas.form.DataRecord getEmptyUserSettingsRecord()
                                                          throws ProcessManagerException

Returns the an empty date record which will be filled with the user settings form.

Throws:

ProcessManagerException

getUserSettingsRecord

public com.silverpeas.form.DataRecord getUserSettingsRecord()
                                                     throws ProcessManagerException

Returns the an empty data record which will be filled with the user settings form.

Throws:

ProcessManagerException

saveUserSettings

public void saveUserSettings(com.silverpeas.form.DataRecord data)
                      throws ProcessManagerException

Save the user settings which have been filled with the user settings form.

Throws:

ProcessManagerException

getCurrentFilter

public ProcessFilter getCurrentFilter()
                               throws ProcessManagerException

Returns the current ProcessFilter.

Throws:

ProcessManagerException

resetProcessFilter

public void resetProcessFilter()
                        throws ProcessManagerException

Reset the current ProcessFilter.

Throws:

ProcessManagerException

removeProcess

public void removeProcess(String processId)
                   throws ProcessManagerException

Remove process instance with given id

Throws:

ProcessManagerException

getProcessInstanceErrors

public com.silverpeas.workflow.api.error.WorkflowError[] getProcessInstanceErrors(String processId)
                                                                           throws ProcessManagerException

Get all the errors occured while processing the current process instance

Throws:

ProcessManagerException

isUserSettingsOK

public boolean isUserSettingsOK()

Returns true if : the user settings are correct

hasUserSettings

public boolean hasUserSettings()

Returns true if : the model has any user settings.

isVersionControlled

public boolean isVersionControlled()

isAttachmentTabEnable

public boolean isAttachmentTabEnable()

isProcessIdVisible

public boolean isProcessIdVisible()

isViewReturn

public boolean isViewReturn()

exportListAsCSV

public String exportListAsCSV()
                       throws ProcessManagerException

Throws:

ProcessManagerException

isCurrentUserIsLockingUser

public boolean isCurrentUserIsLockingUser()

Is current user is part of the locking users for current process instance ?

Returns:

true is current user is part of the locking users for current process instance

setResumingInstance

public void setResumingInstance(boolean isResumingInstance)

isResumingInstance

public boolean isResumingInstance()

getTrace

public String getTrace(String function,
                       String extraParam)

getCurrentTokenId

public String getCurrentTokenId()

Get the current tokenId. Token Id prevents users to use several windows with same session.

Returns:

the current token id

setCurrentTokenId

public void setCurrentTokenId(String newTokenId)

Set the current tokenId. Token Id prevents users to use several windows with same session.

Parameters:

newTokenId - the current token id