com.appiancorp.suiteapi.process

Class ProcessModelFacade

java.lang.Object

com.appiancorp.suiteapi.process.ProcessModelFacade

public class ProcessModelFacade
extends java.lang.Object

Manages the loading and storing and other utility functions of process models.

Constructor Summary

Constructors

Constructor and Description
ProcessModelFacade()

Method Summary

Modifier and Type	Method and Description
static void	clearProcessDiagramNoteIds(ProcessDiagram pd_)
static ProcessModel	createProcessModel(ProcessModel pm, ServiceContext sc) Creates a process model in the database.
static ProcessModel	createProcessModel(ProcessModel pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static void	fillInAssigneeDisplayNames(ProcessModel pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. Assignee display names will be populated automatically by the AppianTypeCache
static com.appiancorp.process.design.validation.Errors	getErrorsForParentsOfProcessModel(java.lang.Long pmId_, ServiceContext sc_) Gets errors associated with the given process model having parents
static com.appiancorp.process.design.validation.Errors	getErrorsForParentsOfProcessModel(java.lang.Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static com.appiancorp.process.design.validation.Errors	getErrorsForParentsOfUnpublishedChildren(java.lang.Long pmId_, ServiceContext sc_) Gets errors associated with the parents of unpublished proecss models for a process model
static com.appiancorp.process.design.validation.Errors	getErrorsForParentsOfUnpublishedChildren(java.lang.Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static com.appiancorp.process.design.validation.Errors	getErrorsForUnpublishedChildren(java.lang.Long pmId_, ServiceContext sc_) Gets errors for a process model if it has unpublished child processes
static com.appiancorp.process.design.validation.Errors	getErrorsForUnpublishedChildren(java.lang.Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static java.util.Map	getNotesFromProcessModel(ProcessDiagram pm_) Gets note from a process model
static java.util.Map	getNotesFromProcessModel(ProcessModel pm_)
static Note[]	getNotesWithContent(Note[] notes_, ServiceContext sc_)
static Note[]	getNotesWithContent(Note[] notes_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static ProcessVariable[]	getProcessParameters(java.lang.Long pmId, ServiceContext sc) Retrieve the process parameters used to start of the process model of the given ID
static ProcessVariable[]	getProcessParameters(java.lang.Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static int	getRecursiveRelationship(java.lang.Long pmId, java.lang.Long subPmId, ServiceContext sc) Returns that status of the recursive relationship between the two supplied ProcessModels
static int	getRecursiveRelationship(java.lang.Long pmId_, java.lang.Long subPmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static ProcessVariable[]	getVisibleProcessVariables(java.lang.Long pmId, ServiceContext sc) Retrieve all visible process variables used in the process model given
static ProcessVariable[]	getVisibleProcessVariables(java.lang.Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static com.appiancorp.process.design.validation.Errors	handleProcessModelErrors(java.lang.String[] errors_)
static com.appiancorp.process.design.validation.Errors	handleProcessModelErrors(java.lang.String[] errors_, com.appiancorp.process.design.validation.Errors err_) Creates Errors from list of String arrays from validateProcessModel(AbstractProcessModel,ServiceContext)
static ProcessModel	loadLatestPublishVersionOfProcessModel(java.lang.Long pmId_, ServiceContext sc_) Loads the latest published version of the process model or the draft if there is no published version from the database.
static ProcessModel	loadLatestPublishVersionOfProcessModel(java.lang.Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static ProcessModel	loadProcessModel(java.lang.Long pmId, ServiceContext sc) Loads the working draft of a process model from the database.
static ProcessModel	loadProcessModel(java.lang.Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static ProcessModel	loadProcessModelVersion(java.lang.Long pmId_, java.lang.String version_, ServiceContext sc_) Loads a process model version from the database.
static ProcessModel	loadProcessModelVersion(java.lang.Long pmId_, java.lang.String version_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static void	lockProcessModel(java.lang.Long pmId, boolean overrideLock, ServiceContext sc) Locks the process model pmId_, overrides the lock of a previous user if overrideLock is true
static void	lockProcessModel(java.lang.Long pmId_, boolean overrideLock_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static ProcessModel	saveProcessModel(ProcessModel pm, ServiceContext sc) Saves a process model in the database.
static ProcessModel	saveProcessModel(ProcessModel pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static void	saveProcessModelAndNodeNotes(java.util.Map allNotes_, ProcessDiagram newModel_, ServiceContext sc_)
static void	saveProcessModelAndNodeNotes(java.util.Map allNotes_, ProcessDiagram newModel_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static void	saveProcessModelAndNodeNotes(java.util.Map allNotes_, ProcessModel newModel_, ServiceContext sc_) Saves the notes for a process model and nodes
static void	saveProcessModelAndNodeNotes(java.util.Map allNotes_, ProcessModel newModel_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static void	unlockProcessModel(java.lang.Long pmId_, ServiceContext sc_) Unlocks a process model
static void	unlockProcessModel(java.lang.Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static void	updateProcessModelWithMapNotesContent(java.util.Map notesMap_, ProcessModel pm_) reinserts notes content into pm from the given map
static void	updateProcessModelWithNotesContent(ProcessDiagram pm_) Deprecated. use updateProcessModelWithNotesContent(ProcessDiagram, ServiceContext)
static void	updateProcessModelWithNotesContent(ProcessDiagram pm_, ServiceContext sc_)
static void	updateProcessModelWithNotesContent(ProcessDiagram pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static void	updateProcessModelWithNotesContent(ProcessModel pm_) Deprecated. use updateProcessModelWithNotesContent(ProcessModel, ServiceContext)
static void	updateProcessModelWithNotesContent(ProcessModel pm_, ServiceContext sc_) Inserts note values from the file system into the process model
static void	updateProcessModelWithNotesContent(ProcessModel pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static com.appiancorp.process.design.validation.Errors	validateAdminConfigSettings(com.appiancorp.process.design.validation.Errors err_, java.lang.String... errors_)
static void	validateAndSetPvDefaults(ProcessModel pm_)
static com.appiancorp.process.design.validation.Errors	validateCallIntegrationInformation(com.appiancorp.process.design.validation.Errors err_, java.lang.String... errors_)
static com.appiancorp.process.design.validation.Errors	validateExecuteRoboticProcess(com.appiancorp.process.design.validation.Errors err_, java.lang.String... errors_)
static com.appiancorp.process.design.validation.Errors	validateInterfaceInformation(com.appiancorp.process.design.validation.Errors err_, java.lang.String... errors_) Create Interface Information Errors from list of String arrays and adds them to the passed in Errors list.
static com.appiancorp.process.design.validation.Errors	validateOtherErrors(java.lang.String[] errors_, com.appiancorp.process.design.validation.Errors err_)
static java.lang.String[]	validateProcessModel(AbstractProcessModel apm_, ServiceContext sc_) Validates the process model
static java.lang.String[]	validateProcessModel(AbstractProcessModel apm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3
static com.appiancorp.process.design.validation.Errors	validateProcessModelExpressions(java.lang.String[] errors_) Creates Invalid Expression Errors from list of String arrays from validateProcessModel(AbstractProcessModel,ServiceContext)
static com.appiancorp.process.design.validation.Errors	validateProcessModelExpressions(java.lang.String[] errors_, com.appiancorp.process.design.validation.Errors err_) Creates Invalid Expression Errors from list of String arrays from validateProcessModel(AbstractProcessModel,ServiceContext) and adds them to the passed in errors list
static com.appiancorp.process.design.validation.Errors	validateSubProcessModels(java.lang.String[] errors_) Creates Invalid Subprocess Model Errors from list of String arrays from validateProcessModel(AbstractProcessModel,ServiceContext)
static com.appiancorp.process.design.validation.Errors	validateSubProcessModels(java.lang.String[] errors_, com.appiancorp.process.design.validation.Errors err_) Creates Invalid Subprocess Model Errors from list of String arrays from validateProcessModel(AbstractProcessModel,ServiceContext) and adds them to the passed in errors list
static com.appiancorp.process.design.validation.Errors	validateWriteRecordsWithEvents(com.appiancorp.process.design.validation.Errors modelErrors, java.lang.String... errorMessages) Adds any errors related to the Write Records v2 node to the Errors object.
static ProcessModel	versionProcessModel(ProcessDiagram pd_, ServiceContext sc_, java.util.Map notesMap_)
static ProcessModel	versionProcessModel(ProcessDiagram pd_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_, java.util.Map notesMap_) Deprecated. since 6.0.3
static ProcessModel	versionProcessModel(ProcessModel pm_, ServiceContext sc_, java.util.Map notesMap_) Versions a process model in the database.
static ProcessModel	versionProcessModel(ProcessModel pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_, java.util.Map notesMap_) Deprecated. since 6.0.3

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessModelFacade

public ProcessModelFacade()

Method Detail

createProcessModel

public static ProcessModel createProcessModel(ProcessModel pm,
                                              ServiceContext sc)
                                       throws InvalidUserException,
                                              PrivilegeException,
                                              InvalidFolderException,
                                              InvalidPriorityException,
                                              DuplicateUuidException

Creates a process model in the database.

Parameters:

pm - a process model to be saved.

sc - the service context of the user making this call

Returns:

the saved process model, with all of its primary keys filled in. Also, any Appian-typed objects will have display names filled in in its AppianTypeCache

Throws:

PrivilegeException - if the current user does not have permission to perform this action

InvalidFolderException - if the ProcessModelFolder does not exist

InvalidPriorityException - if the Priority does not exist

InvalidUserException - if any user referenced in the ProcessModel does not exist

DuplicateUuidException

createProcessModel

@Deprecated
public static ProcessModel createProcessModel(ProcessModel pm_,
                                                          com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                                   throws InvalidUserException,
                                                          PrivilegeException,
                                                          InvalidFolderException,
                                                          InvalidPriorityException,
                                                          DuplicateUuidException

Deprecated. since 6.0.3

Creates a process model in the database.

Parameters:

pm_ - a process model to be saved.

sc_ - the service context of the user making this call

Returns:

the saved process model, with all of its primary keys filled in. Also, any Appian-typed objects will have display names filled in in its AppianTypeCache

Throws:

PrivilegeException - if the current user does not have permission to perform this action

InvalidFolderException - if the ProcessModelFolder does not exist

InvalidPriorityException - if the Priority does not exist

InvalidUserException - if any user referenced in the ProcessModel does not exist

DuplicateUuidException

saveProcessModel

public static ProcessModel saveProcessModel(ProcessModel pm,
                                            ServiceContext sc)
                                     throws AppianException,
                                            ServiceException

Saves a process model in the database. If the process model ID is negative, a new process model will be created; otherwise, the process model will be updated

Parameters:

pm - a process model to be saved.

sc - the service context of the user making this call

Returns:

the saved process model, with all of its primary keys filled in. Also, any Appian-typed objects will have display names filled in in its AppianTypeCache

Throws:

InvalidUuidException - if the process model cannot be found by the UUID

InvalidProcessModelException - if the process model does not exist

PrivilegeException - if the user does not have privileges to update the process model

LockException - if the process model is locked by someone other than the current user

InvalidUserException - if any user referenced in the ProcessModel does not exist

ServiceException - if anything else goes wrong

AppianException

saveProcessModel

@Deprecated
public static ProcessModel saveProcessModel(ProcessModel pm_,
                                                        com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                                 throws AppianException,
                                                        ServiceException

Deprecated. since 6.0.3

Saves a process model in the database. If the process model ID is negative, a new process model will be created; otherwise, the process model will be updated

Parameters:

pm_ - a process model to be saved.

sc_ - the service context of the user making this call

Returns:

the saved process model, with all of its primary keys filled in. Also, any Appian-typed objects will have display names filled in in its AppianTypeCache

Throws:

InvalidUuidException - if the process model cannot be found by the UUID

InvalidProcessModelException - if the process model does not exist

PrivilegeException - if the user does not have privileges to update the process model

LockException - if the process model is locked by someone other than the current user

InvalidUserException - if any user referenced in the ProcessModel does not exist

ServiceException - if anything else goes wrong

AppianException

loadProcessModel

public static ProcessModel loadProcessModel(java.lang.Long pmId,
                                            ServiceContext sc)
                                     throws ServiceException,
                                            AppianException

Loads the working draft of a process model from the database.

Parameters:

pmId - primary key of a process model in the database.

sc - the service context of the user making this call

Returns:

the loaded process model with any Appian-typed object display names filled in in its AppianTypeCache

Throws:

PrivilegeException - if the user does not have permission to view the process model. See ProcessDesignService.getProcessModel(Long)

InvalidProcessModelException - if the ID does not refer to a valid process model

ServiceException - if anything else goes wrong

AppianException

loadProcessModel

@Deprecated
public static ProcessModel loadProcessModel(java.lang.Long pmId_,
                                                        com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                                 throws ServiceException,
                                                        AppianException

Deprecated. since 6.0.3

Loads the working drafy of a process model from the database.

Parameters:

pmId_ - primary key of a process model in the database.

sc_ - the service context of the user making this call

Returns:

the loaded process model with any Appian-typed object display names filled in in its AppianTypeCache

Throws:

PrivilegeException - if the user does not have permission to view the process model. See ProcessDesignService.getProcessModel(Long)

InvalidProcessModelException - if the ID does not refer to a valid process model

ServiceException - if naything else goes wrong

AppianException

loadLatestPublishVersionOfProcessModel

public static ProcessModel loadLatestPublishVersionOfProcessModel(java.lang.Long pmId_,
                                                                  ServiceContext sc_)
                                                           throws ServiceException,
                                                                  AppianException

Loads the latest published version of the process model or the draft if there is no published version from the database.

Parameters:

pmId_ - primary key of a process model in the database.

sc_ - the service context of the user making this call

Returns:

the loaded process model with any Appian-typed object display names filled in in its AppianTypeCache

Throws:

InvalidProcessModelException - if the ID does not refer to a valid process model

PrivilegeException - if the user does not have permission to view the process model. See ProcessDesignService.getProcessModel(Long)

ServiceException - if naything else goes wrong

AppianException

loadLatestPublishVersionOfProcessModel

@Deprecated
public static ProcessModel loadLatestPublishVersionOfProcessModel(java.lang.Long pmId_,
                                                                              com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                                                       throws ServiceException,
                                                                              AppianException

Deprecated. since 6.0.3

Loads the latest published version of the process model or the draft if there is no published version from the database.

Parameters:

pmId_ - primary key of a process model in the database.

sc_ - the service context of the user making this call

Returns:

the loaded process model with any Appian-typed object display names filled in in its AppianTypeCache

Throws:

InvalidProcessModelException - if the ID does not refer to a valid process model

PrivilegeException - if the user does not have permission to view the process model. See ProcessDesignService.getProcessModel(Long)

ServiceException - if naything else goes wrong

AppianException

getProcessParameters

public static ProcessVariable[] getProcessParameters(java.lang.Long pmId,
                                                     ServiceContext sc)
                                              throws ServiceException

Retrieve the process parameters used to start of the process model of the given ID

Parameters:

pmId - process model id to retrieve variables for

sc - the service context of the user making this call

Returns:

All process parameters entered when starting the process model with the given ID

Throws:

ServiceException - if anything goes wrong

getProcessParameters

@Deprecated
public static ProcessVariable[] getProcessParameters(java.lang.Long pmId_,
                                                                 com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                                          throws ServiceException

Deprecated. since 6.0.3

Retrieve the process parameters used to start of the process model of the given ID

Parameters:

pmId_ - process model id to retrieve variables for

sc_ - the service context of the user making this call

Returns:

All process parameters entered when starting the process model with the given ID

Throws:

ServiceException - if anything goes wrong

getVisibleProcessVariables

public static ProcessVariable[] getVisibleProcessVariables(java.lang.Long pmId,
                                                           ServiceContext sc)
                                                    throws ServiceException

Retrieve all visible process variables used in the process model given

Parameters:

pmId - process model id to retrieve variables for

sc - the service context of the user making this call

Returns:

all visible variables within the process model given

Throws:

ServiceException - if anything goes wrong

getVisibleProcessVariables

@Deprecated
public static ProcessVariable[] getVisibleProcessVariables(java.lang.Long pmId_,
                                                                       com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                                                throws ServiceException

Deprecated. since 6.0.3

Retrieve all visible process variables used in the process model given

Parameters:

pmId_ - process model id to retrieve variables for

sc_ - the service context of the user making this call

Returns:

all visible variables within the process model given

Throws:

ServiceException - if anything goes wrong

getRecursiveRelationship

public static int getRecursiveRelationship(java.lang.Long pmId,
                                           java.lang.Long subPmId,
                                           ServiceContext sc)
                                    throws ServiceException

Returns that status of the recursive relationship between the two supplied ProcessModels

Parameters:

pmId - parent process id

subPmId - sub parent process id

sc - the service context of the user making this call

Returns:

the int value associated with the recursive relationship status

Throws:

ServiceException - if anything goes wrong

See Also:

ProcessDesignService.getRecursiveRelationship(Long,Long)

getRecursiveRelationship

@Deprecated
public static int getRecursiveRelationship(java.lang.Long pmId_,
                                                       java.lang.Long subPmId_,
                                                       com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                                throws ServiceException

Deprecated. since 6.0.3

Returns that status of the recursive relationship between the two supplied ProcessModels

Parameters:

pmId_ - parent process id

subPmId_ - sub parent process id

sc_ - the service context of the user making this call

Returns:

the int value associated with the recursive relationship status

Throws:

ServiceException - if anything goes wrong

See Also:

ProcessDesignService.getRecursiveRelationship(Long,Long)

fillInAssigneeDisplayNames

@Deprecated
public static void fillInAssigneeDisplayNames(ProcessModel pm_,
                                                          com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                                   throws InvalidUserException,
                                                          InvalidGroupException

Deprecated. Assignee display names will be populated automatically by the AppianTypeCache

Fills in all appian type display names for a process model

Parameters:

pm_ - the process model to fill in the appian types for

sc_ - the current user's service context

Throws:

InvalidUserException - if the process model contains any usernames that do not refer to valid users

InvalidGroupException - if the process model contains any group IDs that do not refer to valid groups

lockProcessModel

public static void lockProcessModel(java.lang.Long pmId,
                                    boolean overrideLock,
                                    ServiceContext sc)
                             throws ServiceException,
                                    AppianException

Locks the process model pmId_, overrides the lock of a previous user if overrideLock is true

Parameters:

pmId - id of process model to lock

overrideLock - whether or not to override another user's lock

sc - the current user's service context

Throws:

LockException - if the process model is already locked and override was not true

PrivilegeException - if the user does not have access to lock (or override, if specified) the process model See ProcessDesignService.lockProcessModel(Long,boolean)

ServiceException - if any other error occurs

AppianException

lockProcessModel

@Deprecated
public static void lockProcessModel(java.lang.Long pmId_,
                                                boolean overrideLock_,
                                                com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                         throws ServiceException,
                                                AppianException

Deprecated. since 6.0.3

Locks the process model pmId_, overrides the lock of a previous user if overrideLock is true

Parameters:

pmId_ - id of process model to lock

overrideLock_ - whether or not to override another user's lock

sc_ - the current user's service context

Throws:

LockException - if the process model is already locked and override was not true

PrivilegeException - if the user does not have access to lock (or override, if specified) the process model See ProcessDesignService.lockProcessModel(Long,boolean)

ServiceException - if any other error occurs

AppianException

loadProcessModelVersion

public static ProcessModel loadProcessModelVersion(java.lang.Long pmId_,
                                                   java.lang.String version_,
                                                   ServiceContext sc_)
                                            throws AppianException,
                                                   ServiceException

Loads a process model version from the database.

Parameters:

pmId_ - the id of a process model in the database.

version_ - version of the process model to load.

sc_ - the current user's service context

Returns:

the loaded process model with any Appian-typed object display names filled in in its AppianTypeCache

Throws:

AppianException

ServiceException

loadProcessModelVersion

@Deprecated
public static ProcessModel loadProcessModelVersion(java.lang.Long pmId_,
                                                               java.lang.String version_,
                                                               com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                                        throws AppianException,
                                                               ServiceException

Deprecated. since 6.0.3

Loads a process model version from the database.

Parameters:

pmId_ - the id of a process model in the database.

version_ - version of the process model to load.

sc_ - the current user's service context

Returns:

the loaded process model with any Appian-typed object display names filled in in its AppianTypeCache

Throws:

AppianException

ServiceException

versionProcessModel

public static ProcessModel versionProcessModel(ProcessModel pm_,
                                               ServiceContext sc_,
                                               java.util.Map notesMap_)
                                        throws ServiceException,
                                               AppianException

Versions a process model in the database.

Parameters:

pm_ - a process model to be versioned.

sc_ - the service context of the user on behalf of whom this request is made.

Returns:

the versioned process model, with all of its primary keys filled in. Also, any Appian-typed objects will have display names filled in in its AppianTypeCache

Throws:

ServiceException

AppianException

versionProcessModel

@Deprecated
public static ProcessModel versionProcessModel(ProcessModel pm_,
                                                           com.appiancorp.asl3.servicefw.connect.ServiceContext sc_,
                                                           java.util.Map notesMap_)
                                                    throws ServiceException,
                                                           AppianException

Deprecated. since 6.0.3

Versions a process model in the database.

Parameters:

pm_ - a process model to be versioned.

sc_ - the service context of the user on behalf of whom this request is made.

Returns:

the versioned process model, with all of its primary keys filled in. Also, any Appian-typed objects will have display names filled in in its AppianTypeCache

Throws:

ServiceException

AppianException

versionProcessModel

public static ProcessModel versionProcessModel(ProcessDiagram pd_,
                                               ServiceContext sc_,
                                               java.util.Map notesMap_)
                                        throws ServiceException,
                                               AppianException

Parameters:

pd_ -

sc_ -

notesMap_ -

Returns:

Throws:

ServiceException

AppianException

AppianException

versionProcessModel

@Deprecated
public static ProcessModel versionProcessModel(ProcessDiagram pd_,
                                                           com.appiancorp.asl3.servicefw.connect.ServiceContext sc_,
                                                           java.util.Map notesMap_)
                                                    throws ServiceException,
                                                           AppianException

Deprecated. since 6.0.3

Parameters:

pd_ -

sc_ -

notesMap_ -

Returns:

Throws:

ServiceException

AppianException

clearProcessDiagramNoteIds

public static void clearProcessDiagramNoteIds(ProcessDiagram pd_)

unlockProcessModel

public static void unlockProcessModel(java.lang.Long pmId_,
                                      ServiceContext sc_)

Unlocks a process model

Parameters:

pmId_ - the id of the process model to unlock

sc_ - the current user's service context

unlockProcessModel

@Deprecated
public static void unlockProcessModel(java.lang.Long pmId_,
                                                  com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)

Deprecated. since 6.0.3

Unlocks a process model

Parameters:

pmId_ - the id of the process model to unlock

sc_ - the current user's service context

saveProcessModelAndNodeNotes

public static final void saveProcessModelAndNodeNotes(java.util.Map allNotes_,
                                                      ProcessModel newModel_,
                                                      ServiceContext sc_)

Saves the notes for a process model and nodes

Parameters:

allNotes_ - a map containing all the notes

newModel_ - the new model to save the notes for

sc_ - the current user's service context

saveProcessModelAndNodeNotes

@Deprecated
public static final void saveProcessModelAndNodeNotes(java.util.Map allNotes_,
                                                                  ProcessModel newModel_,
                                                                  com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)

Deprecated. since 6.0.3

Saves the notes for a process model and nodes

Parameters:

allNotes_ - a map containing all the notes

newModel_ - the new model to save the notes for

sc_ - the current user's service context

saveProcessModelAndNodeNotes

public static final void saveProcessModelAndNodeNotes(java.util.Map allNotes_,
                                                      ProcessDiagram newModel_,
                                                      ServiceContext sc_)

Parameters:

allNotes_ -

newModel_ -

sc_ -

saveProcessModelAndNodeNotes

@Deprecated
public static final void saveProcessModelAndNodeNotes(java.util.Map allNotes_,
                                                                  ProcessDiagram newModel_,
                                                                  com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)

Deprecated. since 6.0.3

Parameters:

allNotes_ -

newModel_ -

sc_ -

getNotesFromProcessModel

public static java.util.Map getNotesFromProcessModel(ProcessDiagram pm_)

Gets note from a process model

Parameters:

pm_ - the process model to get the notes from

Returns:

A Map of the notes retrieved

getNotesFromProcessModel

public static java.util.Map getNotesFromProcessModel(ProcessModel pm_)

updateProcessModelWithMapNotesContent

public static void updateProcessModelWithMapNotesContent(java.util.Map notesMap_,
                                                         ProcessModel pm_)

reinserts notes content into pm from the given map

Parameters:

notesMap_ - map containing note content for the given pm

pm_ - pm to insert note content into

updateProcessModelWithNotesContent

@Deprecated
public static void updateProcessModelWithNotesContent(ProcessModel pm_)

Deprecated. use updateProcessModelWithNotesContent(ProcessModel, ServiceContext)

Inserts note values from the file system into the process model

Parameters:

pm_ - process model to insert notes into

updateProcessModelWithNotesContent

public static void updateProcessModelWithNotesContent(ProcessModel pm_,
                                                      ServiceContext sc_)

Inserts note values from the file system into the process model

Parameters:

pm_ - process model to insert notes into

sc_ - ServiceContext of user invoking the call.

updateProcessModelWithNotesContent

@Deprecated
public static void updateProcessModelWithNotesContent(ProcessModel pm_,
                                                                  com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)

Deprecated. since 6.0.3

Inserts note values from the file system into the process model

Parameters:

pm_ - process model to insert notes into

sc_ - ServiceContext of user invoking the call.

updateProcessModelWithNotesContent

@Deprecated
public static void updateProcessModelWithNotesContent(ProcessDiagram pm_)

Deprecated. use updateProcessModelWithNotesContent(ProcessDiagram, ServiceContext)

Inserts note values from the file system into the process diagram

Parameters:

pm_ - process diagram to insert notes into

updateProcessModelWithNotesContent

public static void updateProcessModelWithNotesContent(ProcessDiagram pm_,
                                                      ServiceContext sc_)

Parameters:

pm_ -

sc_ -

updateProcessModelWithNotesContent

@Deprecated
public static void updateProcessModelWithNotesContent(ProcessDiagram pm_,
                                                                  com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)

Deprecated. since 6.0.3

Parameters:

pm_ -

sc_ -

getErrorsForUnpublishedChildren

public static com.appiancorp.process.design.validation.Errors getErrorsForUnpublishedChildren(java.lang.Long pmId_,
                                                                                              ServiceContext sc_)

Gets errors for a process model if it has unpublished child processes

Parameters:

pmId_ - the id of the process model

sc_ - the current user's service context

Returns:

a list of Errors which will contain errors if the given process model has unpublished child processes. otherwise it will be empty. See ProcessDesignService.getUnpublishedChildrenForProcessModel(java.lang.Long) for a list of the result codes which will be used to create the returned object

getErrorsForUnpublishedChildren

@Deprecated
public static com.appiancorp.process.design.validation.Errors getErrorsForUnpublishedChildren(java.lang.Long pmId_,
                                                                                                          com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)

Deprecated. since 6.0.3

Gets errors for a process model if it has unpublished child processes

Parameters:

pmId_ - the id of the process model

sc_ - the current user's service context

Returns:

a list of Errors which will contain errors if the given process model has unpublished child processes. otherwise it will be empty. See ProcessDesignService.getUnpublishedChildrenForProcessModel(java.lang.Long) for a list of the result codes which will be used to create the returned object

getErrorsForParentsOfUnpublishedChildren

public static com.appiancorp.process.design.validation.Errors getErrorsForParentsOfUnpublishedChildren(java.lang.Long pmId_,
                                                                                                       ServiceContext sc_)

Gets errors associated with the parents of unpublished proecss models for a process model

Parameters:

pmId_ - the process model to get errors for

sc_ - the current user's service context

Returns:

a list of Errors objects that will return errors if the unpublished children of a process model have other parents. Otherwise the list will be empty. See ProcessDesignService.getParentsOfUnpublishedChildrenForProcessModel(java.lang.Long) for a list of the result codes which will be used to create the returned object

getErrorsForParentsOfUnpublishedChildren

@Deprecated
public static com.appiancorp.process.design.validation.Errors getErrorsForParentsOfUnpublishedChildren(java.lang.Long pmId_,
                                                                                                                   com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)

Deprecated. since 6.0.3

Gets errors associated with the parents of unpublished proecss models for a process model

Parameters:

pmId_ - the process model to get errors for

sc_ - the current user's service context

Returns:

a list of Errors objects that will return errors if the unpublished children of a process model have other parents. Otherwise the list will be empty. See ProcessDesignService.getParentsOfUnpublishedChildrenForProcessModel(java.lang.Long) for a list of the result codes which will be used to create the returned object

getErrorsForParentsOfProcessModel

public static com.appiancorp.process.design.validation.Errors getErrorsForParentsOfProcessModel(java.lang.Long pmId_,
                                                                                                ServiceContext sc_)

Gets errors associated with the given process model having parents

Parameters:

pmId_ - the process model to check for parents

sc_ - the current user's service context

Returns:

a list of Errors that contain errors if the given process model has parent process models. Otherwise the list is empty. See ProcessDesignService.getParentsForProcessModel(java.lang.Long) for a list of the result codes which will be used to create the returned object

getErrorsForParentsOfProcessModel

@Deprecated
public static com.appiancorp.process.design.validation.Errors getErrorsForParentsOfProcessModel(java.lang.Long pmId_,
                                                                                                            com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)

Deprecated. since 6.0.3

Gets errors associated with the given process model having parents

Parameters:

pmId_ - the process model to check for parents

sc_ - the current user's service context

Returns:

a list of Errors that contain errors if the given process model has parent process models. Otherwise the list is empty. See ProcessDesignService.getParentsForProcessModel(java.lang.Long) for a list of the result codes which will be used to create the returned object

validateProcessModel

public static java.lang.String[] validateProcessModel(AbstractProcessModel apm_,
                                                      ServiceContext sc_)
                                               throws ServiceException

Validates the process model

Parameters:

apm_ - the process model to validate

sc_ - the current user's service context

Returns:

A String array representing the errors within the process model. See ProcessDesignService.validateProcessModel(com.appiancorp.suiteapi.process.AbstractProcessModel)a description of the possible validation errors

Throws:

ServiceException - if anything goes wrong

validateProcessModel

@Deprecated
public static java.lang.String[] validateProcessModel(AbstractProcessModel apm_,
                                                                  com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                                           throws ServiceException

Deprecated. since 6.0.3

Validates the process model

Parameters:

apm_ - the process model to validate

sc_ - the current user's service context

Returns:

A String array representing the errors within the process model. See ProcessDesignService.validateProcessModel(com.appiancorp.suiteapi.process.AbstractProcessModel)a description of the possible validation errors

Throws:

ServiceException - if anything goes wrong

validateProcessModelExpressions

public static com.appiancorp.process.design.validation.Errors validateProcessModelExpressions(java.lang.String[] errors_,
                                                                                              com.appiancorp.process.design.validation.Errors err_)

Creates Invalid Expression Errors from list of String arrays from validateProcessModel(AbstractProcessModel,ServiceContext) and adds them to the passed in errors list

Parameters:

errors_ - the String array of errors gotten from validateProcessModel(AbstractProcessModel,ServiceContext)

err_ - an object used to encapsulate errors. This should not be null.

Returns:

an Errors object containing errors for the invalid expression exceptions found in the string of errors

validateProcessModelExpressions

public static com.appiancorp.process.design.validation.Errors validateProcessModelExpressions(java.lang.String[] errors_)

Creates Invalid Expression Errors from list of String arrays from validateProcessModel(AbstractProcessModel,ServiceContext)

Parameters:

errors_ - the String array of errors gotten from validateProcessModel(AbstractProcessModel,ServiceContext)

Returns:

an Errors object containing errors for the invalid expression exceptions found in the string of errors

validateSubProcessModels

public static com.appiancorp.process.design.validation.Errors validateSubProcessModels(java.lang.String[] errors_)

Creates Invalid Subprocess Model Errors from list of String arrays from validateProcessModel(AbstractProcessModel,ServiceContext)

Parameters:

errors_ - the String array of errors gotten from validateProcessModel(AbstractProcessModel,ServiceContext)

Returns:

an Errors object containing errors for the invalid expression exceptions found in the string of errors

validateSubProcessModels

public static com.appiancorp.process.design.validation.Errors validateSubProcessModels(java.lang.String[] errors_,
                                                                                       com.appiancorp.process.design.validation.Errors err_)

Creates Invalid Subprocess Model Errors from list of String arrays from validateProcessModel(AbstractProcessModel,ServiceContext) and adds them to the passed in errors list

Parameters:

errors_ - the String array of errors gotten from validateProcessModel(AbstractProcessModel,ServiceContext)

err_ - an Errors to which validation errors will be added

Returns:

an Errors object containing errors for the invalid expression exceptions found in the string of errors

validateInterfaceInformation

public static com.appiancorp.process.design.validation.Errors validateInterfaceInformation(com.appiancorp.process.design.validation.Errors err_,
                                                                                           java.lang.String... errors_)

Create Interface Information Errors from list of String arrays and adds them to the passed in Errors list. Interface Information Errors are those related to the mapping nodes and the process properties declare in their FormConfig.

Parameters:

err_ - the current list of Errors

errors_ - the list of Strings from which to construct the errors

Returns:

the updated list of Errors with the Interface Information Errors added

validateOtherErrors

public static com.appiancorp.process.design.validation.Errors validateOtherErrors(java.lang.String[] errors_,
                                                                                  com.appiancorp.process.design.validation.Errors err_)

validateAdminConfigSettings

public static com.appiancorp.process.design.validation.Errors validateAdminConfigSettings(com.appiancorp.process.design.validation.Errors err_,
                                                                                          java.lang.String... errors_)

handleProcessModelErrors

public static com.appiancorp.process.design.validation.Errors handleProcessModelErrors(java.lang.String[] errors_)

handleProcessModelErrors

public static com.appiancorp.process.design.validation.Errors handleProcessModelErrors(java.lang.String[] errors_,
                                                                                       com.appiancorp.process.design.validation.Errors err_)

Creates Errors from list of String arrays from validateProcessModel(AbstractProcessModel,ServiceContext)

Parameters:

errors_ - the String array of errors gotten from validateProcessModel(AbstractProcessModel,ServiceContext)

err_ - an Errors to which validation errors will be added

Returns:

an Errors object containing errors for the invalid expression exceptions found in the string of errors

validateAndSetPvDefaults

public static void validateAndSetPvDefaults(ProcessModel pm_)

getNotesWithContent

public static Note[] getNotesWithContent(Note[] notes_,
                                         ServiceContext sc_)

Parameters:

notes_ -

sc_ -

Returns:

getNotesWithContent

@Deprecated
public static Note[] getNotesWithContent(Note[] notes_,
                                                     com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)

Deprecated. since 6.0.3

validateCallIntegrationInformation

public static com.appiancorp.process.design.validation.Errors validateCallIntegrationInformation(com.appiancorp.process.design.validation.Errors err_,
                                                                                                 java.lang.String... errors_)

validateExecuteRoboticProcess

public static com.appiancorp.process.design.validation.Errors validateExecuteRoboticProcess(com.appiancorp.process.design.validation.Errors err_,
                                                                                            java.lang.String... errors_)

validateWriteRecordsWithEvents

public static com.appiancorp.process.design.validation.Errors validateWriteRecordsWithEvents(com.appiancorp.process.design.validation.Errors modelErrors,
                                                                                             java.lang.String... errorMessages)

Adds any errors related to the Write Records v2 node to the Errors object.

Parameters:

modelErrors - the existing model errors to append to

errorMessages - the error messages to process

Returns:

the updated Errors object