Package com.appiancorp.suiteapi.process
Class ProcessModelFacade
java.lang.Object
com.appiancorp.suiteapi.process.ProcessModelFacade
Manages the loading and storing and other utility functions of process models.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
static ProcessModel
createProcessModel
(ProcessModel pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static ProcessModel
Creates a process model in the database.static void
fillInAssigneeDisplayNames
(ProcessModel pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.Assignee display names will be populated automatically by theAppianTypeCache
static com.appiancorp.process.design.validation.Errors
getErrorsForParentsOfProcessModel
(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static com.appiancorp.process.design.validation.Errors
getErrorsForParentsOfProcessModel
(Long pmId_, ServiceContext sc_) Gets errors associated with the given process model having parentsstatic com.appiancorp.process.design.validation.Errors
getErrorsForParentsOfUnpublishedChildren
(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static com.appiancorp.process.design.validation.Errors
Gets errors associated with the parents of unpublished process models for a process modelstatic com.appiancorp.process.design.validation.Errors
getErrorsForUnpublishedChildren
(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static com.appiancorp.process.design.validation.Errors
getErrorsForUnpublishedChildren
(Long pmId_, ServiceContext sc_) Gets errors for a process model if it has unpublished child processesstatic Map
Gets note from a process modelstatic Map
static Note[]
getNotesWithContent
(Note[] notes_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static Note[]
getNotesWithContent
(Note[] notes_, ServiceContext sc_) static ProcessVariable[]
getProcessParameters
(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static ProcessVariable[]
getProcessParameters
(Long pmId, ServiceContext sc) Retrieve the process parameters used to start of the process model of the given IDstatic int
getRecursiveRelationship
(Long pmId_, Long subPmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static int
getRecursiveRelationship
(Long pmId, Long subPmId, ServiceContext sc) Returns that status of the recursive relationship between the two supplied ProcessModelsstatic ProcessVariable[]
getVisibleProcessVariables
(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static ProcessVariable[]
getVisibleProcessVariables
(Long pmId, ServiceContext sc) Retrieve all visible process variables used in the process model givenstatic com.appiancorp.process.design.validation.Errors
handleProcessModelErrors
(String[] errors_, boolean isEPEx) static com.appiancorp.process.design.validation.Errors
handleProcessModelErrors
(String[] errors_, com.appiancorp.process.design.validation.Errors err_, boolean isEPEx) Creates Errors from list of String arrays fromvalidateProcessModel(AbstractProcessModel,ServiceContext)
static ProcessModel
loadLatestPublishVersionOfProcessModel
(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static ProcessModel
loadLatestPublishVersionOfProcessModel
(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
loadProcessModel
(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static ProcessModel
loadProcessModel
(Long pmId, ServiceContext sc) Loads the working draft of a process model from the database.static ProcessModel
loadProcessModelVersion
(Long pmId_, String version_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static ProcessModel
loadProcessModelVersion
(Long pmId_, String version_, ServiceContext sc_) Loads a process model version from the database.static void
lockProcessModel
(Long pmId_, boolean overrideLock_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static void
lockProcessModel
(Long pmId, boolean overrideLock, ServiceContext sc) Locks the process model pmId_, overrides the lock of a previous user if overrideLock istrue
static ProcessModel
saveProcessModel
(ProcessModel pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static ProcessModel
Saves a process model in the database.static final void
saveProcessModelAndNodeNotes
(Map allNotes_, ProcessDiagram newModel_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static final void
saveProcessModelAndNodeNotes
(Map allNotes_, ProcessDiagram newModel_, ServiceContext sc_) static final void
saveProcessModelAndNodeNotes
(Map allNotes_, ProcessModel newModel_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static final void
saveProcessModelAndNodeNotes
(Map allNotes_, ProcessModel newModel_, ServiceContext sc_) Saves the notes for a process model and nodesstatic void
unlockProcessModel
(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static void
unlockProcessModel
(Long pmId_, ServiceContext sc_) Unlocks a process modelstatic void
updateProcessModelWithMapNotesContent
(Map notesMap_, ProcessModel pm_) reinserts notes content into pm from the given mapstatic void
Deprecated.use updateProcessModelWithNotesContent(ProcessDiagram, ServiceContext)static void
updateProcessModelWithNotesContent
(ProcessDiagram pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static void
static void
Deprecated.use updateProcessModelWithNotesContent(ProcessModel, ServiceContext)static void
updateProcessModelWithNotesContent
(ProcessModel pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static void
Inserts note values from the file system into the process modelstatic com.appiancorp.process.design.validation.Errors
validateAdminConfigSettings
(com.appiancorp.process.design.validation.Errors err_, String... errors_) static void
static com.appiancorp.process.design.validation.Errors
validateCallIntegrationInformation
(com.appiancorp.process.design.validation.Errors err_, String... errors_) static com.appiancorp.process.design.validation.Errors
validateEPEx
(com.appiancorp.process.design.validation.Errors modelErrors, String... errorStrings) Adds EPEx Unsupported Errors and Warnings to the modelErrors parameter.static com.appiancorp.process.design.validation.Errors
validateExecuteRoboticProcess
(com.appiancorp.process.design.validation.Errors err_, String... errors_) static com.appiancorp.process.design.validation.Errors
validateInterfaceInformation
(com.appiancorp.process.design.validation.Errors err_, String... errors_) Create Interface Information Errors from list of String arrays and adds them to the passed inErrors
list.static com.appiancorp.process.design.validation.Errors
validateOtherErrors
(String[] errors_, com.appiancorp.process.design.validation.Errors err_) static String[]
validateProcessModel
(AbstractProcessModel apm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static String[]
Validates the process modelstatic com.appiancorp.process.design.validation.Errors
validateProcessModelExpressions
(String[] errors_, boolean isEPEx) Creates Invalid Expression Errors from list of String arrays fromvalidateProcessModel(AbstractProcessModel,ServiceContext)
static com.appiancorp.process.design.validation.Errors
validateProcessModelExpressions
(String[] errors_, com.appiancorp.process.design.validation.Errors err_, boolean isEPEx) Creates Invalid Expression Errors from list of String arrays fromvalidateProcessModel(AbstractProcessModel,ServiceContext)
and adds them to the passed in errors liststatic com.appiancorp.process.design.validation.Errors
validateSubProcessModels
(String[] errors_) Creates Invalid Subprocess Model Errors from list of String arrays fromvalidateProcessModel(AbstractProcessModel,ServiceContext)
static com.appiancorp.process.design.validation.Errors
validateSubProcessModels
(String[] errors_, com.appiancorp.process.design.validation.Errors err_) Creates Invalid Subprocess Model Errors from list of String arrays fromvalidateProcessModel(AbstractProcessModel,ServiceContext)
and adds them to the passed in errors liststatic com.appiancorp.process.design.validation.Errors
validateWriteRecordsWithEvents
(com.appiancorp.process.design.validation.Errors modelErrors, String... errorMessages) Adds any errors related to the Write Records v2 node to the Errors object.static ProcessModel
versionProcessModel
(ProcessDiagram pd_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_, Map notesMap_) Deprecated.since 6.0.3static ProcessModel
versionProcessModel
(ProcessDiagram pd_, ServiceContext sc_, Map notesMap_) static ProcessModel
versionProcessModel
(ProcessModel pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_, Map notesMap_) Deprecated.since 6.0.3static ProcessModel
versionProcessModel
(ProcessModel pm_, ServiceContext sc_, Map notesMap_) Versions a process model in the database.
-
Constructor Details
-
ProcessModelFacade
public ProcessModelFacade()
-
-
Method Details
-
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 actionInvalidFolderException
- if theProcessModelFolder
does not existInvalidPriorityException
- if thePriority
does not existInvalidUserException
- if any user referenced in theProcessModel
does not existDuplicateUuidException
-
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.3Creates 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 actionInvalidFolderException
- if theProcessModelFolder
does not existInvalidPriorityException
- if thePriority
does not existInvalidUserException
- if any user referenced in theProcessModel
does not existDuplicateUuidException
-
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 UUIDInvalidProcessModelException
- if the process model does not existPrivilegeException
- if the user does not have privileges to update the process modelLockException
- if the process model is locked by someone other than the current userInvalidUserException
- if any user referenced in theProcessModel
does not existServiceException
- if anything else goes wrongAppianException
-
saveProcessModel
@Deprecated public static ProcessModel saveProcessModel(ProcessModel pm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) throws AppianException, ServiceException Deprecated.since 6.0.3Saves 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 UUIDInvalidProcessModelException
- if the process model does not existPrivilegeException
- if the user does not have privileges to update the process modelLockException
- if the process model is locked by someone other than the current userInvalidUserException
- if any user referenced in theProcessModel
does not existServiceException
- if anything else goes wrongAppianException
-
loadProcessModel
public static ProcessModel loadProcessModel(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. SeeProcessDesignService.getProcessModel(Long)
InvalidProcessModelException
- if the ID does not refer to a valid process modelServiceException
- if anything else goes wrongAppianException
-
loadProcessModel
@Deprecated public static ProcessModel loadProcessModel(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) throws ServiceException, AppianException Deprecated.since 6.0.3Loads 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. SeeProcessDesignService.getProcessModel(Long)
InvalidProcessModelException
- if the ID does not refer to a valid process modelServiceException
- if anything else goes wrongAppianException
-
loadLatestPublishVersionOfProcessModel
public static ProcessModel loadLatestPublishVersionOfProcessModel(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 modelPrivilegeException
- if the user does not have permission to view the process model. SeeProcessDesignService.getProcessModel(Long)
ServiceException
- if naything else goes wrongAppianException
-
loadLatestPublishVersionOfProcessModel
@Deprecated public static ProcessModel loadLatestPublishVersionOfProcessModel(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) throws ServiceException, AppianException Deprecated.since 6.0.3Loads 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 modelPrivilegeException
- if the user does not have permission to view the process model. SeeProcessDesignService.getProcessModel(Long)
ServiceException
- if naything else goes wrongAppianException
-
getProcessParameters
public static ProcessVariable[] getProcessParameters(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 forsc
- 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(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) throws ServiceException Deprecated.since 6.0.3Retrieve the process parameters used to start of the process model of the given ID- Parameters:
pmId_
- process model id to retrieve variables forsc_
- 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(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 forsc
- 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(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) throws ServiceException Deprecated.since 6.0.3Retrieve all visible process variables used in the process model given- Parameters:
pmId_
- process model id to retrieve variables forsc_
- 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(Long pmId, Long subPmId, ServiceContext sc) throws ServiceException Returns that status of the recursive relationship between the two supplied ProcessModels- Parameters:
pmId
- parent process idsubPmId
- sub parent process idsc
- 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:
-
getRecursiveRelationship
@Deprecated public static int getRecursiveRelationship(Long pmId_, Long subPmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) throws ServiceException Deprecated.since 6.0.3Returns that status of the recursive relationship between the two supplied ProcessModels- Parameters:
pmId_
- parent process idsubPmId_
- sub parent process idsc_
- 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:
-
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 theAppianTypeCache
Fills in all appian type display names for a process model- Parameters:
pm_
- the process model to fill in the appian types forsc_
- the current user's service context- Throws:
InvalidUserException
- if the process model contains any usernames that do not refer to valid usersInvalidGroupException
- if the process model contains any group IDs that do not refer to valid groups
-
lockProcessModel
public static void lockProcessModel(Long pmId, boolean overrideLock, ServiceContext sc) throws ServiceException, AppianException Locks the process model pmId_, overrides the lock of a previous user if overrideLock istrue
- Parameters:
pmId
- id of process model to lockoverrideLock
- whether or not to override another user's locksc
- the current user's service context- Throws:
LockException
- if the process model is already locked and override was not truePrivilegeException
- if the user does not have access to lock (or override, if specified) the process model SeeProcessDesignService.lockProcessModel(Long,boolean)
ServiceException
- if any other error occursAppianException
-
lockProcessModel
@Deprecated public static void lockProcessModel(Long pmId_, boolean overrideLock_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) throws ServiceException, AppianException Deprecated.since 6.0.3Locks the process model pmId_, overrides the lock of a previous user if overrideLock istrue
- Parameters:
pmId_
- id of process model to lockoverrideLock_
- whether or not to override another user's locksc_
- the current user's service context- Throws:
LockException
- if the process model is already locked and override was not truePrivilegeException
- if the user does not have access to lock (or override, if specified) the process model SeeProcessDesignService.lockProcessModel(Long,boolean)
ServiceException
- if any other error occursAppianException
-
loadProcessModelVersion
public static ProcessModel loadProcessModelVersion(Long pmId_, 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(Long pmId_, String version_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) throws AppianException, ServiceException Deprecated.since 6.0.3Loads 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_, 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_, Map notesMap_) throws ServiceException, AppianException Deprecated.since 6.0.3Versions 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_, 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_, Map notesMap_) throws ServiceException, AppianException Deprecated.since 6.0.3- Parameters:
pd_
-sc_
-notesMap_
-- Returns:
- Throws:
ServiceException
AppianException
-
clearProcessDiagramNoteIds
-
unlockProcessModel
Unlocks a process model- Parameters:
pmId_
- the id of the process model to unlocksc_
- the current user's service context
-
unlockProcessModel
@Deprecated public static void unlockProcessModel(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3Unlocks a process model- Parameters:
pmId_
- the id of the process model to unlocksc_
- the current user's service context
-
saveProcessModelAndNodeNotes
public static final void saveProcessModelAndNodeNotes(Map allNotes_, ProcessModel newModel_, ServiceContext sc_) Saves the notes for a process model and nodes- Parameters:
allNotes_
- a map containing all the notesnewModel_
- the new model to save the notes forsc_
- the current user's service context
-
saveProcessModelAndNodeNotes
@Deprecated public static final void saveProcessModelAndNodeNotes(Map allNotes_, ProcessModel newModel_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3Saves the notes for a process model and nodes- Parameters:
allNotes_
- a map containing all the notesnewModel_
- the new model to save the notes forsc_
- the current user's service context
-
saveProcessModelAndNodeNotes
public static final void saveProcessModelAndNodeNotes(Map allNotes_, ProcessDiagram newModel_, ServiceContext sc_) - Parameters:
allNotes_
-newModel_
-sc_
-
-
saveProcessModelAndNodeNotes
@Deprecated public static final void saveProcessModelAndNodeNotes(Map allNotes_, ProcessDiagram newModel_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3- Parameters:
allNotes_
-newModel_
-sc_
-
-
getNotesFromProcessModel
Gets note from a process model- Parameters:
pm_
- the process model to get the notes from- Returns:
- A
Map
of the notes retrieved
-
getNotesFromProcessModel
-
updateProcessModelWithMapNotesContent
reinserts notes content into pm from the given map- Parameters:
notesMap_
- map containing note content for the given pmpm_
- pm to insert note content into
-
updateProcessModelWithNotesContent
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
Inserts note values from the file system into the process model- Parameters:
pm_
- process model to insert notes intosc_
- 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.3Inserts note values from the file system into the process model- Parameters:
pm_
- process model to insert notes intosc_
- ServiceContext of user invoking the call.
-
updateProcessModelWithNotesContent
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
- 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(Long pmId_, ServiceContext sc_) Gets errors for a process model if it has unpublished child processes- Parameters:
pmId_
- the id of the process modelsc_
- 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. SeeProcessDesignService.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(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3Gets errors for a process model if it has unpublished child processes- Parameters:
pmId_
- the id of the process modelsc_
- 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. SeeProcessDesignService.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(Long pmId_, ServiceContext sc_) Gets errors associated with the parents of unpublished process models for a process model- Parameters:
pmId_
- the process model to get errors forsc_
- 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. SeeProcessDesignService.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(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3Gets errors associated with the parents of unpublished process models for a process model- Parameters:
pmId_
- the process model to get errors forsc_
- 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. SeeProcessDesignService.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(Long pmId_, ServiceContext sc_) Gets errors associated with the given process model having parents- Parameters:
pmId_
- the process model to check for parentssc_
- 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. SeeProcessDesignService.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(Long pmId_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3Gets errors associated with the given process model having parents- Parameters:
pmId_
- the process model to check for parentssc_
- 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. SeeProcessDesignService.getParentsForProcessModel(java.lang.Long)
for a list of the result codes which will be used to create the returned object
-
validateProcessModel
public static String[] validateProcessModel(AbstractProcessModel apm_, ServiceContext sc_) throws ServiceException Validates the process model- Parameters:
apm_
- the process model to validatesc_
- the current user's service context- Returns:
- A
String
array representing the errors within the process model. SeeProcessDesignService.validateProcessModel(com.appiancorp.suiteapi.process.AbstractProcessModel)
a description of the possible validation errors - Throws:
ServiceException
- if anything goes wrong
-
validateProcessModel
@Deprecated public static String[] validateProcessModel(AbstractProcessModel apm_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) throws ServiceException Deprecated.since 6.0.3Validates the process model- Parameters:
apm_
- the process model to validatesc_
- the current user's service context- Returns:
- A
String
array representing the errors within the process model. SeeProcessDesignService.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(String[] errors_, com.appiancorp.process.design.validation.Errors err_, boolean isEPEx) Creates Invalid Expression Errors from list of String arrays fromvalidateProcessModel(AbstractProcessModel,ServiceContext)
and adds them to the passed in errors list- Parameters:
errors_
- the String array of errors gotten fromvalidateProcessModel(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(String[] errors_, boolean isEPEx) Creates Invalid Expression Errors from list of String arrays fromvalidateProcessModel(AbstractProcessModel,ServiceContext)
- Parameters:
errors_
- the String array of errors gotten fromvalidateProcessModel(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(String[] errors_) Creates Invalid Subprocess Model Errors from list of String arrays fromvalidateProcessModel(AbstractProcessModel,ServiceContext)
- Parameters:
errors_
- the String array of errors gotten fromvalidateProcessModel(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(String[] errors_, com.appiancorp.process.design.validation.Errors err_) Creates Invalid Subprocess Model Errors from list of String arrays fromvalidateProcessModel(AbstractProcessModel,ServiceContext)
and adds them to the passed in errors list- Parameters:
errors_
- the String array of errors gotten fromvalidateProcessModel(AbstractProcessModel,ServiceContext)
err_
- anErrors
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_, String... errors_) Create Interface Information Errors from list of String arrays and adds them to the passed inErrors
list. Interface Information Errors are those related to the mapping nodes and the process properties declare in their FormConfig.- Parameters:
err_
- the current list ofError
serrors_
- the list of Strings from which to construct the errors- Returns:
- the updated list of
Error
s with the Interface Information Errors added
-
validateOtherErrors
public static com.appiancorp.process.design.validation.Errors validateOtherErrors(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_, String... errors_) -
handleProcessModelErrors
public static com.appiancorp.process.design.validation.Errors handleProcessModelErrors(String[] errors_, boolean isEPEx) -
handleProcessModelErrors
public static com.appiancorp.process.design.validation.Errors handleProcessModelErrors(String[] errors_, com.appiancorp.process.design.validation.Errors err_, boolean isEPEx) Creates Errors from list of String arrays fromvalidateProcessModel(AbstractProcessModel,ServiceContext)
- Parameters:
errors_
- the String array of errors gotten fromvalidateProcessModel(AbstractProcessModel,ServiceContext)
err_
- anErrors
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
-
getNotesWithContent
- 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_, String... errors_) -
validateExecuteRoboticProcess
public static com.appiancorp.process.design.validation.Errors validateExecuteRoboticProcess(com.appiancorp.process.design.validation.Errors err_, String... errors_) -
validateWriteRecordsWithEvents
public static com.appiancorp.process.design.validation.Errors validateWriteRecordsWithEvents(com.appiancorp.process.design.validation.Errors modelErrors, String... errorMessages) Adds any errors related to the Write Records v2 node to the Errors object.- Parameters:
modelErrors
- the existing model errors to append toerrorMessages
- the error messages to process- Returns:
- the updated Errors object
-
validateEPEx
public static com.appiancorp.process.design.validation.Errors validateEPEx(com.appiancorp.process.design.validation.Errors modelErrors, String... errorStrings) Adds EPEx Unsupported Errors and Warnings to the modelErrors parameter. Other types of EPEx Errors that are duplicates of K errors shouldn't be processed here.- Parameters:
modelErrors
- the existing model errors to append toerrorStrings
- the error messages to process- Returns:
- the updated Errors object
-