# Index

C E F G H I L N O P R S U
All Classes and Interfaces|All Packages|Serialized Form

## C

clearFilter() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
computeDestination(String, ProcessManagerSessionController, HttpServletRequest, List<FileItem>) - Method in class org.silverpeas.processmanager.servlets.SessionSafeFunctionHandler
  Main scenario to be implemented by handler.
createComponentSessionController(MainSessionController, ComponentContext) - Method in class org.silverpeas.processmanager.servlets.ProcessManagerRequestRouter
  Return a new ProcessManagerSessionController which will be used for each request made in the given componentContext.
createProcessInstance(DataRecord, boolean, boolean) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Create a new process instance with the filled form.
CurrentState - Class in org.silverpeas.processmanager
CurrentState(State) - Constructor for class org.silverpeas.processmanager.CurrentState

## E

end() - Method in class org.silverpeas.processmanager.ReassignmentReport
end(WorkflowException) - Method in class org.silverpeas.processmanager.ReassignmentReport
  Reports end of reassignment processing with error.
equals(Object) - Method in class org.silverpeas.processmanager.NamedValue
exportListAsCSV() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController

## F

FunctionHandler - Interface in org.silverpeas.processmanager.servlets
  A function handler is associated to a peas function and is called by the request router when this function has to be processed.

## G

generateTokenId(ProcessManagerSessionController, HttpServletRequest) - Method in class org.silverpeas.processmanager.servlets.SessionSafeFunctionHandler
  Generate random UUID and store it in request as attribute and in process manager session controller
