com.appiancorp.suiteapi.process

Class ProcessFacade

java.lang.Object

com.appiancorp.suiteapi.process.ProcessFacade

public class ProcessFacade
extends java.lang.Object

Utility methods dealing with processes

Constructor Summary

Constructors

Constructor and Description
ProcessFacade()

Method Summary

Modifier and Type	Method and Description
static ProcessDiagram	loadProcessDiagram(java.lang.Long processId_, int typeOfNotesToRetrieve_, ServiceContext sc_) Loads a process diagram.
static ProcessDiagram	loadProcessDiagram(java.lang.Long processId_, int typeOfNotesToRetrieve_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static ProcessDiagram	saveProcessModelForProcess(java.lang.Long processId_, ProcessDiagram processDiagram_, ServiceContext sc_, java.util.Map notesMap_) Saves a process model for a process.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessFacade

public ProcessFacade()

Method Detail

loadProcessDiagram

public static ProcessDiagram loadProcessDiagram(java.lang.Long processId_,
                                                int typeOfNotesToRetrieve_,
                                                ServiceContext sc_)
                                         throws AppianException,
                                                java.lang.Exception

Loads a process diagram. This method acquires the ProcessExecutionService, calls ProcessExecutionService.getProcessDiagram(java.lang.Long, int), and populates the assignee display names and AppianTypeCache in the process diagram.

Parameters:

processId_ - id of process to load diagram for

typeOfNotesToRetrieve_ - This is one of ProcessExecutionService.RETRIEVE_PROCESS_MODEL_NOTES or ProcessExecutionService.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.

java.lang.IllegalArgumentException - if typeOfNotesToRetrieve_ is invalid

AppianException

java.lang.Exception

See Also:

ProcessModelFacade.fillInAssigneeDisplayNames(com.appiancorp.suiteapi.process.ProcessModel, com.appiancorp.asl3.servicefw.connect.ServiceContext), ProcessDiagram.fillInAppianTypes(com.appiancorp.suiteapi.process.AppianTypeCache)

loadProcessDiagram

@Deprecated
public static ProcessDiagram loadProcessDiagram(java.lang.Long processId_,
                                                            int typeOfNotesToRetrieve_,
                                                            com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                                     throws AppianException,
                                                            java.lang.Exception

Deprecated. since 6.0.3

Loads a process diagram. This method acquires the ProcessExecutionService, calls ProcessExecutionService.getProcessDiagram(java.lang.Long, int), and populates the assignee display names and AppianTypeCache in the process diagram.

Parameters:

processId_ - id of process to load diagram for

typeOfNotesToRetrieve_ - This is one of ProcessExecutionService.RETRIEVE_PROCESS_MODEL_NOTES or ProcessExecutionService.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.

java.lang.IllegalArgumentException - if typeOfNotesToRetrieve_ is invalid

AppianException

java.lang.Exception

See Also:

ProcessModelFacade.fillInAssigneeDisplayNames(com.appiancorp.suiteapi.process.ProcessModel, com.appiancorp.asl3.servicefw.connect.ServiceContext), ProcessDiagram.fillInAppianTypes(com.appiancorp.suiteapi.process.AppianTypeCache)

saveProcessModelForProcess

public static ProcessDiagram saveProcessModelForProcess(java.lang.Long processId_,
                                                        ProcessDiagram processDiagram_,
                                                        ServiceContext sc_,
                                                        java.util.Map notesMap_)
                                                 throws AppianException

Saves a process model for a process. This method simply acquires the ProcessExecutionService and calls ProcessExecutionService.updateProcessModelForProcess(java.lang.Long, com.appiancorp.suiteapi.process.ProcessDiagram, com.appiancorp.suiteapi.process.ProcessModel[])

Parameters:

processId_ - process to save to

processDiagram_ - process diagram to save

sc_ - service context of user

childProcessModels_ - the sub and linked process models for this updating process model

Throws:

InvalidProcessException - if the process ID does not refer to a valid process

PrivilegeException - if the user does not have access to the process diagram

ServiceException - if any system-level error occurs

InvalidArgumentException - if the ProcessDiagram bean passed in has any nodes with non-null IDs that are not in the current version of the

AppianException

See Also:

ProcessExecutionService.updateProcessModelForProcess(java.lang.Long, com.appiancorp.suiteapi.process.ProcessDiagram, com.appiancorp.suiteapi.process.ProcessModel[])