Package com.appiancorp.suiteapi.process
Class ProcessFacade
java.lang.Object
com.appiancorp.suiteapi.process.ProcessFacade
Utility methods dealing with processes
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ProcessDiagram
loadProcessDiagram
(Long processId_, int typeOfNotesToRetrieve_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static ProcessDiagram
loadProcessDiagram
(Long processId_, int typeOfNotesToRetrieve_, ServiceContext sc_) Loads a process diagram.static ProcessDiagram
saveProcessModelForProcess
(Long processId_, ProcessDiagram processDiagram_, ServiceContext sc_, Map notesMap_) Saves a process model for a process.
-
Constructor Details
-
ProcessFacade
public ProcessFacade()
-
-
Method Details
-
loadProcessDiagram
public static ProcessDiagram loadProcessDiagram(Long processId_, int typeOfNotesToRetrieve_, ServiceContext sc_) throws AppianException, Exception Loads a process diagram. This method acquires theProcessExecutionService
, callsProcessExecutionService.getProcessDiagram(java.lang.Long, int)
, and populates the assignee display names andAppianTypeCache
in the process diagram.- Parameters:
processId_
- id of process to load diagram fortypeOfNotesToRetrieve_
- This is one ofProcessExecutionService.RETRIEVE_PROCESS_MODEL_NOTES
orProcessExecutionService.RETRIEVE_PROCESS_NOTES
sc_
- the user's service context- Returns:
- the process diagram
- Throws:
InvalidProcessException
- If the process does not exist.PrivilegeException
- If the user does not have permissions to retrieve the process or the process diagram of the process.IllegalArgumentException
- iftypeOfNotesToRetrieve_
is invalidAppianException
Exception
- See Also:
-
loadProcessDiagram
@Deprecated public static ProcessDiagram loadProcessDiagram(Long processId_, int typeOfNotesToRetrieve_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) throws AppianException, Exception Deprecated.since 6.0.3Loads a process diagram. This method acquires theProcessExecutionService
, callsProcessExecutionService.getProcessDiagram(java.lang.Long, int)
, and populates the assignee display names andAppianTypeCache
in the process diagram.- Parameters:
processId_
- id of process to load diagram fortypeOfNotesToRetrieve_
- This is one ofProcessExecutionService.RETRIEVE_PROCESS_MODEL_NOTES
orProcessExecutionService.RETRIEVE_PROCESS_NOTES
sc_
- the user's service context- Returns:
- the process diagram
- Throws:
InvalidProcessException
- If the process does not exist.PrivilegeException
- If the user does not have permissions to retrieve the process or the process diagram of the process.IllegalArgumentException
- iftypeOfNotesToRetrieve_
is invalidAppianException
Exception
- See Also:
-
saveProcessModelForProcess
public static ProcessDiagram saveProcessModelForProcess(Long processId_, ProcessDiagram processDiagram_, ServiceContext sc_, Map notesMap_) throws AppianException Saves a process model for a process. This method simply acquires theProcessExecutionService
and callsProcessExecutionService.updateProcessModelForProcess(java.lang.Long, com.appiancorp.suiteapi.process.ProcessDiagram, com.appiancorp.suiteapi.process.ProcessModel[])
- Parameters:
processId_
- process to save toprocessDiagram_
- process diagram to savesc_
- service context of userchildProcessModels_
- the sub and linked process models for this updating process model- Throws:
InvalidProcessException
- if the process ID does not refer to a valid processPrivilegeException
- if the user does not have access to the process diagramServiceException
- if any system-level error occursInvalidArgumentException
- if the ProcessDiagram bean passed in has any nodes with non-null IDs that are not in the current version of theAppianException
- See Also:
-