getAction(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get the named action
getActionForm(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the form associated to the named action.
getActionName() - Method in class org.silverpeas.processmanager.StepVO
getActionRecord(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns a new DataRecord filled with the folder data and which will be completed by the action form.
getActions() - Method in class org.silverpeas.processmanager.CurrentState
getActiveStates() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get the active states.
getActivity() - Method in class org.silverpeas.processmanager.StepVO
getActorFullName() - Method in class org.silverpeas.processmanager.StepVO
getAssignFormOfActiveStates(ProcessInstance) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Gets a form with the assignation of users to roles for all the active states (for the re-affectations of some roles in the active states)
getAssignRecordOfActiveStates(ProcessInstance) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Gets the assignation data of the users working on the active states (for the re-affectations of some roles in the active states).
getBackSteps() - Method in class org.silverpeas.processmanager.CurrentState
getComponentInstanceRoleLabels() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the component instance roles as a list of (name, label) pair.
getContent() - Method in class org.silverpeas.processmanager.StepVO
getCreationForm() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the form which starts a new instance.
getCreationRights() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get the creation rights
getCurrentAndNextUserReplacementsAsIncumbent() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Gets current and next replacements at date of day in which the current user can be replaced in the workflow.
getCurrentFilter() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the current ProcessFilter.
getCurrentProcessInstance() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get the current process instance
getCurrentProcessList() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the current process instance list.
getCurrentReplacement() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
getCurrentRole() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
getCurrentRoleLabel() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
getCurrentTokenId() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get the current tokenId.
getDeleteAction() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Search for a hypothetical action of kind "delete", allowed for the current user with the given role
getDestination(String, ProcessManagerSessionController, HttpServletRequest) - Method in interface org.silverpeas.processmanager.servlets.FunctionHandler
  Process the request and returns the response url.
getDestination(String, ProcessManagerSessionController, HttpServletRequest) - Method in class org.silverpeas.processmanager.servlets.SessionSafeFunctionHandler
getDestination(String, ProcessManagerSessionController, HttpRequest) - Method in class org.silverpeas.processmanager.servlets.ProcessManagerRequestRouter
  Process the request and returns the response url.
getEmptyCreationRecord() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns an empty creation record which will be filled with the creation form.
getEmptyQuestionRecord() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns an empty question record which will be filled with the question form.
getEmptyUserSettingsRecord() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns an empty date record which will be filled with the user settings form.
getFatalException() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the last fatal exception
getFolderItems() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
getFolderRecord() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the folder data of the current process instance.
getLabel() - Method in class org.silverpeas.processmanager.CurrentState
getLockDate() - Method in class org.silverpeas.processmanager.LockVO
getLockingUsers() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get locking users list
getName() - Method in class org.silverpeas.processmanager.CurrentState
getName() - Method in class org.silverpeas.processmanager.NamedValue
getNbEntriesAboutQuestions() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
getPresentationForm() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the form presenting the folder of the current process instance.
getPresentationForm(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the named form (Read only).
getProcessInstanceErrors(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get all the errors occurred while processing the current process instance
getProcessInstanceIdFromExternalTodoId(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get the process instance identifier referred by the todo with the given todo identifier.
getProcessListHeaders() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the current instance list rows template.
getProcessModel(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the process model having the given id.
getQuestion(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  get the question with the given id
getQuestionForm(boolean) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the form to ask a question
getQuestionRecord(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns an empty question record which will be filled with the question form.
getRoleNameFromExternalTodoId(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get the role name of task referred by the todo with the given todo id
getSavedStep() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get step saved by given user id.
getSavedStepRecord(HistoryStep) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get step data record saved.
getSessionControlBeanName() - Method in class org.silverpeas.processmanager.servlets.ProcessManagerRequestRouter
  Returns the name used by the ComponentRequestRequest to store the session controller in the user session.
getSortedHistorySteps(boolean) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
getState() - Method in class org.silverpeas.processmanager.LockVO
getState(ProcessInstance, String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get the state with the given name in the specified process instance.
getStep(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the required step
getStepAction(HistoryStep) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get the list of actions in History Step of current process instance
getStepActor(HistoryStep) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get the list of actors in History Step of current process instance
getStepDate() - Method in class org.silverpeas.processmanager.StepVO
getStepForm(HistoryStep) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the form used to display the i-th step.
getStepId() - Method in class org.silverpeas.processmanager.StepVO
getSteps(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
getStepSubstitute(HistoryStep) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
getSubstituteFullName() - Method in class org.silverpeas.processmanager.StepVO
getTask(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the named task.
getTasks() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Get all tasks assigned for current user on current process instance
getUser() - Method in class org.silverpeas.processmanager.LockVO
getUser(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the workflow user having the given id.
getUserRoleLabels() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the user roles as a list of (name, label) pair.
getUserSettingsForm() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the form to fill user settings
getUserSettingsRecord() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns an empty data record which will be filled with the user settings form.
getValue() - Method in class org.silverpeas.processmanager.NamedValue
getWorkingUsersAsString() - Method in class org.silverpeas.processmanager.CurrentState

## H

hashCode() - Method in class org.silverpeas.processmanager.NamedValue
hasPendingQuestions() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Tests if there is some question for current user in current processInstance
hasUserSettings() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns true if : the model has any user settings.

## I

init(ServletConfig) - Method in class org.silverpeas.processmanager.servlets.ProcessManagerRequestRouter
  Init this servlet, before any request.
isAttachmentTabEnabled() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
isCreationOne() - Method in class org.silverpeas.processmanager.NamedValue
isCSVExportEnabled() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
isCurrentUserIsLockingUser() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Is current user is part of the locking users for current process instance ?
isHistoryCanBeFiltered() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Is the history can be filtered?
isHistoryTabVisible() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
isPrintButtonEnabled() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Print button on an action can be disabled.
isProcessIdVisible() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
isRemovableBySupervisor() - Method in class org.silverpeas.processmanager.LockVO
isResumingInstance() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
isSaveButtonEnabled() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Save button on an action can be disabled.
isUserAllowedOnActiveStates() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
isUserSettingsOK() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns true if : the user settings are correct
isVersionControlled() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
isViewReturn() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
isVisible() - Method in class org.silverpeas.processmanager.StepVO

## L

lock(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Lock the current instance for current user and given state
LockVO - Class in org.silverpeas.processmanager
  A LockVO represents a lock let by a user.
LockVO(User, Date, String, boolean) - Constructor for class org.silverpeas.processmanager.LockVO

## N

NamedValue - Class in org.silverpeas.processmanager
  A named value pair.

## O

org.silverpeas.processmanager - package org.silverpeas.processmanager
org.silverpeas.processmanager.servlets - package org.silverpeas.processmanager.servlets

## P

processAction(String, String, DataRecord, boolean, boolean) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Create a new history step instance with the filled form.
ProcessManagerRequestRouter - Class in org.silverpeas.processmanager.servlets
ProcessManagerRequestRouter() - Constructor for class org.silverpeas.processmanager.servlets.ProcessManagerRequestRouter
ProcessManagerSessionController - Class in org.silverpeas.processmanager
  The ProcessManager Session controller
ProcessManagerSessionController(MainSessionController, ComponentContext) - Constructor for class org.silverpeas.processmanager.ProcessManagerSessionController
  Builds and init a new session controller for the process manager instance.
ProcessManagerSessionController(MainSessionController, ComponentContext, ProcessManagerException) - Constructor for class org.silverpeas.processmanager.ProcessManagerSessionController
  Builds a session controller.
processQuestion(String, String, DataRecord) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Send the question as a QuestionEvent to the workflowEngine.
processResponse(String, DataRecord) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Send the answer as a ResponseEvent to the workflowEngine.

## R

reassignInActiveStates(ProcessInstance, DataRecord) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Reassign the roles in the active states of the specified process instance to the users defined in the given assignation data.
ReassignmentReport - Class in org.silverpeas.processmanager
  This class allows to write reporting about reassignment processes.
ReassignmentReport(ProcessManagerSessionController, String, String) - Constructor for class org.silverpeas.processmanager.ReassignmentReport
removeProcess(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Remove process instance with given id
replaceInAllAssignedStates(String, String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Replaces the specified user by the other one in all the states of the current process instances.
resetCreationRights() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Compute the creation rights set creationRight to true if user can do the "Creation" action
resetCurrentProcessInstance() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Set current Process instance to null
resetCurrentProcessInstance(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Updates the current process instance from the given id and returns the associated ProcessInstance object.
resetCurrentProcessList(boolean) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Updates the current process instance list with current filter and returns this list.
resetCurrentProcessListHeaders() - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Reset the current instance list rows template.
resetCurrentRole(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Returns the current role name.
resetCurrentRoleAsSubstitute(String, String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
resetTokenId(ProcessManagerSessionController, HttpServletRequest) - Method in class org.silverpeas.processmanager.servlets.SessionSafeFunctionHandler
  Reset token identifier.

## S

saveUserSettings(DataRecord) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Save the user settings which have been filled with the user settings form.
SessionSafeFunctionHandler - Class in org.silverpeas.processmanager.servlets
  A SessionSafeFunctionHandler must be used to prevent conflicts in HTTP Session when user navigate using several windows sharing the same session.
SessionSafeFunctionHandler() - Constructor for class org.silverpeas.processmanager.servlets.SessionSafeFunctionHandler
setActionName(String) - Method in class org.silverpeas.processmanager.StepVO
setActivity(String) - Method in class org.silverpeas.processmanager.StepVO
setActorFullName(String) - Method in class org.silverpeas.processmanager.StepVO
setContent(HistoryStepContent) - Method in class org.silverpeas.processmanager.StepVO
setCurrentTokenId(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Set the current tokenId.
setLabel(String) - Method in class org.silverpeas.processmanager.CurrentState
setLockDate(Date) - Method in class org.silverpeas.processmanager.LockVO
setRemovableBySupervisor(boolean) - Method in class org.silverpeas.processmanager.LockVO
setResumingInstance(boolean) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
setState(String) - Method in class org.silverpeas.processmanager.LockVO
setStepDate(String) - Method in class org.silverpeas.processmanager.StepVO
setStepId(String) - Method in class org.silverpeas.processmanager.StepVO
setSubstituteFullName(String) - Method in class org.silverpeas.processmanager.StepVO
setTasks(List<Task>) - Method in class org.silverpeas.processmanager.CurrentState
setUser(User) - Method in class org.silverpeas.processmanager.LockVO
setVisible(boolean) - Method in class org.silverpeas.processmanager.StepVO
setWorkingUsersAsString(String) - Method in class org.silverpeas.processmanager.CurrentState
start() - Method in class org.silverpeas.processmanager.ReassignmentReport
  Reports start of the reassignment processing.
StepVO - Class in org.silverpeas.processmanager
StepVO() - Constructor for class org.silverpeas.processmanager.StepVO

## U

unlock(String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Un-Lock the current instance for current user and given state
unlock(String, String) - Method in class org.silverpeas.processmanager.ProcessManagerSessionController
  Un-Lock the current instance for given user and given state

C E F G H I L N O P R S U
All Classes and Interfaces|All Packages|Serialized Form