Package com.appiancorp.suiteapi.process

Interface ProcessDesignService

All Superinterfaces:
ContextSensitiveSingletonService, Service
public interface ProcessDesignService extends ContextSensitiveSingletonService
The ProcessDesignService is used for creating and modifying ProcessModel which are organized by storing them in ProcessModelFolder objects. It also contains methods for handling the security of these objects. It mainly deals with the design of Process Models whereas the ProcessExecutionService deals with all aspects of starting and maintaining instances of a ProcessModel (Process).

A ProcessModelFolder can be created and modified with this service. Process models are organized into folders in the process model pickers.

ProcessModel objects created by this service can be run using the ProcessExecutionService.

When a ProcessModel is being designed it is considered a draft. When a designer is satisfied with their design he or she may save the ProcessModel using updateProcessModel(ProcessModel) and create a new version using versionProcessModel(ProcessModel). When a ProcessModel is first versioned it is given the version "1.0" and all subsequent versions are incremented by 1.0. Versions of a ProcessModel cannot be run until they are published, and a ProcessModel version cannot be published unless it is valid. A ProcessModel can be validated using the validateProcessModel(ProcessModel) method.

A ProcessModel can be locked by a user so that no other users can edit the ProcessModel. However, a User can attempt to override the lock placed on a ProcessModel by another User by calling lockProcessModel(Long,boolean) or unlockProcessModel(Long,boolean) and setting the override boolean to true.

In addition to regular ProcessNode objects a ProcessModel can contain other ProcessModel objects through sub and linked processes.
A sub-process is a node which contains a ProcessModel. This node is considered a single node by the parent ProcessModel. When a sub-process node is reached during process execution the sub-process is started and the sub-process node is considered active. The node does not complete until the sub-process has completed.
A linked-process is a node which starts an instance of a ProcessModel. Once the linked-process has been started the linked-process node is considered complete by the parent Process.

As mentioned above, this service contains methods relating to the security and permissions of various objects. The permissions which can be obtained through this service include: getPermissionsForFolder(Long), #getPermissionsForPalette(Long), getPermissionsForProcessApplication(), and getPermissionsForProcessModel(Long). These methods should be used when determining which actions a User can perform on the corresponding object. Permissions are obtained through ProcessModelPermissions. These may be referenced to determine whether a user has sufficient privileges to perform a particular action.

Methods of service classes can all throw the unchecked exception ServiceException if any system-level error (for example, server failure) occurs, and will in general throw a checked exception (InvalidXXXException) when an entity to be retrieved is inaccessible, instead of returning null. Exceptions to this paradigm (including the use of ResultList as described below) are noted. All checked exceptions extend AppianException.

It may be necessary to retrieve a subset of results as opposed to an entire collection, and also to sort the subset by some property of the returned object. "Paging" methods which return a ResultPage are provided in certain instances for this purpose. The ResultPage will contain the sorted subset of results (via Result.getResults()), and the total number of items in the available result set (via ResultPage.getAvailableItems()).

It may also be necessary to retrieve some results, even if all results cannot be retrieved (for instance, some of the entities corresponding to a list of entity IDs may no longer exist). Methods which return a ResultList are provided for this purpose. The Result.getResults() method in this case will return all results which can be retrieved. In addition, there will be a list of result codes (ResultList.getResultCodes()) that represent the successful retrieval of an entity, or, if the entity could not be retrieved, the reason for the failure. See the CODE_XXX constants in ResultList for details.

See Also:

  • Field Details

    • DOES_NOT_RECURSE

      static final int DOES_NOT_RECURSE
      Indicates that there is no recursion in the process model, the subprocess model, or between the process model and sub-process model
      See Also:

    • PARENT_PROCESS_RECURSES

      static final int PARENT_PROCESS_RECURSES
      Indicates that the parent process model recurses (including the situation where the parent recurses through addition of the sub-process model)
      See Also:

    • SUBPROCESS_RECURSES

      static final int SUBPROCESS_RECURSES
      Indicates that any sub-process of the parent process recurses
      See Also:

    • EMBEDDED

      static final int EMBEDDED
      Sub-process is embedded in the parent process
      See Also:

    • INDEPENDENT

      static final int INDEPENDENT
      Sub-process is independent of the parent process
      See Also:

    • ALL

      static final int ALL
      All possible sub-process states
      See Also:

    • UNPUBLISHED_CHILDREN_VIEW_PERMISSIONS

      static final Integer UNPUBLISHED_CHILDREN_VIEW_PERMISSIONS
      Get unpublished children failed because the user did not have view permissions

    • UNPUBLISHED_CHILDREN_INVALID

      static final Integer UNPUBLISHED_CHILDREN_INVALID
      Get unpublished children failed because the process model specified did not exist

    • UNPUBLISHED_CHILDREN_PUBLISH_PERMISSIONS

      static final Integer UNPUBLISHED_CHILDREN_PUBLISH_PERMISSIONS
      Get unpublished children failed because the process model specified did not exist

    • UNPUBLISHED_CHILDREN_SUCCESS

      static final Integer UNPUBLISHED_CHILDREN_SUCCESS
      Get unpublished children failed because the user did not have publish permissions

    • createProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean createProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • exportProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean exportProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • listProcessModels$UPDATES

      @Deprecated(forRemoval=true) static final boolean listProcessModels$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getActivityClassSchemas$UPDATES

      @Deprecated(forRemoval=true) static final boolean getActivityClassSchemas$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getActivityClassSchema$UPDATES

      @Deprecated(forRemoval=true) static final boolean getActivityClassSchema$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getACSchemaByLocalId$UPDATES

      @Deprecated(forRemoval=true) static final boolean getACSchemaByLocalId$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • startProcess$UPDATES

      @Deprecated(forRemoval=true) static final boolean startProcess$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • startProcessWithPriority$UPDATES

      @Deprecated(forRemoval=true) static final boolean startProcessWithPriority$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • initiateProcess$UPDATES

      @Deprecated(forRemoval=true) static final boolean initiateProcess$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelsForGroup$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelsForGroup$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelDetails$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelDetails$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getFormConfig$UPDATES

      @Deprecated(forRemoval=true) static final boolean getFormConfig$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getFormConfigForVersion$UPDATES

      @Deprecated(forRemoval=true) static final boolean getFormConfigForVersion$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • isStartFormCapable$UPDATES

      @Deprecated(forRemoval=true) static final boolean isStartFormCapable$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getMyProcessModels$UPDATES

      @Deprecated(forRemoval=true) static final boolean getMyProcessModels$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelsICanStart$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelsICanStart$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModels$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModels$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelParameters$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelParameters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getVisibleProcessVariables$UPDATES

      @Deprecated(forRemoval=true) static final boolean getVisibleProcessVariables$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getAssigneePoolACSchemas$UPDATES

      @Deprecated(forRemoval=true) static final boolean getAssigneePoolACSchemas$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getAssignmentPoolACSchemas$UPDATES

      @Deprecated(forRemoval=true) static final boolean getAssignmentPoolACSchemas$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • activateUserSession$UPDATES

      @Deprecated(forRemoval=true) static final boolean activateUserSession$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getEscalationACSchemas$UPDATES

      @Deprecated(forRemoval=true) static final boolean getEscalationACSchemas$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • deleteProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean deleteProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • deleteProcessModels$UPDATES

      @Deprecated(forRemoval=true) static final boolean deleteProcessModels$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelDescriptor$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelDescriptor$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getRecursiveRelationship$UPDATES

      @Deprecated(forRemoval=true) static final boolean getRecursiveRelationship$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSubProcessModelDescriptorsForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSubProcessModelDescriptorsForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSynchronousSubProcessModelDescriptorsForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSynchronousSubProcessModelDescriptorsForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelDescriptorsContainingSubProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelDescriptorsContainingSubProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelDescriptorsContainingSynchronousSubProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelDescriptorsContainingSynchronousSubProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getTopLevelProcessModelDescriptorsForSubProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getTopLevelProcessModelDescriptorsForSubProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getTopLevelProcessModelDescriptorsForSynchronousSubProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getTopLevelProcessModelDescriptorsForSynchronousSubProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getLinkProcessModelDescriptorsForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getLinkProcessModelDescriptorsForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getAsynchronousSubProcessModelDescriptorsForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getAsynchronousSubProcessModelDescriptorsForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelDescriptorsContainingLinkProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelDescriptorsContainingLinkProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelDescriptorsContainingAsynchronousSubProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelDescriptorsContainingAsynchronousSubProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getTopLevelProcessModelDescriptorsForLinkProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getTopLevelProcessModelDescriptorsForLinkProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getTopLevelProcessModelDescriptorsForAsynchronousSubProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getTopLevelProcessModelDescriptorsForAsynchronousSubProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSecurityForProcessApplication$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSecurityForProcessApplication$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setSecurityForProcessApplication$UPDATES

      @Deprecated(forRemoval=true) static final boolean setSecurityForProcessApplication$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSecurityForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSecurityForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setSecurityForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean setSecurityForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setActorsInRolesForProcessApplication$UPDATES

      @Deprecated(forRemoval=true) static final boolean setActorsInRolesForProcessApplication$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setActorsInRolesForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean setActorsInRolesForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForProcessApplication$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForProcessApplication$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForProcessModels$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForProcessModels$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPriority$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPriority$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getDefaultPriority$UPDATES

      @Deprecated(forRemoval=true) static final boolean getDefaultPriority$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setDefaultPriority$UPDATES

      @Deprecated(forRemoval=true) static final boolean setDefaultPriority$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPriorityOfProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPriorityOfProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setPriorityOfProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean setPriorityOfProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • lockProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean lockProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelVersion$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelVersion$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • exportProcessModelVersion$UPDATES

      @Deprecated(forRemoval=true) static final boolean exportProcessModelVersion$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • versionProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean versionProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelsForFolder$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelsForFolder$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getChildFolders$UPDATES

      @Deprecated(forRemoval=true) static final boolean getChildFolders$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getTopLevelFolders$UPDATES

      @Deprecated(forRemoval=true) static final boolean getTopLevelFolders$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getVersionsForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getVersionsForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setActorsInRolesForFolder$UPDATES

      @Deprecated(forRemoval=true) static final boolean setActorsInRolesForFolder$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • unlockProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean unlockProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • unlockProcessModels$UPDATES

      @Deprecated(forRemoval=true) static final boolean unlockProcessModels$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getFolder$UPDATES

      @Deprecated(forRemoval=true) static final boolean getFolder$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getFolders$UPDATES

      @Deprecated(forRemoval=true) static final boolean getFolders$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • startProcessVersion$UPDATES

      @Deprecated(forRemoval=true) static final boolean startProcessVersion$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelProperties$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelProperties$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getMaximumNumberOfNotes$UPDATES

      @Deprecated(forRemoval=true) static final boolean getMaximumNumberOfNotes$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getMaximumNumberOfAttachments$UPDATES

      @Deprecated(forRemoval=true) static final boolean getMaximumNumberOfAttachments$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getUnpublishedChildrenForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getUnpublishedChildrenForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getParentsForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getParentsForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getParentsOfUnpublishedChildrenForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getParentsOfUnpublishedChildrenForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • publishProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean publishProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • saveAndPublishProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean saveAndPublishProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getVisibleProcessVariablesForVersion$UPDATES

      @Deprecated(forRemoval=true) static final boolean getVisibleProcessVariablesForVersion$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelParametersForVersion$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelParametersForVersion$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getCountProcessModelParametersForVersion$UPDATES

      @Deprecated(forRemoval=true) static final boolean getCountProcessModelParametersForVersion$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateFolder$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateFolder$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • createFolder$UPDATES

      @Deprecated(forRemoval=true) static final boolean createFolder$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • disableProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean disableProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • enableProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean enableProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • deleteFolders$UPDATES

      @Deprecated(forRemoval=true) static final boolean deleteFolders$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • deleteFolder$UPDATES

      @Deprecated(forRemoval=true) static final boolean deleteFolder$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateFolders$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateFolders$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateProcessModelsWithDescriptors$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateProcessModelsWithDescriptors$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSecurityForFolder$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSecurityForFolder$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setSecurityForFolder$UPDATES

      @Deprecated(forRemoval=true) static final boolean setSecurityForFolder$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelDescriptors$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelDescriptors$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelsLatestPublishedDescriptors$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelsLatestPublishedDescriptors$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelVersionDescriptor$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelVersionDescriptor$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • moveProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean moveProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • moveFolder$UPDATES

      @Deprecated(forRemoval=true) static final boolean moveFolder$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForFolder$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForFolder$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForFolders$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForFolders$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setInheritanceForFolder$UPDATES

      @Deprecated(forRemoval=true) static final boolean setInheritanceForFolder$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • deleteProcessModelVersion$UPDATES

      @Deprecated(forRemoval=true) static final boolean deleteProcessModelVersion$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getBusinessEntity$UPDATES

      @Deprecated(forRemoval=true) static final boolean getBusinessEntity$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • createBusinessEntity$UPDATES

      @Deprecated(forRemoval=true) static final boolean createBusinessEntity$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateBusinessEntity$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateBusinessEntity$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelWebServices$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelWebServices$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • createProcessModelWebService$UPDATES

      @Deprecated(forRemoval=true) static final boolean createProcessModelWebService$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • deleteProcessModelWebService$UPDATES

      @Deprecated(forRemoval=true) static final boolean deleteProcessModelWebService$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessStartingInfo$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessStartingInfo$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelByUuid$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelByUuid$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelIdByUuid$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelIdByUuid$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelsAndDescendants$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelsAndDescendants$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelsForFolderStartableOnly$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelsForFolderStartableOnly$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • validateProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean validateProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • validateProcessModelVersion$UPDATES

      @Deprecated(forRemoval=true) static final boolean validateProcessModelVersion$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • isProcessModelLocked$UPDATES

      @Deprecated(forRemoval=true) static final boolean isProcessModelLocked$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelLatestPublishedVersion$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelLatestPublishedVersion$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelLatestPublishedVersionDescriptor$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelLatestPublishedVersionDescriptor$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getACInstanceIdsForLocalIds$UPDATES

      @Deprecated(forRemoval=true) static final boolean getACInstanceIdsForLocalIds$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getACPInstanceIdsForLocalIds$UPDATES

      @Deprecated(forRemoval=true) static final boolean getACPInstanceIdsForLocalIds$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • notifyUserCreation$UPDATES

      @Deprecated(forRemoval=true) static final boolean notifyUserCreation$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • notifyUsersCreation$UPDATES

      @Deprecated(forRemoval=true) static final boolean notifyUsersCreation$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • validateGroupMembership$UPDATES

      @Deprecated(forRemoval=true) static final boolean validateGroupMembership$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateUsernames$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateUsernames$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • commitUpdateUsernames$UPDATES

      @Deprecated(forRemoval=true) static final boolean commitUpdateUsernames$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • rollbackUpdateUsernames$UPDATES

      @Deprecated(forRemoval=true) static final boolean rollbackUpdateUsernames$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setApplicationAdministratorGroup$UPDATES

      @Deprecated(forRemoval=true) static final boolean setApplicationAdministratorGroup$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • reloadProperties$UPDATES

      @Deprecated(forRemoval=true) static final boolean reloadProperties$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • validate$UPDATES

      @Deprecated(forRemoval=true) static final boolean validate$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setSiteLocaleSettings$UPDATES

      @Deprecated(forRemoval=true) static final boolean setSiteLocaleSettings$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getEventsForProcessModelPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getEventsForProcessModelPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • findEventsPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean findEventsPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getEventOrProcessModelNames$UPDATES

      @Deprecated(forRemoval=true) static final boolean getEventOrProcessModelNames$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessModelIdsByUuids$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessModelIdsByUuids$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getEmailAttachmentFolderIdForPm$UPDATES

      @Deprecated(forRemoval=true) static final boolean getEmailAttachmentFolderIdForPm$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPmIdForEvent$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPmIdForEvent$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getEventsByPersistentId$UPDATES

      @Deprecated(forRemoval=true) static final boolean getEventsByPersistentId$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setDashboardPageForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean setDashboardPageForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getDashboardPageForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getDashboardPageForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • removeDashboardPageForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean removeDashboardPageForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • addProcessModelToFavorites$UPDATES

      @Deprecated(forRemoval=true) static final boolean addProcessModelToFavorites$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • removeProcessModelFromFavorites$UPDATES

      @Deprecated(forRemoval=true) static final boolean removeProcessModelFromFavorites$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • handleMessages$UPDATES

      @Deprecated(forRemoval=true) static final boolean handleMessages$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • validateUsernames$UPDATES

      @Deprecated(forRemoval=true) static final boolean validateUsernames$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessVariablesForModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessVariablesForModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getCurrentNotePaths$UPDATES

      @Deprecated(forRemoval=true) static final boolean getCurrentNotePaths$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setCurrentNotePaths$UPDATES

      @Deprecated(forRemoval=true) static final boolean setCurrentNotePaths$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getExpressionDependencies$UPDATES

      @Deprecated(forRemoval=true) static final boolean getExpressionDependencies$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • evaluateExpressionInVariableContext$UPDATES

      @Deprecated(forRemoval=true) static final boolean evaluateExpressionInVariableContext$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • evaluateExpression$UPDATES

      @Deprecated(forRemoval=true) static final boolean evaluateExpression$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • externalizeExpression$UPDATES

      @Deprecated(forRemoval=true) static final boolean externalizeExpression$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • internalizeExpression$UPDATES

      @Deprecated(forRemoval=true) static final boolean internalizeExpression$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getRuleIdReferences$UPDATES

      @Deprecated(forRemoval=true) static final boolean getRuleIdReferences$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getRuleUuidReferences$UPDATES

      @Deprecated(forRemoval=true) static final boolean getRuleUuidReferences$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • evaluateRule$UPDATES

      @Deprecated(forRemoval=true) static final boolean evaluateRule$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setProcessDashboardPageForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean setProcessDashboardPageForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getProcessDashboardPageForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getProcessDashboardPageForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • removeProcessDashboardPageForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean removeProcessDashboardPageForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getLingeringTasksForProcessModel$UPDATES

      @Deprecated(forRemoval=true) static final boolean getLingeringTasksForProcessModel$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • validateTypedValues$UPDATES

      @Deprecated(forRemoval=true) static final boolean validateTypedValues$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setTimeZone$UPDATES

      @Deprecated(forRemoval=true) static final boolean setTimeZone$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setTimeZoneSameAs$UPDATES

      @Deprecated(forRemoval=true) static final boolean setTimeZoneSameAs$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

  • Method Details

    • createProcessModel

      @Write({K_PROCESS_DESIGN,OBJECT_STORE}) ProcessModel createProcessModel(ProcessModel pm) throws PrivilegeException, InvalidFolderException, InvalidPriorityException, InvalidUserException, DuplicateUuidException
      Creates a ProcessModel in the database using the input parameter. The database generates primary keys and reconstitutes the model to create the return value.

      In order to create a model at least the following fields must be populated:

      For each process variable, the following fields must be populated: key, value, type, and multiple

      For each process node, the following fields must be populated: id, guiId, ownerId, ownerName, groupOwnerId, groupOwnerName, icon, paletteIcon, x, y, activityClass, preActivities (can be an empty array), postActivities (can be an empty array), connections (can be an empty array), notify, assign (if the node is attended), confirmationUrl (populated by default), schedule, escalations (can be an empty array), multipleInstance, notes (can be an empty array), attachments (can be an empty array), priority, targetCompletion (populated by default), and targetLag (populated by default).

      Within each process node, in the assign member, the following fields must be populated: assignees, multipleInstanceAssigneeType, assignmentFunction, and assignmentPosition

      Within each process node, in the activity class member, the following fields must be populated: acSchemaId, localId, parameters (can be an empty list), customParameters (can be an empty list), unattended, runAs (if it is unattended), outputExpressions (can be an empty list), formConfig (if it is attended), and helperClass.

      Within each activity class, for each activity class parameter, the following fields must be populated: acpSchemaId, expression, and validationMessages

      Parameters:
      pm - the ProcessModel to create
      Returns:
      the created ProcessModel, with IDs populated.
      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 - if the UUID of the process model already exists

    • updateProcessModel

      @Write({K_PROCESS_DESIGN,OBJECT_STORE}) ProcessModel updateProcessModel(ProcessModel pm) throws InvalidUuidException, InvalidProcessModelException, InvalidPriorityException, PrivilegeException, LockException, InvalidUserException
      Updates a process model in the database based on the input parameter. The database generates primary keys and reconstitutes the model to create the return value. The id and uuid fields are only used for retrieving the model and cannot be changed since they are assigned by the server in the first place.

      In order to update a model at least the following fields must be populated:

      For each process variable, the following fields must be populated: key, value, type, and multiple

      For each process node, the following fields must be populated: id, guiId, ownerId, ownerName, groupOwnerId, groupOwnerName, icon, paletteIcon, x, y, activityClass, preActivities (can be an empty array), postActivities (can be an empty array), connections (can be an empty array), notify, assign (if the node is attended), confirmationUrl (populated by default), schedule, escalations (can be an empty array), multipleInstance, notes (can be an empty array), attachments (can be an empty array), priority, targetCompletion (populated by default), and targetLag (populated by default).

      Within each process node, in the assign member, the following fields must be populated: assignees.

      Within each process node, in the activity class member, the following fields must be populated: acSchemaId, localId, parameters (can be an empty list), customParameters (can be an empty list), unattended, runAs (if it is unattended), outputExpressions (can be an empty list), formConfig (if it is attended), and helperClass.

      Within each activity class, for each activity class parameter, the following fields must be populated: acpSchemaId, expression, and validationMessages.

      Parameters:
      pm - the processModel to update
      Returns:
      the updated process model
      Throws:
      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
      InvalidUuidException - if the specified uuid is used by another process model
      InvalidUserException - if any user referenced in the ProcessModel does not exist
      InvalidPriorityException

    • getProcessModel

      @Read({K_PROCESS_DESIGN,OBJECT_STORE}) ProcessModel getProcessModel(Long processModelId) throws PrivilegeException, InvalidProcessModelException
      Retrieve a working draft of a ProcessModel. If the information needed can be retrieved from ProcessModel.Descriptor consider calling the getProcessModelDescriptor(Long) method instead which is considerably faster.
      Parameters:
      processModelId - ID of the ProcessModel to retrieve
      Returns:
      The ProcessModel specified by processModelId_
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by processModelId_ does not exist
      PrivilegeException - if the current User does not have sufficient privileges to view the ProcessModel

    • exportProcessModel

      @Read(K_PROCESS_DESIGN) ProcessModel exportProcessModel(Long processModelId) throws PrivilegeException, InvalidProcessModelException
      Retrieve a working draft of a ProcessModel. Unlike getProcessModel(java.lang.Long), this API does not convert rule uuids to names (within expressions). Therefore this API should be used when retrieving a model for export.
      Parameters:
      processModelId - ID of the ProcessModel to retrieve
      Returns:
      The ProcessModel specified by processModelId_
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by processModelId_ does not exist
      PrivilegeException - if the current User does not have sufficient privileges to view the ProcessModel

    • listProcessModels

      @Deprecated @Read(K_PROCESS_DESIGN) ProcessModel.Descriptor[] listProcessModels()
      Deprecated.
      Use getProcessModelDescriptors(Long[]) instead. This method performs poorly and should not be called.
      Lists descriptors representing the working drafts of all process models in the system.
      Returns:
      an array of descriptor objects which represent the process models in the system

    • getActivityClassSchemas

      @Read(K_PROCESS_DESIGN) Identity[] getActivityClassSchemas(Long[] acsIds) throws InvalidActivityClassSchemaException
      Retrieves a list of abbreviated ActivityClassSchema representations for the given IDs
      Parameters:
      acsIds - the activity class schema IDs
      Returns:
      An array of Identity objects which are abbreviated representations of ActivityClassSchema objects.
      Throws:
      InvalidActivityClassSchemaException - if ActivityClassSchema does not exist

    • getActivityClassSchema

      @Read(K_PROCESS_DESIGN) ActivityClassSchema getActivityClassSchema(Long acsId) throws InvalidActivityClassSchemaException
      Retrieves an ActivityClassSchema.
      Parameters:
      acsId - the ID of the ActivityClassSchema to retrieve.
      Returns:
      the ActivityClassSchema specified by acsId_
      Throws:
      InvalidActivityClassSchemaException - if the ActivityClassSchema specified by acsId_ does not exist

    • getACSchemaByLocalId

      @Read(K_PROCESS_DESIGN) ActivityClassSchema getACSchemaByLocalId(String acsLocalId) throws InvalidActivityClassSchemaException
      Retrieves an ActivityClassSchema by local id.
      Parameters:
      acsLocalId - the local ID of the ActivityClassSchema to retrieve.
      Returns:
      the ActivityClassSchema specified by acsLocalId_
      Throws:
      InvalidActivityClassSchemaException - if the ActivityClassSchema specified by acsId_ does not exist

    • startProcess

      @Deprecated @Write(K_PROCESS_DESIGN) Long startProcess(Long processModelId, ProcessVariable[] variables) throws InvalidProcessModelException, PrivilegeException, InvalidStateException, StorageLimitException, InvalidUserException, IllegalArgumentException, Exception
      Deprecated.
      Use initiateProcess(Long, ProcessStartConfig), which has better enforcement of required parameters (requires that their values not be null or empty)
      Starts an instance of the given process model, using the given variables to initialize state.

      The following fields must be populated for each ProcessVariable object: key, value, type, and multiple

      Parameters:
      processModelId - id of process model to start
      variables - parameters for the process model. If using a process variable of an Appian type, do not set the value to that object but instead to the corresponding primitive. For instance, do not assign a User process variable a User object. Instead, assign that process variable a String containing the username. Likewise, assign a process variable of type Group should be assigned a Long, etc. The exception to this rule is the People type. Process variables of type People should be assigned a LocalObject. Only the values are used for passed parameters, not expressions; expressions must be set on the process model at design time.
      Returns:
      The id of the started process instance.
      Throws:
      InvalidProcessModelException - if the referenced process model does not exist or has been deleted.
      PrivilegeException - if the user does not have permission to perform this action.
      InvalidStateException - if there is no published version of the specified pm, the published version is disabled, or if the process model contains sub process models that have been disabled or deleted. Note that all sub process models of a published process model must have been published, but they can still be disabled.
      InvalidUserException - if any user referenced in any ProcessVariable does not exist.
      IllegalArgumentException - if the ProcessModel requires process parameters to start, and the variables_ parameter is an empty array, or does not contain all necessary process parameters.
      NullPointerException - if processModelId_ or variables_ array is null.
      Exception
      StorageLimitException

    • startProcessWithPriority

      @Deprecated @Write(K_PROCESS_DESIGN) Long startProcessWithPriority(Long processModelId, ProcessVariable[] variables, Long priorityId) throws InvalidProcessModelException, InvalidPriorityException, InvalidStateException, PrivilegeException, InvalidUserException, IllegalArgumentException, Exception
      Deprecated.
      Use initiateProcess(Long, ProcessStartConfig), which has better enforcement of required parameters (requires that their values not be null or empty)
      Starts an instance of the given process model, using the given variables to initialize state. The process will be started with the priority specified.
      Parameters:
      processModelId - id of process model to start
      variables - parameters for the process model. If using a process variable of an Appian type, do not set the value to that object but instead to the corresponding primitive. For instance, do not assign a User process variable a User object. Instead, assign that process variable a String containing the username. Likewise, assign a process variable of type Group should be assigned a Long, etc. The exception to this rule is the People type. Process variables of type People should be assigned a LocalObject.
      priorityId - the priority with which to start the process
      Returns:
      The id of the started process instance.
      Throws:
      InvalidPriorityException - if the Priority does not exist
      InvalidProcessModelException - if the ProcessModel does not exist
      PrivilegeException - if the user does not have permission to perform this action
      InvalidStateException - if there is no published version of the specified pm, the published version is disabled, or if the process model contains sub process models that have been disabled or deleted. Note that all sub process models of a published process model must have been published, but they can still be disabled.
      InvalidUserException - if any user referenced in any ProcessVariable does not exist
      IllegalArgumentException - if the ProcessModel requires process parameters to start, and the variables_ parameter is null, an empty array, or does not contain all necessary process parameters.
      Exception

    • initiateProcess

      @Write(K_PROCESS_DESIGN) Long initiateProcess(Long processModelId, ProcessStartConfig config) throws InvalidProcessModelException, InvalidPriorityException, InvalidVersionException, PrivilegeException, InvalidStateException, StorageLimitException, InvalidUserException, IllegalArgumentException, Exception
      Starts an instance of the given process model.
      Parameters:
      processModelId - id of process model to start
      config - additional configuration to control how the process is started
      Returns:
      The id of the started process instance.
      Throws:
      InvalidProcessModelException - if the referenced process model does not exist or has been deleted.
      PrivilegeException - if the user does not have permission to perform this action.
      InvalidStateException - if there is no published version of the specified pm, the published version is disabled, or if the process model contains sub process models that have been disabled or deleted. Note that all sub process models of a published process model must have been published, but they can still be disabled.
      InvalidUserException - if any user referenced in any ProcessVariable does not exist.
      IllegalArgumentException - if the ProcessModel requires process parameters to start, and any of the required parameters are missing or have not been given a value that is not null or empty.
      NullPointerException - if processModelId_ or variables_ array is null.
      Exception
      InvalidPriorityException
      InvalidVersionException
      StorageLimitException

    • getProcessModelsForGroup

      @Deprecated @Read(K_PROCESS_DESIGN) ResultPage getProcessModelsForGroup(Long groupId, int startIndex, int batchSize, Integer sortProperty, Integer sortOrder)
      Deprecated.
      Process models are no longer associated with groups, but rather are organized into folders. Use getProcessModelsForFolder(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
      Retrieves process model descriptors objects for all process models owned by a group
      Parameters:
      groupId - ID of the Group for which to retrieve ProcessModel.Descriptor objects
      startIndex - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      batchSize - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
      sortProperty - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants located in ProcessModel.Descriptor
      sortOrder - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      A ResultPage which contains an array of ProcessModel.Descriptor objects for each ProcessModel owned by the Group specified by groupId_

    • getProcessModelDetails

      @Read(K_PROCESS_DESIGN) ProcessModelDetails getProcessModelDetails(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Retrieves ProcessModelDetails representing the working drafts of the given ProcessModel If only requiring FormConfig, see getFormConfig in this class.
      Parameters:
      processModelId - ID of the ProcessModel for which to retrieve the ProcessModelDetails
      Returns:
      A ProcessModelDetails which contains details about the ProcessModel specified by processModelId_
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by processModelId_ does not exist
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation

    • getFormConfig

      @Read(K_PROCESS_DESIGN) FormConfig getFormConfig(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Retrieves the FormConfig of the draft of the given process model.
      Parameters:
      processModelId - ID of the ProcessModel for which to retrieve the FormConfig
      Returns:
      A FormConfig
      Throws:
      InvalidProcessModelException
      PrivilegeException

    • getFormConfigForVersion

      @Read(K_PROCESS_DESIGN) FormConfig getFormConfigForVersion(Long processModelId, String version) throws InvalidProcessModelException, InvalidVersionException, InvalidStateException, PrivilegeException
      Retrieves the FormConfig of the given process model version.
      Parameters:
      processModelId - ID of the ProcessModel for which to retrieve the FormConfig
      version - version of the process model (use null to refer to a draft, or AbstractProcessModel.LATEST_PUBLISHED_VERSION to refer to the latest published version)
      Returns:
      A FormConfig
      Throws:
      InvalidProcessModelException
      InvalidVersionException
      InvalidStateException - if there is no published version of the specified pm, the published version is disabled, or if the process model contains sub process models that have been disabled or deleted. Note that all sub process models of a published process model must have been published, but they can still be disabled.
      PrivilegeException

    • isStartFormCapable

      @Read(K_PROCESS_DESIGN) ResultList isStartFormCapable(Long[] processModelIds, int capabilities)
      Retrieves a ResultList containing Boolean values representing whether the start form for the latest published version of each of the process models is capable of ALL the specified form capabilities. If the process model does not have a start form, this method will return a ResultList.CODE_VALID for that entry.
      Parameters:
      processModelIds - the process model ids
      capabilities - a bitwise OR of any of the following values: FormConfig.CAPABILITY_RENDER_WEB, FormConfig.CAPABILITY_RENDER_MOBILE
      Returns:
      a ResultList containing a Boolean value for each process model that is valid and has a published version. The result codes can be: ResultList.CODE_VALID if the process model exists and has the requested capability, ResultList.CODE_INVALID if the specified process model does not exist, does not have a published version or does not have the requested capability, or ResultList.CODE_NO_PERMISSION if the user does not have permission to view the given process model.

    • getMyProcessModels

      @Read(K_PROCESS_DESIGN) ProcessModel.Descriptor[] getMyProcessModels()
      Retrieves ProcessModel objects for which the current user is an owner.
      Returns:
      An array of ProcessModel.Descriptor objects which represent the ProcessModel objects owned by the current User

    • getProcessModelsICanStart

      @Read(K_PROCESS_DESIGN) ProcessModel.Descriptor[] getProcessModelsICanStart()
      Retrieves process model descriptors which represent the working drafts of the process models that the current user has permission to start
      Returns:
      ProcessModel.Descriptor objects for each ProcessModel which the current user can start.

    • getProcessModels

      @Deprecated @Read({K_PROCESS_DESIGN,OBJECT_STORE}) ProcessModel[] getProcessModels(Long[] ids)
      Deprecated.
      Use getProcessModelDescriptors(Long[]) or call getProcessModel(Long) iteratively instead.
      Retrieves multiple ProcessModel objects, representing the working drafts of the process models with the given IDs. This method will throw a PrivilegeException if an ID points to a ProcessModel to which the current user does not have "viewer" or higher privileges. If the information needed can be retrieved from ProcessModel.Descriptor consider calling the getProcessModelDescriptors(Long[]) method instead which is considerably faster.
      Parameters:
      ids - Unique IDs of the ProcessModel objects to retrieve
      Returns:
      The ProcessModel objects specified by ids_
      Throws:
      NullPointerException - if it is called with a null argument
      PrivilegeException - if the user does not have "viewer" or higher privileges for any of the referenced ProcessModels.

    • getProcessModelParameters

      @Read(K_PROCESS_DESIGN) ProcessVariable[] getProcessModelParameters(Long processModelId) throws InvalidProcessModelException, PrivilegeException, InvalidStateException, Exception
      Retrieves all of the process variables that are required to start an instance of the given process model (ie. process parameters).
      Parameters:
      processModelId - ID of the ProcessModel for which to retrieve the process parameters
      Returns:
      ProcessVariable objects which represent those variables which are required to start the given ProcessModel
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by processModelId_ does not exist.
      PrivilegeException - if the current User does not have permissions to get the ProcessModel's parameters
      InvalidStateException - if there is no published version of the specified pm, the published version is disabled, or if the process model contains sub process models that have been disabled or deleted. Note that all sub process models of a published process model must have been published, but they can still be disabled.
      Exception

    • getVisibleProcessVariables

      @Read(K_PROCESS_DESIGN) ProcessVariable[] getVisibleProcessVariables(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Retrieves all visible process variables associated with the given process model, or the process variables that are reportable through analytics and can be mapped in a subprocess relationship
      Parameters:
      processModelId - the unique Id of the process model to retrieve variables for
      Returns:
      the visible process variables of the process model specified
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by processModelId_ does not exist.
      PrivilegeException - if the current User does not have permissions to get the ProcessModel's parameters

    • getAssigneePoolACSchemas

      @Read(K_PROCESS_DESIGN) ActivityClassSchema[] getAssigneePoolACSchemas()
      Retrieves the activity class schemas for the activity classes that operate on the assignee pool. The assignee pool contains all users and groups which can be assigned a task, as chosen at design time.
      Returns:
      An array of ActivityClassSchema objects which represent the functions that operate on the assignee pool.

    • getAssignmentPoolACSchemas

      @Read(K_PROCESS_DESIGN) ActivityClassSchema[] getAssignmentPoolACSchemas()
      Retrieves the activity class schemas for the activity classes that operate on the assignment pool. The assignment pool contains all users and groups which are assigned a task at execution time.
      Returns:
      An array of ActivityClassSchema objects which represent the functions that operate on the assignment pool.

    • activateUserSession

      @Write(K_PROCESS_DESIGN) void activateUserSession(Long[] membership, Long[] administration, Long userTypeId, String username) throws InvalidUserException
      Notifies the Process application that a new session has been created for the current user, and provides information about the current user's membership and administration rights to groups.

      This method should be called every time the group membership role of the current user is changed (eg: from member to admin, etc), or when a new group is created, or when the current user was newly created. This method will skip any null values for membership_ or administration_. If the userTypeId_ is null, the method will fail but will NOT throw any exceptions

      Parameters:
      membership - An array of group IDs which represent the groups to which the current user belongs.
      administration - An array of group IDs which represent the groups for which the current user is an administrator.
      userTypeId - this is one of UserProfile.USER_TYPE_BASIC or UserProfile.USER_TYPE_SYS_ADMIN. If neither or null is given, UserProfile.USER_TYPE_BASIC will be assumed.
      username - the username of the user whose session is to be activated
      Throws:
      InvalidUserException

    • getEscalationACSchemas

      @Read(K_PROCESS_DESIGN) ActivityClassSchema[] getEscalationACSchemas()
      Retrieves the activity class schemas for activities that can be used as escalations.
      Returns:
      An array of ActivityClassSchema objects which represent all activity classes of type Escalation

    • deleteProcessModel

      @Write(K_PROCESS_DESIGN) void deleteProcessModel(Long processModelId_) throws InvalidProcessModelException, PrivilegeException
      Deletes a process model. A model can be deleted even if there are processes that have been created from it on any of the execution servers. These processes will continue after the process model has been deleted. To delete processes, use ProcessExecutionService.deleteProcess(java.lang.Long, boolean), and ProcessExecutionService.deleteProcesses(java.lang.Long[], boolean)
      Parameters:
      processModelId_ - the ID of the ProcessModel to delete.
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by processModelId_ does not exist.
      PrivilegeException - if the current User does not have permissions to delete the ProcessModel

    • deleteProcessModels

      @Write(K_PROCESS_DESIGN) void deleteProcessModels(Long[] processModelIds_) throws InvalidProcessModelException, PrivilegeException
      Deletes multiple ProcessModel objects. A model can only be deleted if there are no processes that have been created from it on any of the execution servers. To delete processes, use ProcessExecutionService.deleteProcess(java.lang.Long, boolean), and ProcessExecutionService.deleteProcesses(java.lang.Long[], boolean)
      Parameters:
      processModelIds_ - ids of process models to delete.
      Throws:
      InvalidProcessModelException - if a specified ProcessModel does not exist.
      PrivilegeException - if the current User does not have permissions to delete a specified ProcessModel

    • getProcessModelDescriptor

      @Read(K_PROCESS_DESIGN) ProcessModel.Descriptor getProcessModelDescriptor(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Retrieves a process model descriptor representing the working draft of a process model. This method will successfully return a valid descriptor even if the user only has "initiator" privileges over the specified ProcessModel.
      Parameters:
      processModelId - ID of the ProcessModel for which to get the descriptor
      Returns:
      ProcessModel.Descriptor specified by given processModelId_
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by processModelId_ does not exist
      PrivilegeException - if the current User does not have sufficient privileges to get the ProcessModel descriptor

    • getRecursiveRelationship

      @Read(K_PROCESS_DESIGN) int getRecursiveRelationship(Long processModelId, Long subProcessModelId) throws InvalidProcessModelException
      Return the status of the two process models' recursive relationship
      Parameters:
      processModelId - id of process model to check for recursive relationship
      subProcessModelId - subProcessModel to check for relationship with parent ProcessModel
      Returns:
      one of DOES_NOT_RECURSE, PARENT_PROCESS_RECURSES or SUBPROCESS_RECURSES
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by processModelId_ does not exist

    • getSubProcessModelDescriptorsForProcessModel

      @Deprecated @Read(K_PROCESS_DESIGN) ResultList getSubProcessModelDescriptorsForProcessModel(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Deprecated.
      use getSynchronousSubProcessModelDescriptorsForProcessModel(java.lang.Long) instead
      Gets a ResultList containing process model descriptors representing the working drafts of the subprocess models of the given process model
      Parameters:
      processModelId - the unique ID of the process model to get the sub process model descriptors for
      Returns:
      a ResultList containing ProcessModel.Descriptor objects that are subprocesses for the given process. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist
      Throws:
      InvalidProcessModelException - if the process model is invalid
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation

    • getSynchronousSubProcessModelDescriptorsForProcessModel

      @Read(K_PROCESS_DESIGN) ResultList getSynchronousSubProcessModelDescriptorsForProcessModel(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Gets a ResultList containing process model descriptors representing the working drafts of the sub-process models of the given process model
      Parameters:
      processModelId - the unique ID of the process model to get the sub-process model descriptors for
      Returns:
      a ResultList containing ProcessModel.Descriptor objects that are subprocesses for the given process. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist
      Throws:
      InvalidProcessModelException - if the process model is invalid
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation

    • getProcessModelDescriptorsContainingSubProcessModel

      @Deprecated @Read(K_PROCESS_DESIGN) ResultList getProcessModelDescriptorsContainingSubProcessModel(Long subProcessModelId) throws InvalidProcessModelException, PrivilegeException
      Deprecated.
      use getProcessModelDescriptorsContainingSynchronousSubProcessModel(java.lang.Long) instead
      Retrieves process model descriptors representing the working drafts of the process models that contain the given process model as a sub-process model
      Parameters:
      subProcessModelId - The ID of the sub process model which will be contained in the returned process models
      Returns:
      A ResultList which contains an array of ProcessModel.Descriptor objects representing those process models containing the given sub process model. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist
      Throws:
      InvalidProcessModelException - if the ProcessModel given by subProcessModelId_ is invalid
      PrivilegeException - if the current user does not have sufficient permissions to view the given process model

    • getProcessModelDescriptorsContainingSynchronousSubProcessModel

      @Read(K_PROCESS_DESIGN) ResultList getProcessModelDescriptorsContainingSynchronousSubProcessModel(Long subProcessModelId) throws InvalidProcessModelException, PrivilegeException
      Retrieves process model descriptors representing the working drafts of the process models that contain the given process model as a sub-process model
      Parameters:
      subProcessModelId - The ID of the sub-process model which will be contained in the returned process models
      Returns:
      A ResultList which contains an array of ProcessModel.Descriptor objects representing process models that contain the given sub process model. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist
      Throws:
      InvalidProcessModelException - if the ProcessModel given by subProcessModelId_ is invalid
      PrivilegeException - if the current user does not have sufficient permissions to view the given process model

    • getTopLevelProcessModelDescriptorsForSubProcessModel

      @Deprecated @Read(K_PROCESS_DESIGN) ResultList getTopLevelProcessModelDescriptorsForSubProcessModel(Long subProcessModelId) throws InvalidProcessModelException, PrivilegeException
      Deprecated.
      use getTopLevelProcessModelDescriptorsForSynchronousSubProcessModel(java.lang.Long) instead
      Gets a ResultList containing process model descriptors representing the working drafts of the top level process models of the given sub process model
      Parameters:
      subProcessModelId - the process model to get top level ProcessModel.Descriptor objects for
      Returns:
      a ResultList containing ProcessModel.Descriptor objects for all top level process models of the given sub process model. This will return an empty ResultList for models that solely form a recursive loop or if called on a top-level process model. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist
      Throws:
      InvalidProcessModelException - if the process model is invalid
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation

    • getTopLevelProcessModelDescriptorsForSynchronousSubProcessModel

      @Read(K_PROCESS_DESIGN) ResultList getTopLevelProcessModelDescriptorsForSynchronousSubProcessModel(Long subProcessModelId) throws InvalidProcessModelException, PrivilegeException
      Gets a ResultList containing process model descriptors that represent the working drafts of the top level process models of the given sub-process model
      Parameters:
      subProcessModelId - the process model to get top level ProcessModel.Descriptor objects for
      Returns:
      a ResultList containing ProcessModel.Descriptor objects for all top level process models of the given sub process model. This will return an empty ResultList for models that solely form a recursive loop or if called on a top-level process model. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist
      Throws:
      InvalidProcessModelException - if the process model is invalid
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation

    • getLinkProcessModelDescriptorsForProcessModel

      @Deprecated @Read(K_PROCESS_DESIGN) ResultList getLinkProcessModelDescriptorsForProcessModel(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Deprecated.
      Use getAsynchronousSubProcessModelDescriptorsForProcessModel(java.lang.Long) instead.
      Retrieve a list of process model descriptors representing the working drafts of the linked process models for a given process model.
      Parameters:
      processModelId - ID of the ProcessModel for which to retrieve the linked ProcessModel.Descriptor objects
      Returns:
      a ResultList containing ProcessModel.Descriptor objects which represent the linked ProcessModel objects for the specified ProcessModel. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by processModelId_ is invalid
      PrivilegeException - if the current user does not have sufficient privileges to access the ProcessModel

    • getAsynchronousSubProcessModelDescriptorsForProcessModel

      @Read(K_PROCESS_DESIGN) ResultList getAsynchronousSubProcessModelDescriptorsForProcessModel(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Retrieve a list of process model descriptors that represent the working drafts of all linked process models for the given process model.
      Parameters:
      processModelId - ID of the ProcessModel for which to retrieve the linked ProcessModel.Descriptor objects
      Returns:
      a ResultList containing ProcessModel.Descriptor objects which represent the linked ProcessModel objects for the specified ProcessModel. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by processModelId_ is invalid
      PrivilegeException - if the current user does not have sufficient privileges to access the ProcessModel

    • getProcessModelDescriptorsContainingLinkProcessModel

      @Deprecated @Read(K_PROCESS_DESIGN) ResultList getProcessModelDescriptorsContainingLinkProcessModel(Long linkProcessModelId) throws InvalidProcessModelException, PrivilegeException
      Deprecated.
      Use getProcessModelDescriptorsContainingAsynchronousSubProcessModel(java.lang.Long) instead.
      Retrieves process model descriptors that represent the working drafts of all process models that contain the given linked process model
      Parameters:
      linkProcessModelId - The ID of the linked ProcessModel which will be contained in the returned ProcessModel objects
      Returns:
      A ResultList which contains an array of ProcessModel.Descriptor objects which contain the linked ProcessModel specified by linkProcessModelId_. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist
      Throws:
      InvalidProcessModelException - if the linked ProcessModel does not exist
      PrivilegeException - if the current user does not have sufficient permissions to view the ProcessModel

    • getProcessModelDescriptorsContainingAsynchronousSubProcessModel

      @Read(K_PROCESS_DESIGN) ResultList getProcessModelDescriptorsContainingAsynchronousSubProcessModel(Long linkProcessModelId) throws InvalidProcessModelException, PrivilegeException
      Retrieves process model descriptors representing the working drafts of the process models that contain the given linked process model
      Parameters:
      linkProcessModelId - The ID of the linked ProcessModel which will be contained in the returned ProcessModel objects
      Returns:
      A ResultList which contains an array of ProcessModel.Descriptor objects which contain the linked ProcessModel specified by linkProcessModelId_. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist
      Throws:
      InvalidProcessModelException - if the linked ProcessModel does not exist
      PrivilegeException - if the current user does not have sufficient permissions to view the ProcessModel

    • getTopLevelProcessModelDescriptorsForLinkProcessModel

      @Deprecated @Read(K_PROCESS_DESIGN) ResultList getTopLevelProcessModelDescriptorsForLinkProcessModel(Long linkProcessModelId) throws InvalidProcessModelException, PrivilegeException
      Deprecated.
      use getTopLevelProcessModelDescriptorsForAsynchronousSubProcessModel(java.lang.Long) instead
      Gets a ResultList containing process model descriptors representing the working drafts of thetop level process models of the given linked process model
      Parameters:
      linkProcessModelId - the process model to get top level process model descriptors for
      Returns:
      a ResultList containing ProcessModel.Descriptor objects for all top level process models of the given linked process model. This will return an empty ResultList for models that solely form a recursive loop or if called on a top level process model.
      Throws:
      InvalidProcessModelException - if the process model is invalid
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation

    • getTopLevelProcessModelDescriptorsForAsynchronousSubProcessModel

      @Read(K_PROCESS_DESIGN) ResultList getTopLevelProcessModelDescriptorsForAsynchronousSubProcessModel(Long linkProcessModelId) throws InvalidProcessModelException, PrivilegeException
      Gets a ResultList containing process model descriptors that represent the working drafts of all parent process models for the given linked process model
      Parameters:
      linkProcessModelId - the process model to get top level process model descriptors for
      Returns:
      a ResultList containing ProcessModel.Descriptor objects for all top level process models of the given linked process model. This will return an empty ResultList for models that solely form a recursive loop or if called on a top level process model.
      Throws:
      InvalidProcessModelException - if the process model is invalid
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation

    • getSecurityForProcessApplication

      @Read(K_PROCESS_DESIGN) Security getSecurityForProcessApplication() throws PrivilegeException
      Gets the security settings of the Process Application
      Returns:
      the Security object (with all fields populated) that contains the security for the process application. The role maps in the Security object are ProcessApplicationRoleMap objects.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation

    • setSecurityForProcessApplication

      @Write(K_PROCESS_DESIGN) void setSecurityForProcessApplication(Security security) throws PrivilegeException, InvalidUserException
      Sets the security settings of the Process Application. Fields canInherit and inheritable will be ignored (doesInherit is not ignored).
      Parameters:
      security - a Security object which encapsulates the security settings of the Process Application. The role maps in the Security object must be ProcessRoleMap objects
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation
      InvalidUserException - if any user referenced in the Security does not exist

    • getSecurityForProcessModel

      @Read(K_PROCESS_DESIGN) Security getSecurityForProcessModel(Long id) throws InvalidProcessModelException, PrivilegeException
      Gets the security settings of a process model
      Parameters:
      id - the unique Id of the process model
      Returns:
      the Security object (with all fields populated) that contains the security settings of the process model. The role maps in the Security object are be ProcessRoleMap objects
      Throws:
      InvalidProcessModelException - if the ProcessModel specified does not exist
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation

    • setSecurityForProcessModel

      @Write(K_PROCESS_DESIGN) void setSecurityForProcessModel(Long id, Security security) throws InvalidProcessModelException, PrivilegeException, InvalidUserException
      Sets the security settings of a process model. This method does NOT set canInherit and inheritable (doesInherit is not ignored).
      Parameters:
      id - the unique Id of the process model
      security - a Security object which encapsulates the security settings of the process model. The role maps in the Security object must be ProcessRoleMap objects
      Throws:
      InvalidProcessModelException - if the ProcessModel specified does not exist
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation
      InvalidUserException - if any user referenced in the Security does not exist

    • setActorsInRolesForProcessApplication

      @Write(K_PROCESS_DESIGN) void setActorsInRolesForProcessApplication(String[] users, String[][] userRoles, Long[] groups, String[][] groupRoles) throws PrivilegeException, InvalidUserException, InvalidRoleException
      Adds and/or modifies the roles of users and groups on the Process Application. This method will only update the roles for the users and groups specified in the parameters. All other roles will not be changed. To overwrite the roles for all users and groups use setSecurityForProcessApplication(Security) See ProcessRoleMap for valid roles.
      Parameters:
      users - the list of users whose roles are to be added/modified. This parameter can be null, as long as userRoles_ is also null. If one is null and the other is not, a NullPointerException will be thrown.
      userRoles - a 2-dimentional array of size [users_.length][]. The String array userRoles_[i] represents the roles which users_[i] will have. (If this array is null or zero-length, the user have no explicit permissions in the Process Application role map). It is legal to have null within this array.
      groups - the list of groups whose roles are to be added/modified. This parameter can be null, as long as groupRoles_ is also null. If one is null and the other is not, a NullPointerException will be thrown.
      groupRoles - a 2-dimentional array of size [groups_.length][]. The String array groupRoles_[i] represents the roles which groups_[i] will have. (If this array is null or zero-length, the group have no explicit permissions in the Process Application role map). It is legal to have null within this array.
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation
      InvalidUserException - if any users does not exist
      InvalidRoleException - if an invalid role is passed to the method

    • setActorsInRolesForProcessModel

      @Write(K_PROCESS_DESIGN) void setActorsInRolesForProcessModel(Long id, String[] users, String[][] userRoles, Long[] groups, String[][] groupRoles) throws InvalidProcessModelException, PrivilegeException, InvalidUserException, InvalidRoleException
      Adds and/or modifies the roles of users and groups on a specified ProcessModel. This method will only overwrite the roles for the users and groups specified in the parameters. All other roles will not be changed. To overwrite the roles for all users and groups use setSecurityForProcessModel(Long, Security) See ProcessRoleMap for valid roles.
      Parameters:
      id - the unique Id of the process model
      users - the list of users whose roles are to be added/modified This parameter can be null, as long as userRoles_ is also null. If one is null and the other is not, a NullPointerException will be thrown.
      userRoles - a 2-dimentional array of size [users_.length][]. The String array userRoles_[i] represents the roles which users_[i] will have. (If this array is null or zero-length, the user have no explicit permissions in the process model role map)
      groups - the list of groups whose roles are to be added/modified This parameter can be null, as long as groupRoles_ is also null. If one is null and the other is not, a NullPointerException will be thrown.
      groupRoles - a 2-dimentional array of size [groups_.length][]. The String array groupRoles_[i] represents the roles which groups_[i] will have. (If this array is null or zero-length, the group have no explicit permissions in the process model role map)
      Throws:
      InvalidProcessModelException - if the ProcessModel specified does not exist
      PrivilegeException - if the current user does not have sufficient privileges to perform this operation
      InvalidUserException - if any users does not exist
      InvalidRoleException - if an invalid role is passed to the method

    • getPermissionsForProcessApplication

      @Read(K_PROCESS_DESIGN) ProcessApplicationPermissions getPermissionsForProcessApplication() throws InvalidUserException
      Retrieves permissions on the Process application for the current user
      Returns:
      ProcessApplicationPermissions object which contains the permissions for the current user on the Process Application
      Throws:
      InvalidUserException

    • getPermissionsForProcessModel

      @Read(K_PROCESS_DESIGN) ProcessModelPermissions getPermissionsForProcessModel(Long id) throws InvalidProcessModelException
      Retrieves permissions on a process model for the current user.
      Parameters:
      id - ID of the ProcessModel for which to get the ProcessModelPermissions
      Returns:
      ProcessModelPermissions object which contains the permissions on the process model for the current user.
      Throws:
      InvalidProcessModelException - if the ProcessModel specified does not exist

    • getPermissionsForProcessModels

      @Read(K_PROCESS_DESIGN) ProcessModelPermissions[] getPermissionsForProcessModels(Long[] ids) throws InvalidProcessModelException
      Retrieves permissions on multiple process models objects for the current user.
      Parameters:
      ids - Unique IDs of the process models for which to get the ProcessModelPermissions
      Returns:
      ProcessModelPermissions which contain the permissions on the process models for the current user
      Throws:
      InvalidProcessModelException - if a specified ProcessModel does not exist

    • getPriority

      @Read(K_PROCESS_DESIGN) Priority getPriority(Long priorityId) throws InvalidPriorityException
      Retrieves a Priority
      Parameters:
      priorityId - ID of the Priority to retrieve
      Returns:
      The Priority coresponding to priorityId_
      Throws:
      InvalidPriorityException - if the Priority does not exist

    • getDefaultPriority

      @Read(K_PROCESS_DESIGN) Priority getDefaultPriority()
      Retrieves the default Priority for the system.
      Returns:
      The default Priority; null if no default is configured.

    • setDefaultPriority

      @Write(K_PROCESS_DESIGN) void setDefaultPriority(Long priorityId) throws InvalidPriorityException, IllegalArgumentException
      Sets the default Priority that the Process Application will use.
      Parameters:
      priorityId - the ID of the priority to set as the default priority
      Throws:
      InvalidPriorityException - if the specificed priority does not exist
      IllegalArgumentException - if a null argument is passed

    • getPriorityOfProcessModel

      @Read(K_PROCESS_DESIGN) Priority getPriorityOfProcessModel(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Retrieves the priority for a ProcessModel.
      Parameters:
      processModelId - ID of the ProcessModel for which to retrieve the Priority
      Returns:
      The Priority for the ProcessModel specified by processModelId_
      Throws:
      InvalidProcessModelException - if the specified ProcessModel does not exist
      PrivilegeException - if the current user does not have privileges to view the process model

    • setPriorityOfProcessModel

      @Write(K_PROCESS_DESIGN) void setPriorityOfProcessModel(Long processModelId, Long priorityId) throws InvalidPriorityException, InvalidProcessModelException, PrivilegeException
      Sets the priority of a process model
      Parameters:
      processModelId - the unique id of the process model to set the priority of
      priorityId - the unique id of the priority to set
      Throws:
      InvalidPriorityException - if the priority does not exist
      InvalidProcessModelException - if the process model does not exist
      PrivilegeException - if the current user does not have sufficient permissions to perform this action

    • lockProcessModel

      @Write(K_PROCESS_DESIGN) void lockProcessModel(Long processModelId, boolean override) throws InvalidProcessModelException, PrivilegeException, LockException
      Locks the specified process model
      Parameters:
      processModelId - the unique ID of the process model to lock
      override - whether or not to override the lock another user has placed on the process model
      Throws:
      InvalidProcessModelException - if the process model does not exist
      PrivilegeException - if the user does not have access to lock (or override the existing lock, if specified) of the process model
      LockException - if the process model is already locked (by someone other than the user) and the user did not choose to override it.

    • getProcessModelVersion

      @Read(K_PROCESS_DESIGN) ProcessModel getProcessModelVersion(Long processModelId, String version) throws InvalidProcessModelException, InvalidVersionException, PrivilegeException
      Retrieves a version of a ProcessModel. If the version is null or empty, it returns the latest saved draft.
      Parameters:
      processModelId - ID of the ProcessModel whose version will be retrieved
      version - The version of the ProcessModel to retrieve
      Returns:
      The ProcessModel given by processModelId_ and version_
      Throws:
      InvalidProcessModelException - if the ProcessModel does not exist
      InvalidVersionException - if the ProcessModel does not have the given version
      PrivilegeException - if the current user does not have sufficient permissions to view the ProcessModel version

    • exportProcessModelVersion

      @Read(K_PROCESS_DESIGN) ProcessModel exportProcessModelVersion(Long processModelId, String version) throws InvalidProcessModelException, InvalidVersionException, PrivilegeException
      Retrieves a version of a ProcessModel. If the version is null or empty, it returns the latest saved draft. Unlike getProcessModelVersion(java.lang.Long, java.lang.String), this API does not convert rule uuids to names (within expressions). Therefore this API should be used when retrieving a model for export.
      Parameters:
      processModelId - ID of the ProcessModel whose version will be retrieved
      version - The version of the ProcessModel to retrieve
      Returns:
      The ProcessModel given by processModelId_ and version_
      Throws:
      InvalidProcessModelException - if the ProcessModel does not exist
      InvalidVersionException - if the ProcessModel does not have the given version
      PrivilegeException - if the current user does not have sufficient permissions to view the ProcessModel version

    • versionProcessModel

      @Write({K_PROCESS_DESIGN,OBJECT_STORE}) ProcessModel versionProcessModel(ProcessModel pm) throws InvalidProcessModelException, PrivilegeException, LockException, InvalidUserException
      Versions a process model in the database based on the input parameter. See createProcessModel(com.appiancorp.suiteapi.process.ProcessModel) for the properties that must be populated on the process model. It creates a new process model if the process model Id is set to -1.
      Parameters:
      pm - a ProcessModel object representing the new process model version
      Returns:
      a ProcessModel object representing the versioned process model
      Throws:
      InvalidProcessModelException - if the ID of the process model does not correspond to a valid process model
      PrivilegeException - if the user does not have privileges to version the process model
      LockException - if the process model is locked by someone other than the current user
      InvalidUserException - if any of the users referenced in the ProcessModel do not exist

    • versionProcessModel

      @Write({K_PROCESS_DESIGN,OBJECT_STORE}) ProcessModel versionProcessModel(ProcessDiagram pm) throws InvalidProcessModelException, PrivilegeException, LockException, InvalidUserException
      The returned process model is not transformed.
      Throws:
      InvalidProcessModelException
      PrivilegeException
      LockException
      InvalidUserException

    • getProcessModelsForFolder

      @Read(K_PROCESS_DESIGN) ResultPage getProcessModelsForFolder(Long folderId, int startIndex, int batchSize, Integer sortProperty, Integer sortOrder) throws InvalidFolderException, PrivilegeException
      Retrieve process model descriptors representing the working drafts of the process models directly in a process model folder
      Parameters:
      folderId - ID of the ProcessModelFolder for which to retrieve all contained ProcessModel objects
      startIndex - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      batchSize - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
      sortProperty - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants located in ProcessModel.Descriptor
      sortOrder - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      Returns a ResultPage which contains an array of ProcessModel.Descriptor objects
      Throws:
      InvalidFolderException - if the ProcessModelFolder does not exist
      PrivilegeException - if the current user does not have permission to access the folder

    • getChildFolders

      @Read(K_PROCESS_DESIGN) ResultPage getChildFolders(Long folderId, int startIndex, int batchSize, Integer sortProperty, Integer sortOrder) throws InvalidFolderException, PrivilegeException
      Gets all the direct child folders of a process model folder
      Parameters:
      folderId - id of the folder for which to get child folders
      startIndex - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      batchSize - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
      sortProperty - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants located in ProcessModelFolder
      sortOrder - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      Returns a ResultPage which contains an array of ProcessModelFolder objects
      Throws:
      InvalidFolderException - if the ProcessModelFolder specified by folderId_ does not exist
      PrivilegeException - if the current user does not have access to the ProcessModelFolder

    • getTopLevelFolders

      @Read(K_PROCESS_DESIGN) ResultPage getTopLevelFolders(int startIndex, int batchSize, Integer sortProperty, Integer sortOrder)
      Returns the top level folders in the process application that the current user can see.
      Parameters:
      startIndex - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      batchSize - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
      sortProperty - the property by which the results will be sorted This is one of the SORT_BY_XXX constants located in ProcessModelFolder
      sortOrder - the order in which the results will be sorted This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage of ProcessModelFolder objects representing the top level folders

    • getVersionsForProcessModel

      @Read(K_PROCESS_DESIGN) ResultPage getVersionsForProcessModel(Long processModelId, int startIndex, int batchSize, Integer sortProperty, Integer sortOrder) throws InvalidProcessModelException, PrivilegeException
      Gets the versions for a process model
      Parameters:
      processModelId - the id of the process model to get versions for
      startIndex - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      batchSize - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
      sortProperty - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants located in ProcessModel.Descriptor
      sortOrder - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      A ResultPage containing ProcessModel.Descriptor objects representing the versions of the specified process model.
      Throws:
      InvalidProcessModelException - if the process model does not exist
      PrivilegeException - if the user does not have permissions to view the process model

    • setActorsInRolesForFolder

      @Write(K_PROCESS_DESIGN) void setActorsInRolesForFolder(Long folderId, String[] users, String[][] userRoles, Long[] groups, String[][] groupRoles) throws InvalidFolderException, PrivilegeException, InvalidUserException, InvalidRoleException
      Sets actors (users and groups) in roles for a process model folder. This method will only overwrite the roles for the users and groups specified in the parameters. All other roles will not be changed. To overwrite the roles for all users and groups use setSecurityForFolder(Long, Security) See ProcessRoleMap for valid roles.
      Parameters:
      folderId - the unique id of the process model folder
      users - the list of users (user names) whose roles are to be added/modified This parameter can be null, as long as userRoles_ is also null. If one is null and the other is not, a NullPointerException will be thrown.
      userRoles - a 2-dimensional array of size [users_.length]. The String array userRoles_[i] represents the roles which users_[i] will have. (If this array is null or zero-length, the user has no explicit permissions in the process model folder's role map)
      groups - the list of groups whose roles are to be added/modified This parameter can be null, as long as groupRoles_ is also null. If one is null and the other is not, a NullPointerException will be thrown.
      groupRoles - a 2-dimentional array of size [groups_.length]. The String array groupRoles_[i] represents the roles which groups_[i] will have. (If this array is null or zero-length, the group has no explicit permissions in the process model folder's role map)
      Throws:
      InvalidFolderException - if the folder does not exist
      PrivilegeException - if the user does not have permission to perform the operation
      InvalidUserException - if any of the users do not exist
      InvalidRoleException - if an invalid role is passed to the method

    • unlockProcessModel

      @Write(K_PROCESS_DESIGN) void unlockProcessModel(Long processModelId, boolean override) throws InvalidProcessModelException, PrivilegeException, LockException
      Unlocks the given process model
      Parameters:
      processModelId - the unique id of the process model to unlock
      override - whether or not to break a lock on the given process model, if it is currently locked by someone other than the current user
      Throws:
      InvalidProcessModelException - if the process model does not exist
      LockException - if the process model is already locked and the user has not specified to override it
      PrivilegeException - if the user does not have privileges to unlock the process model

    • unlockProcessModels

      @Write(K_PROCESS_DESIGN) void unlockProcessModels()
      Unlocks all process models locked by the current user.

    • getFolder

      @Read(K_PROCESS_DESIGN) ProcessModelFolder getFolder(Long folderId) throws InvalidFolderException, PrivilegeException
      Retrieves a ProcessModelFolder.
      Parameters:
      folderId - ID of the ProcessModelFolder to retrieve
      Returns:
      a ProcessModelFolder specified by folderId_
      Throws:
      InvalidFolderException - if the ProcessModelFolder does not exist
      PrivilegeException - if the current User does not have permission to access to the folder

    • getFolders

      @Read(K_PROCESS_DESIGN) ResultList getFolders(Long[] folderIds)
      Retrieves multiple process model folders
      Parameters:
      folderIds - Unique IDs of the process model folders to retrieve.
      Returns:
      A ResultList which contains an array of ProcessModelFolder objects, and result codes. In the case where there is an exception (such as access restriction) the ResultList.getResultCodes() will have an entry for every id passed to it, but the Result.getResults() will only have an entry for every valid result returned. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified folder does not exist

    • startProcessVersion

      @Deprecated @Write(K_PROCESS_DESIGN) Long startProcessVersion(Long processModelId, ProcessVariable[] variables, String version, Long priorityId) throws InvalidProcessModelException, InvalidPriorityException, InvalidVersionException, PrivilegeException, InvalidStateException, StorageLimitException, InvalidUserException, IllegalArgumentException, Exception
      Deprecated.
      Use initiateProcess(Long, ProcessStartConfig), which has better enforcement of required parameters (requires that their values not be null or empty)
      Starts an instance of the given process model version, using the given variables to initialize state.
      Parameters:
      processModelId - id of process model to start
      variables - parameters for the process model. If using a process variable of an Appian type, do not set the value to that object but instead to the corresponding primitive. For instance, do not assign a User process variable a User object. Instead, assign that process variable a String containing the username. Likewise, assign a process variable of type Group should be assigned a Long, etc. The exception to this rule is the People type. Process variables of type People should be assigned a LocalObject.
      version - version of the given process model to start
      priorityId - priority of the process model to start, null if the default priority is to be used
      Returns:
      The id of the started process instance.
      Throws:
      InvalidProcessModelException - if the process model is invalid
      InvalidPriorityException - if the priority is invalid
      InvalidVersionException - if the version is invalid
      PrivilegeException - if the user does not have privileges to perform this
      InvalidStateException - if the version does not exist
      StorageLimitException - if all execution servers are full
      InvalidUserException - if any of the users users referenced by a ProcessVariable does not exist
      IllegalArgumentException - if the ProcessModel requires process parameters to start, and the variables_ parameter is null, an empty array, or does not contain all necessary process parameters.
      Exception

    • getProcessModelProperties

      @Read(K_PROCESS_DESIGN) ProcessModelProperties getProcessModelProperties(Long modelId) throws PrivilegeException, InvalidProcessModelException
      Retrieves the ProcessModelProperties representing the working draft of a ProcessModel.
      Parameters:
      modelId - ID of the ProcessModel for which to retrieve the ProcessModelProperties
      Returns:
      A ProcessModelProperties object which contains the properties for the ProcessModel given by modelId_
      Throws:
      PrivilegeException - if the current user does not have sufficient privileges to view the ProcessModel
      InvalidProcessModelException - if the ProcessModel does not exist

    • getMaximumNumberOfNotes

      @Deprecated @Read(K_PROCESS_DESIGN) int getMaximumNumberOfNotes()
      Deprecated.
      since 23.2
      Returns the maximum number of notes that can be added to a process model or process node. This property can be configured in pc.properties
      Returns:
      The maximum number of notes

    • getMaximumNumberOfAttachments

      @Read(K_PROCESS_DESIGN) int getMaximumNumberOfAttachments()
      Returns the maximum number of attachments that can be added to a process model or process node. This property can be configured in pc.properties
      Returns:
      The maximum number of attachments

    • getUnpublishedChildrenForProcessModel

      @Read(K_PROCESS_DESIGN) ResultList getUnpublishedChildrenForProcessModel(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Returns the working draft of the unpublished children (sub process models) of the given process model
      Parameters:
      processModelId - the id of the process model to get unpublished children for
      Returns:
      a ResultList containing ProcessModel.Descriptor objects of the process model's unpublished children The result codes are as follows: UNPUBLISHED_CHILDREN_VIEW_PERMISSIONS = No permissions, cannot view process model; UNPUBLISHED_CHILDREN_INVALID = Invalid Process Model (a process model that cannot be run); UNPUBLISHED_CHILDREN_PUBLISH_PERMISSIONS = No permissions to publish the process model; UNPUBLISHED_CHILDREN_SUCCESS = Success
      Throws:
      InvalidProcessModelException - if the process model does not exist
      PrivilegeException

    • getParentsForProcessModel

      @Read(K_PROCESS_DESIGN) ResultList getParentsForProcessModel(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Retrieves the working drafts of the parents of a ProcessModel. If the process model is not a sub process model in any other process model, the returned ResultList will have an empty result set.
      Parameters:
      processModelId - ID of the ProcessModel for which to get the parents.
      Returns:
      a ResultList containing an array of ProcessModel.Descriptor objects which represent the parents of the ProcessModel specified by processModelId_. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist
      Throws:
      InvalidProcessModelException - if the ProcessModel does not exist.
      PrivilegeException - if the user does not have privileges to view the process model

    • getParentsOfUnpublishedChildrenForProcessModel

      @Read(K_PROCESS_DESIGN) ResultList getParentsOfUnpublishedChildrenForProcessModel(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Returns the working drafts of the parents of the unpublished children (sub process models) of a ProcessModel. Does not return the ProcessModel itself or its parents.
      Parameters:
      processModelId - ID of the ProcessModel for which to retrieve the parents of the unpublished children.
      Returns:
      A ResultList containing an array of ProcessModel.Descriptor objects which represent the parents of the unpublished children of the ProcessModel specified by processModelId_. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist
      Throws:
      InvalidProcessModelException - if the ProcessModel does not exist
      PrivilegeException - if the user does not have privileges to view the process model

    • publishProcessModel

      @Deprecated @Write({K_PROCESS_DESIGN,OBJECT_STORE}) ProcessModel publishProcessModel(ProcessModel processModel) throws InvalidProcessModelException, PrivilegeException, LockException, InvalidStateException, InvalidUserException
      Deprecated.
      use saveAndPublishProcessModel
      Publishes a process model. Unpublished children of the process model will be published and owners of the affected process models will be notified
      Parameters:
      processModel - process model to publish
      Returns:
      the published process model. The process model is transformed.
      Throws:
      InvalidProcessModelException - if the ID of the process model does not correspond to a valid ID
      PrivilegeException - if the user does not have privileges to publish the process model
      LockException - if the process model is locked
      InvalidStateException - if the process model is in an invalid state (not validated)
      InvalidUserException - if any of the users referenced by the ProcessModel does not exist

    • saveAndPublishProcessModel

      @Write({K_PROCESS_DESIGN,OBJECT_STORE}) ProcessModelWithErrors saveAndPublishProcessModel(ProcessModel processModel, boolean overrideLock) throws InvalidProcessModelException, PrivilegeException, LockException, InvalidStateException, InvalidUserException, InvalidUuidException, InvalidFolderException, InvalidPriorityException
      Attempts to lock, save, validate, and publish the given model. If the model is new, we try to create, lock, validate, and publish. The resulting data structure contains the model that was written to the database (published if everything worked, saved if only the save worked, and null if nothing worked), along with any validation errors or warnings that were detected. During the save portion, the method can throw any of the exceptions that would be thrown by createProcessModel or updateProcessModel. If the model contains any sub-processes that are unpublished, then the ProcessModel.Descriptor objects are returned for those models that were published and owners notified, those that cannot be published and those parents of unpublished children that were notified.
      Parameters:
      processModel - the model to save and publish
      overrideLock - whether to lock the model if it is already locked
      Returns:
      a ProcessModelWithErrors data structure holding the saved and/or published model and descriptions of any errors that occurred
      Throws:
      InvalidProcessModelException - if the ID of the process model does not correspond to a valid ID
      PrivilegeException - if the user does not have privileges to save or publish the process model
      LockException - if the process model is locked and we cannot override
      InvalidStateException - if the process model is in an invalid state (not validated)
      InvalidUserException - if any of the users referenced in the ProcessModel do not exist
      InvalidUuidException - if any of the UUIDs referenced do not exist
      InvalidFolderException - if folder ID where processModel is to be saved does not exist
      InvalidPriorityException - if priority for the processModel is invalid

    • getVisibleProcessVariablesForVersion

      @Read(K_PROCESS_DESIGN) ProcessVariable[] getVisibleProcessVariablesForVersion(Long processModelId, String version) throws InvalidProcessModelException, InvalidVersionException, PrivilegeException
      Retrieves all visible process variables associated with the given process model version, or the process variables that are reportable through analytics and can be mapped in a subprocess relationship
      Parameters:
      processModelId - the unique Id of the process model to retrieve variables for
      version - version to get the parameters for
      Returns:
      the visible process variables of the process model specified by the id and version given
      Throws:
      InvalidProcessModelException - if the process model does not exist
      InvalidVersionException - if the version does not exsit
      PrivilegeException - if the user does not have sufficient privileges to perform the operation

    • getProcessModelParametersForVersion

      @Read(K_PROCESS_DESIGN) ProcessVariable[] getProcessModelParametersForVersion(Long processModelId, String version) throws InvalidProcessModelException, InvalidVersionException, PrivilegeException, Exception
      Retrieves all of the process variables that are required to start an instance of the given process model version (ie. process parameters)
      Parameters:
      processModelId - ID of the ProcessModel for which to retrieve ProcessParameters
      version - The version of the ProcessModel for which to retrieve ProcessParameters (use null to refer to a draft)
      Returns:
      ProcessVariable objects which represent those variables which are required to start the ProcessModel version given by processModelId_ and version_
      Throws:
      InvalidProcessModelException - if the ProcessModel does not exist
      InvalidVersionException - if the ProcessModel version does not exist
      PrivilegeException - if the current User does not have permissions to view the ProcessModel
      Exception

    • getCountProcessModelParametersForVersion

      @Read(K_PROCESS_DESIGN) int getCountProcessModelParametersForVersion(Long processModelId, String version) throws InvalidProcessModelException, InvalidVersionException, PrivilegeException, Exception
      Retrieves count of all of the process variables that are required to start an instance of the given process model version (ie. process parameters)
      Parameters:
      processModelId - ID of the ProcessModel for which to retrieve ProcessParameters
      version - The version of the ProcessModel for which to retrieve ProcessParameters (use null to refer to a draft)
      Returns:
      ProcessVariable objects which represent those variables which are required to start the ProcessModel version given by processModelId_ and version_
      Throws:
      InvalidProcessModelException - if the ProcessModel does not exist
      InvalidVersionException - if the ProcessModel version does not exist
      PrivilegeException - if the current User does not have permissions to view the ProcessModel
      Exception

    • updateFolder

      @Write(K_PROCESS_DESIGN) ProcessModelFolder updateFolder(ProcessModelFolder folder) throws PrivilegeException, IllegalArgumentException, InvalidFolderException, RecursiveRelationshipException
      Updates a process model folder. The following fields must be populated in the ProcessModelFolder object: id, name, description, and parentFolderId
      Parameters:
      folder - a ProcessModelFolder object containing the properties of the folder to update. This methods will update name, description and parentFolderId. Other fields will not be updated.
      Returns:
      a ProcessModelFolder object representing the updated folder
      Throws:
      PrivilegeException - if the user does not have permissions to perform this action
      IllegalArgumentException - if the type of the folder is different from the previous type (not thrown if the new type is null, in which case the new type is ignored)
      InvalidFolderException - if the ID of the folder does not correspond to a valid folder, or if the ID of the parent folder is invalid
      RecursiveRelationshipException - if the update would result in a loop in the tree of parent folders

    • createFolder

      @Write(K_PROCESS_DESIGN) ProcessModelFolder createFolder(ProcessModelFolder folder) throws PrivilegeException, IllegalArgumentException, DuplicateUuidException
      Creates a folder for storing process models. The following fields are required for the ProcessModelFolder object: name, and type
      Parameters:
      folder - The ProcessModelFolder to create.
      Returns:
      The created ProcessModelFolder
      Throws:
      PrivilegeException - if the current user does not have permissions to create a ProcessModelFolder
      IllegalArgumentException - if the type of folder is invalid. It must be one of two types: ProcessModelFolder.TYPE_COMMUNITY or ProcessModelFolder.TYPE_PRIVATE. This exception will also be thrown if the parent folder is invalid (Top level folders must have a null parent folder id).
      DuplicateUuidException - if the UUID of the folder already exists

    • disableProcessModel

      @Write(K_PROCESS_DESIGN) void disableProcessModel(Long processModelId, String version) throws InvalidProcessModelException, PrivilegeException, InvalidVersionException
      Disables a version of a ProcessModel.
      Parameters:
      processModelId - ID of the ProcessModel on which to disable a version.
      version - The ID of the version to disable.
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by processModelId_ does not exist.
      PrivilegeException - if the current User does not have sufficient permissions to disable a version
      InvalidVersionException - if the given version does not exist for the ProcessModel

    • enableProcessModel

      @Write(K_PROCESS_DESIGN) void enableProcessModel(Long processModelId, String version) throws InvalidProcessModelException, PrivilegeException, InvalidVersionException
      Enables a ProcessModel version.
      Parameters:
      processModelId - The ID of the ProcessModel which has the version to enable.
      version - The name of the version to enable
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by processModelId_ does not exist.
      PrivilegeException - if the current user does not have sufficient permissions to enable the version.
      InvalidVersionException - if the given version does not exist for the ProcessModel

    • deleteFolders

      @Write(K_PROCESS_DESIGN) ResultList deleteFolders(Long[] folders)
      Deletes a list of folders
      Parameters:
      folders - The ProcessModelFolder objects to delete.
      Returns:
      a ResultList containing result codes for each deletion. Possible values are: ResultList.CODE_NO_PERMISSION if the user does not have permission, ResultList.CODE_INVALID if the folder does not exist or is not empty, and ResultList.CODE_VALID if the delete succeeded.

    • deleteFolder

      @Write(K_PROCESS_DESIGN) void deleteFolder(Long folderId) throws InvalidFolderException, PrivilegeException, InvalidStateException
      Deletes a ProcessModelFolder
      Parameters:
      folderId - id of the ProcessModelFolder to delete.
      Throws:
      InvalidFolderException - if the ProcessModelFolder specified by folderId_ does not exist.
      PrivilegeException - if the current user does not have sufficient privileges to delete the ProcessModelFolder.
      InvalidStateException - if the ProcessModelFolder is not empty (it must not contain sub-folders or process models)

    • updateFolders

      @Write(K_PROCESS_DESIGN) ResultList updateFolders(ProcessModelFolder[] processModelFolders) throws RecursiveRelationshipException
      Updates a list of process model folders. The following fields must be populated in each ProcessModelFolder object: id, name, description, and parentFolderId
      Parameters:
      processModelFolders - an array of ProcessModelFolder objects each containing the properties of the folders to update. This method will update name, description, parentFolderId. Other fields will not be updated.
      Returns:
      a ResultList containing the updated ProcessModeFolder objects and result codes for the operations. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified folder does not exist or its parent folder does not exist
      Throws:
      RecursiveRelationshipException - if the updates would result in a loop in the tree of parent folders

    • updateProcessModelsWithDescriptors

      @Write({K_PROCESS_DESIGN,OBJECT_STORE}) ResultList updateProcessModelsWithDescriptors(ProcessModel.Descriptor[] descriptors)
      Updates process models in the database. In order to update a ProcessModel.Descriptor at least the following fields must be populated: id and processName
      Parameters:
      descriptors - the ProcessModel.Descriptor objects that represent the process models to update
      Returns:
      A result list containing the updated ProcessModel.Descriptor objects and a list of result codes for the operations. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have permission, or ResultList.CODE_INVALID if the specified process model does not exist

    • getSecurityForFolder

      @Read(K_PROCESS_DESIGN) Security getSecurityForFolder(Long folderId) throws InvalidFolderException, PrivilegeException
      Gets the security for a process model folder
      Parameters:
      folderId - the unique Id of the folder to retrieve security for
      Returns:
      the Security object (with all fields populated) that contains that security settings for the folder. The role maps in the Security object are be ProcessRoleMap objects
      Throws:
      InvalidFolderException - if the folder doesn't exist
      PrivilegeException - if the user doesn't have privileges

    • setSecurityForFolder

      @Write(K_PROCESS_DESIGN) void setSecurityForFolder(Long folderId, Security security) throws PrivilegeException, InvalidFolderException, InvalidUserException
      Sets the security for a process model folder. Fields canInherit and inheritable will be ignored (doesInherit is not ignored).
      Parameters:
      folderId - the unique id of the folder to set security for
      security - a Security object representing the security to set. The role maps in the Security object must be ProcessRoleMap objects
      Throws:
      PrivilegeException - if the user doesn't have privileges
      InvalidFolderException - if the folder doesn't exist
      InvalidUserException - if any of the users referenced by the Security does not exist

    • getProcessModelDescriptors

      @Read(K_PROCESS_DESIGN) ResultList getProcessModelDescriptors(Long[] pmIds)
      Retrieves multiple process model descriptors, representing the working drafts of the given process models
      Parameters:
      pmIds - Unique IDs of the ProcessModel objects for which to retrieve descriptors
      Returns:
      A ResultList which contains an array of ProcessModel.Descriptor objects and an array of result codes which correspond to each ID. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have viewer permission, or ResultList.CODE_INVALID if the specified process model does not exist

    • getProcessModelsLatestPublishedDescriptors

      @Read(K_PROCESS_DESIGN) ResultList getProcessModelsLatestPublishedDescriptors(Long[] pmIds)
      Retrieves multiple process model descriptors, representing the latest published version or a draft if there is no publish version. The list of results is the same length and in the same order as the input IDs. Invalid results will be represented by a null in the result list.
      Parameters:
      pmIds - Unique IDs of the ProcessModel objects for which to retrieve descriptors
      Returns:
      A ResultList which contains an array of ProcessModel.Descriptor objects and an array of result codes which correspond to each ID. The result codes can be: ResultList.CODE_VALID if the action succeeded, ResultList.CODE_NO_PERMISSION if the user does not have viewer permission, or ResultList.CODE_INVALID if the specified process model does not exist

    • getProcessModelVersionDescriptor

      @Read(K_PROCESS_DESIGN) ProcessModel.Descriptor getProcessModelVersionDescriptor(Long processModelId, String version) throws InvalidProcessModelException, InvalidVersionException, PrivilegeException
      Retrieves the process model descriptor for a version of a ProcessModel. If null is given as a parameter for version, the returned value will be the descriptor of the draft.
      Parameters:
      processModelId - ID of the ProcessModel whose version will be retrieved
      version - The version of the ProcessModel for which to get the ProcessModel.Descriptor
      Returns:
      ProcessModel.Descriptor for the ProcessModel given by processModelId_ and version_
      Throws:
      InvalidProcessModelException - if the ProcessModel does not exist
      InvalidVersionException - if the version of the process model does not exist
      PrivilegeException - if the current user does not have permissions to view the ProcessModel or version

    • moveProcessModel

      @Write(K_PROCESS_DESIGN) void moveProcessModel(Long processModelId, Long parentFolderId) throws InvalidProcessModelException, InvalidFolderException, PrivilegeException
      Moves a process model to a new process model folder
      Parameters:
      processModelId - the unique id of process model to move
      parentFolderId - the unique id of new parent folder
      Throws:
      InvalidProcessModelException - if the process model does not exist
      InvalidFolderException - if the folder does not exist
      PrivilegeException - if the user does not have permissions to move the given process model to the given folder

    • moveFolder

      @Write(K_PROCESS_DESIGN) void moveFolder(Long folderId, Long parentFolderId) throws InvalidFolderException, PrivilegeException, RecursiveRelationshipException
      Moves a process model folder
      Parameters:
      folderId - the unique id of the process model folder to move
      parentFolderId - the unique id of the new parent folder
      Throws:
      InvalidFolderException - if the folder or the new parent folder does not exist
      PrivilegeException - if the user does not have permissions to perform this action
      RecursiveRelationshipException - if the move would result in a loop in the tree of parent folders

    • getPermissionsForFolder

      @Read(K_PROCESS_DESIGN) ProcessModelFolderPermissions getPermissionsForFolder(Long folderId) throws InvalidFolderException, PrivilegeException
      Retrieves ProcessModelFolderPermissions for a ProcessModelFolder
      Parameters:
      folderId - ID of ProcessModelFolder for which to get ProcessModelFolderPermissions
      Returns:
      A ProcessModelFolderPermissions object which contains permissions for the folder.
      Throws:
      InvalidFolderException - if the ProcessModelFolder does not exist
      PrivilegeException - if the current user does not have sufficient permissions to view the ProcessModelFolderPermissions for the folder

    • getPermissionsForFolders

      @Read(K_PROCESS_DESIGN) ProcessModelFolderPermissions[] getPermissionsForFolders(Long[] folderIds) throws InvalidFolderException, PrivilegeException
      Retrieves ProcessModelFolderPermissions objects for multiple ProcessModelFolder objects.
      Parameters:
      folderIds - Unique IDs of ProcessModelFolder objects for which to get permissions
      Returns:
      An array of ProcessModelFolderPermissions objects which contain the permissions for the folders.
      Throws:
      InvalidFolderException - if any of the ProcessModelFolder objects do not exist
      PrivilegeException - if the current User does not have sufficient permissions to view the ProcessModelFolderPermissions for any of the folders

    • setInheritanceForFolder

      @Write(K_PROCESS_DESIGN) void setInheritanceForFolder(Long folderId, boolean inherits) throws PrivilegeException, InvalidFolderException
      Sets the inheritance for a process model folder
      Parameters:
      folderId - the unique id of the folder
      inherits - if the folder inherits permissions from its parent
      Throws:
      PrivilegeException - if the user does not have permission to perform this action
      InvalidFolderException - if the folder does not exist

    • deleteProcessModelVersion

      @Write(K_PROCESS_DESIGN) ProcessModel.Descriptor deleteProcessModelVersion(Long processModelId, String version) throws InvalidProcessModelException, InvalidVersionException, PrivilegeException
      Deletes a version of a ProcessModel.
      Parameters:
      processModelId - ID of the ProcessModel
      version - ID of the version to delete. If null, the process model will be deleted.
      Returns:
      Descriptor from before the version is deleted
      Throws:
      InvalidProcessModelException - if the ProcessModel does not exist.
      InvalidVersionException - if the version does not exist for the ProcessModel.
      PrivilegeException - if the current user does not have sufficient permissions to delete the ProcessModel version.

    • getBusinessEntity

      @Read(K_PROCESS_DESIGN) BusinessEntity getBusinessEntity()
      Retrieves the BusinessEntity which has been created on the system.
      Returns:
      The BusinessEntity in the system. Returns null if no BusinessEntity has been created.

    • createBusinessEntity

      @Write(K_PROCESS_DESIGN) void createBusinessEntity(BusinessEntity business) throws IllegalArgumentException
      Creates a BusinessEntity for use with Web Services.
      Parameters:
      business - The BusinessEntity to create. Minimum required fields are: uuid, organizationName, and contactInformation. All fields in the contactInformation bean are required (non-null and non-empty Strings).
      Throws:
      IllegalArgumentException - if any of the required fields or any of the fields in the contactInformation bean is null or empty.

    • updateBusinessEntity

      @Write(K_PROCESS_DESIGN) void updateBusinessEntity(BusinessEntity business) throws NullPointerException
      Updates a BusinessEntity.
      Parameters:
      business - a BusinessEntity object. Minimum required fields are: uuid, organizationName, and contactInformation.
      Throws:
      NullPointerException - if,
      • the required fields in the argument are null or empty.
      • the contactInformation field of the argument is a list and any entry of this list is null or empty.
      • the argument itself is null

    • getProcessModelWebServices

      @Read(K_PROCESS_DESIGN) ResultPage getProcessModelWebServices(int startIndex, int batchSize, Integer sortProperty, Integer sortOrder)
      Retrieves all ProcessModelWebService objects on the server.
      Parameters:
      startIndex - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      batchSize - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
      sortProperty - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in ProcessModelWebService
      sortOrder - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      A ResultPage which contains an array of ProcessModelWebService objects.

    • createProcessModelWebService

      @Write(K_PROCESS_DESIGN) void createProcessModelWebService(ProcessModelWebService pmws) throws DuplicateWebServiceNameException, InvalidProcessModelException, Exception
      Create a ProcessModelWebService.
      Parameters:
      pmws - The ProcessModelWebService to create. Minimum required fields are: serviceName, serviceUuid, and processModelId.
      Throws:
      DuplicateWebServiceNameException - if a ProcessModelWebService with the serviceName already exists.
      InvalidProcessModelException - if the ProcessModel specified by processModelId does not exist.
      Exception - if the ProcessModelWebService does not contain a serviceName or serviceUuid

    • deleteProcessModelWebService

      @Write(K_PROCESS_DESIGN) void deleteProcessModelWebService(String serviceName)
      Deletes a ProcessModelWebService based on the service name which it contains.
      Parameters:
      serviceName - The name of the service to delete. The ProcessModelWebService itself will be deleted.

    • getProcessStartingInfo

      @Read(K_PROCESS_DESIGN) ProcessStartingInfo getProcessStartingInfo(String serviceName)
      Retrieves the ProcessStartingInfo for a service.
      Parameters:
      serviceName - The service for which to retrieve the ProcessStartingInfo
      Returns:
      A ProcessStartingInfo object which contains the information necessary to start a service.

    • getProcessModelByUuid

      @Read({K_PROCESS_DESIGN,OBJECT_STORE}) ProcessModel getProcessModelByUuid(@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) String uuid) throws InvalidProcessModelException, PrivilegeException
      Retrieves the working draft of the ProcessModel specified by a UUID (Universal Unique Identifier).
      Parameters:
      uuid - UUID which specifies the ProcessModel to retrieve.
      Returns:
      The ProcessModel specified by uuid_
      Throws:
      InvalidProcessModelException - if the ProcessModel does not exist
      PrivilegeException - if the user is not allowed to access the model.

    • getProcessModelIdByUuid

      @Read(K_PROCESS_DESIGN) Long getProcessModelIdByUuid(@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) String uuid) throws InvalidProcessModelException, PrivilegeException
      Retrieves the ID of a ProcessModel by a UUID (Universal Unique Identifier).
      Parameters:
      uuid - UUID of ProcessModel whose ID will be retrieved
      Returns:
      ID of the ProcessModel specified by uuid_, or null if no process model exists with that UUID
      Throws:
      InvalidProcessModelException - if no process exists for the UUID provided
      PrivilegeException - if the user is not allowed to access the model.

    • getProcessModelsAndDescendants

      @Read({K_PROCESS_DESIGN,OBJECT_STORE}) ProcessModel[] getProcessModelsAndDescendants(Long[] ids) throws InvalidProcessModelException
      Retrieves multiple ProcessModel objects as well as the sub ProcessModel objects which they contain. All process models returned represent the working drafts of the process models in question.
      Parameters:
      ids - Uniques IDs of the ProcessModel which will be retrieved. Their sub process models will be retrieved as well.
      Returns:
      The ProcessModel objects specified by ids_, along with their sub process models
      Throws:
      InvalidProcessModelException - if a specified ProcessModel does not exist

    • getProcessModelsForFolderStartableOnly

      @Read(K_PROCESS_DESIGN) ResultPage getProcessModelsForFolderStartableOnly(Long folderId, int startIndex, int batchSize, Integer sortProperty, Integer sortOrder) throws InvalidFolderException, PrivilegeException
      Retrieve descriptors representing the working drafts of the startable process models directly in a process model folder. A ProcessModel is startable if it has a valid version or draft.
      Parameters:
      folderId - id of the folder to get all process models for
      startIndex - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      batchSize - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
      sortProperty - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants located in ProcessModel.Descriptor
      sortOrder - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      Returns a ResultPage of ProcessModel.Descriptor objects which represent the startable ProcessModel objects in the ProcessModelFolder specified by folderId_
      Throws:
      InvalidFolderException - if the ProcessModelFolder does not exist
      PrivilegeException - if the current user does not have permission to access the folder

    • validateProcessModel

      @Read(K_PROCESS_DESIGN) String[] validateProcessModel(AbstractProcessModel abstractProcessModel)
      Returns the results of validating a process model
      Parameters:
      abstractProcessModel - a ProcessModel object representing the process model to be validated
      Returns:
      An array of strings relating to the errors in the process model.

      The error strings contain the error name followed by "@"-separated field names in the ProcessModel bean to specify the location, followed by "@" and the reasons for the error Possible error names include "Invalid Expression" and "Invalid Subprocess". This name (prefix) is omitted from fatal invalidities.

    • validateProcessModelVersion

      @Read(K_PROCESS_DESIGN) String[] validateProcessModelVersion(Long processModelId, String version) throws InvalidProcessModelException, InvalidVersionException, PrivilegeException
      Returns the results of validating a process model, same as getProcessModelVersion followed by validateProcessModel.
      Parameters:
      processModelId - ID of the ProcessModel whose version will be validated
      version - The version of the ProcessModel to retrieve
      Returns:
      An array of strings relating to the errors in the process model.

      The error strings contain the error name followed by "@"-separated field names in the ProcessModel bean to specify the location, followed by "@" and the reasons for the error Possible error names include "Invalid Expression" and "Invalid Subprocess". This name (prefix) is omitted from fatal invalidities.

      Throws:
      InvalidProcessModelException
      InvalidVersionException
      PrivilegeException

    • isProcessModelLocked

      @Read(K_PROCESS_DESIGN) boolean isProcessModelLocked(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Determines whether a process model is locked
      Parameters:
      processModelId - the ID of the process model
      Returns:
      true, if the process model with the given ID is locked; false otherwise.
      Throws:
      InvalidProcessModelException - if the ID does not correspond to a valid process model
      PrivilegeException - if the current user cannot view the process model (if ProcessModelPermissions.isView() would return false for this process model)

    • getProcessModelLatestPublishedVersion

      @Read(K_PROCESS_DESIGN) ProcessModel getProcessModelLatestPublishedVersion(Long processModelId) throws PrivilegeException, InvalidProcessModelException
      Retrieve the latest published version of a ProcessModel or the working draft if a published version does not exist.
      Parameters:
      processModelId - ID of the ProcessModel to retrieve
      Returns:
      The ProcessModel specified by processModelId_
      Throws:
      PrivilegeException - if the current User does not have sufficient privileges to view the ProcessModel
      InvalidProcessModelException - if a ProcessModel specified by processModelId_ does not exist

    • getProcessModelLatestPublishedVersionDescriptor

      @Read(K_PROCESS_DESIGN) ProcessModel.Descriptor getProcessModelLatestPublishedVersionDescriptor(Long processModelId) throws PrivilegeException, InvalidProcessModelException
      Retrieve the latest published version of a ProcessModel.Descriptor or the working draft if a published version does not exist.
      Parameters:
      processModelId - ID of the Descriptor to retrieve
      Returns:
      The Descriptor specified by processModelId_
      Throws:
      PrivilegeException - if the current User does not have sufficient privileges to view the ProcessModel
      InvalidProcessModelException - if a ProcessModel specified by processModelId_ does not exist

    • getACInstanceIdsForLocalIds

      @Read(K_PROCESS_DESIGN) ResultList getACInstanceIdsForLocalIds(String[] localIds)
      Returns a ResultList containing the actual Id's in database corresponding to given localId's of ActivityClass
      Parameters:
      localIds - localId's of ActivityClass objects
      Returns:
      a ResultList containing Long Id's of ActivityClass in database

    • getACPInstanceIdsForLocalIds

      @Read(K_PROCESS_DESIGN) ResultList getACPInstanceIdsForLocalIds(Long activityClassLocalId, String[] localIds)
      Returns a ResultList containing the actual Id's in database for ActivityClassParameter corresponding to given a ActivityClass localId and ActivityClassParameter localId's. If the localIds array is empty, InvalidActivityClassSchemaException might be thrown.
      Parameters:
      activityClassLocalId - Id of ActivityClass> whose ActivityClassParameter Id's are requested
      localIds - localId's of ActivityClassParameter objects
      Returns:
      a ResultList containing Long Id's of given ActivityClassParameter objects in database

    • notifyUserCreation

      @Deprecated @Write(K_PROCESS_DESIGN) void notifyUserCreation(String username) throws NullPointerException
      Deprecated.
      done automatically by UserService.createUser
      Notifies the server that a new user was created on the Personalization server
      Parameters:
      username - the name of the user that was added
      Throws:
      NullPointerException - if username_ is null

    • notifyUsersCreation

      @Write(K_PROCESS_DESIGN) void notifyUsersCreation(String[] usernames) throws NullPointerException
      Notifies the server that new users were created on the Personalization server
      Parameters:
      usernames - the names of the users that were added
      Throws:
      NullPointerException - if any of the usernames are null

    • validateGroupMembership

      @Read(K_PROCESS_DESIGN) boolean validateGroupMembership(Long[] memGroupIds, Long[] admGroupIds, Long userTypeId, String username) throws InvalidAnonymousUserException, InvalidUserException
      Validates if the association of a user as 'Member' and as an 'Administrator has changed or not.
      Parameters:
      memGroupIds - Groups for which the User is a member
      admGroupIds - Groups for which the User is an administrator
      userTypeId - this is one of UserProfile.USER_TYPE_BASIC or UserProfile.USER_TYPE_SYS_ADMIN
      username - the username of the user whose group membership is to be validated
      Returns:
      true if there is not change in the membership of the user
      Throws:
      InvalidAnonymousUserException - if the user calling this method is anonymous, but anonymous access has not been enabled
      InvalidUserException - if the user calling this method does not exist
      NullPointerException - if any of the input arrays are null

    • updateUsernames

      @Deprecated @Write(K_PROCESS_DESIGN) void updateUsernames(String[] oldUsernames, String[] newUsernames, long maxExpirationTimeInSeconds) throws IllegalArgumentException, DuplicateNameException
      Deprecated.
      instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
      DEPRECATED: See UserService.renameUsersByUuid(java.lang.String[], java.lang.String[]) Updates a list of old usernames to new usernames.

      If successful, this method must be followed by commitUpdateUsernames(). After commitUpdateUsernames has been called, the old usernames will still be active, but will expire after the interval specified by maxExpirationTimeInSeconds_; if updateUsernames is successful but commitUpdateUsernames is not called, the new usernames will not become active.

      If unsuccessful, this method should be followed by rollbackUpdateUsernames(). This will simply free memory dedicated to mapping old usernames to new usernames.

      Parameters:
      oldUsernames - the usernames to be updated
      newUsernames - the usernames to which the old usernames will be updated
      maxExpirationTimeInSeconds - the interval, in seconds, after commitUpdateUsernames has been called, after which the old usernames will expire. If this parameter is zero or a negative value the old usernames will expire instantly. After expiration, the old usernames will no longer be valid.
      Throws:
      IllegalArgumentException - if the length of oldUsernames_ is not the same as the length of newUsernames_.
      DuplicateNameException - if any oldUsernames_ or newUsernames_ contain any duplicates, or if an old username is being updated to a username that already exists

    • commitUpdateUsernames

      @Deprecated @Write(K_PROCESS_DESIGN) void commitUpdateUsernames()
      Deprecated.
      instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
      DEPRECATED: See UserService.renameUsersByUuid(java.lang.String[], java.lang.String[]) Commits an update of usernames.

      This method should be preceded by a call to updateUsernames(String[], String[], long). After the commit, the old usernames will be temporarily active, and will expire after the interval specified by maxExpirationTimeInSeconds_; if commitUpdateUsernames is not called, the new usernames will not become active.

    • rollbackUpdateUsernames

      @Deprecated @Write(K_PROCESS_DESIGN) void rollbackUpdateUsernames()
      Deprecated.
      instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
      DEPRECATED: See UserService.renameUsersByUuid(java.lang.String[], java.lang.String[]) Rolls back an update of usernames.

      This method should be called if updateUsernames(String[], String[], long) is unsuccessful. The rollback will simply free memory dedicated to mapping old usernames to new usernames.

    • setApplicationAdministratorGroup

      @Write(K_PROCESS_DESIGN) void setApplicationAdministratorGroup(Long groupId) throws PrivilegeException
      Determines which group users need to be in to have the application administrator role.
      Parameters:
      groupId - the id of the administrator group
      Throws:
      PrivilegeException - if the current user does not have permission to perform this action

    • reloadProperties

      @Deprecated @Read(NONE) void reloadProperties()
      Deprecated.
      reloading properties is now automatic, so this call is now unnecessary and does nothing.
      Reloads all database-level properties files (*.xml, *.properties) without interrupting API services

    • validate

      @Read(K_PROCESS_DESIGN) String validate()
      Runs validation tests against the database to check whether it is corrupt, and returns a line-separated list of validation results
      Returns:
      the validation results

    • setSiteLocaleSettings

      @Write(K_PROCESS_DESIGN) void setSiteLocaleSettings(SiteLocaleSettings settings)
      Registers the site locale settings on the process design server. Use GlobalizationService.setSiteLocaleSettings(SiteLocaleSettings) if you need to update the site locale settings for all the product Servers.
      Parameters:
      settings - The site locale settings.

    • getEventsForProcessModelPaging

      @Read(K_PROCESS_DESIGN) ResultPage getEventsForProcessModelPaging(Long pmId, Long[] eventTypes, Boolean includeStartEvents, int startIndex, int batchSize, Integer sortProperty, Integer sortOrder)
      Returns the Events for a given ProcessModel specified by eventTypes_.
      Parameters:
      pmId - ID of the ProcessModel for which to retrieve Event objects
      eventTypes - types of events to retrieve. This is one of XXX_EVENT_YYY constants in Event
      includeStartEvents - whether start events should be included
      startIndex - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      batchSize - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
      sortProperty - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants located in Event
      sortOrder - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      A ResultPage which contains an array of Events

    • findEventsPaging

      @Read(K_PROCESS_DESIGN) ResultPage findEventsPaging(String searchString, Long pmId, Long[] eventTypes, Boolean includeStartEvents, int startIndex, int batchSize, Integer sortProperty, Integer sortOrder)
      Searches for Events associated with the given Process Model that match the specified searchString.
      Parameters:
      searchString - search string to search the Events' names.
      pmId - ID of the ProcessModel for which to retrieve Event objects. If the ID is null, then events for all process models are searched.
      eventTypes - types of events to retrieve. This is one of XXX_EVENT_YYY constants in Event
      includeStartEvents - Whether or not events on start node should be returned
      startIndex - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      batchSize - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
      sortProperty - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants located in Event
      sortOrder - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      A ResultPage which contains an array of Event objects that match the search criteria
      Throws:
      com.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occurs

    • getEventOrProcessModelNames

      @Read(K_PROCESS_DESIGN) String[] getEventOrProcessModelNames(Long[] pmIds, String[] eventPersistentIds)
      Returns the display names of processModels and Events for the provided ProcessModel Ids and Event Ids
      Parameters:
      pmIds - Ids of Process Models to get the display name of
      eventPersistentIds - Persistent Ids of Events (EventTrigger)to get the display name for
      Returns:
      displayNames of ProcessModels and Events. First part of the array is ProcessModels depending on the pmIds_ count and later part of array is Events depending on the eventIds_ count.
      Throws:
      NullPointerException - if pmIds_ array or eventIds_ array is null.

    • getProcessModelIdsByUuids

      @Read(K_PROCESS_DESIGN) Long[] getProcessModelIdsByUuids(@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter[][].class) String[] pmUUIDs) throws PrivilegeException
      Returns the IDs of ProcessModels that match the given UUID.
      Parameters:
      pmUUIDs - Array of UUID Strings.
      Returns:
      an array of process model IDs that match the given UUIDs. null is returned for invalid UUID.
      Throws:
      PrivilegeException

    • getEmailAttachmentFolderIdForPm

      @Read(K_PROCESS_DESIGN) Long getEmailAttachmentFolderIdForPm(Long pm) throws InvalidProcessModelException
      Returns the Id of the folder where attachments will be stored when an email message is sent to either the ProcessModel or any event within the ProcessModel
      Parameters:
      pm - ID of process model
      Returns:
      ID of the folder where attachments will be stored.
      Throws:
      InvalidProcessModelException - if the specified ProcessModel does not exist

    • getPmIdForEvent

      @Read(K_PROCESS_DESIGN) Long getPmIdForEvent(String eventPersistentId) throws InvalidEventException
      Returns the ID of the ProcessModel that the Event by given eventPersistentId belongs to.
      Parameters:
      eventPersistentId - Persistent ID of the Event
      Returns:
      ID of the Process Model
      Throws:
      InvalidEventException - If passed in event persistent ID is invalid

    • getEventsByPersistentId

      @Read(K_PROCESS_DESIGN) ResultList getEventsByPersistentId(String[] eventPersistentIds)
      Returns a ResultList containing Events that correspond to the passed in array of Event persistent IDs.
      Parameters:
      eventPersistentIds - Array of Event persistent IDs.
      Returns:
      ResultList containing Event objects corresponding to the array of given persistent IDs. The result codes can be: ResultList.CODE_VALID if the action succeeded, or ResultList.CODE_INVALID if the event persistent ID is invalid.

    • setDashboardPageForProcessModel

      @Write(K_PROCESS_DESIGN) void setDashboardPageForProcessModel(Long processModelId, Long pageId) throws InvalidProcessModelException, PrivilegeException
      Sets a page as the Dashboard page for the given ProcessModel by processModelId.
      Parameters:
      processModelId - Id of the ProcessModel to associate the page with
      pageId - the id of the page to set as the Process Model's Dashboard page
      Throws:
      InvalidProcessModelException - if the ProcessModel specified does not exist
      PrivilegeException - if the current user does not have permission to associate the Dashboard page for the ProcessModel

    • getDashboardPageForProcessModel

      @Read(K_PROCESS_DESIGN) Long getDashboardPageForProcessModel(Long processModelId) throws InvalidProcessModelException
      Returns the dashboard Id that is used for the ProcessModel by given processModelId_
      Parameters:
      processModelId - Id of the process model
      Returns:
      Id of the dahsboard
      Throws:
      InvalidProcessModelException - if the ProcessModel specified does not exist

    • removeDashboardPageForProcessModel

      @Write(K_PROCESS_DESIGN) void removeDashboardPageForProcessModel(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Disassociates the current Dashboard page for the given ProcessModel by processModelId.
      Parameters:
      processModelId - Id of the ProcessModel for which to remove its current Dashboard page
      Throws:
      InvalidProcessModelException - if the ProcesModel specified does not exist
      PrivilegeException - if the current user does not have permission to disassociate the Dashboard page from the ProcessModel

    • addProcessModelToFavorites

      @Write(K_PROCESS_DESIGN) @Deprecated void addProcessModelToFavorites(Long modelId) throws InvalidProcessModelException, PrivilegeException
      Deprecated.
      favorites marking is deprecated
      Associates this ProcessModel by given modelId_ as one of the current user's favorites.
      Parameters:
      modelId - Id of the ProcessModel to be added as favorite.
      Throws:
      InvalidProcessModelException - if the ProcessModel specified does not exist
      PrivilegeException - if the current user does not have permission to perform this action on the specified ProcessModel
      NullPointerException - if modelId_ is null

    • removeProcessModelFromFavorites

      @Write(K_PROCESS_DESIGN) @Deprecated void removeProcessModelFromFavorites(Long modelId) throws InvalidProcessModelException, PrivilegeException
      Deprecated.
      favorites marking is deprecated
      Removes this ProcessModel by given modelId_ as one of the current user's favorites.
      Parameters:
      modelId - Id of the ProcessModel to be removed as favorite.
      Throws:
      InvalidProcessModelException - if the ProcessModel specified does not exist
      PrivilegeException - if the current user does not have permission to perform this action on the specified ProcessModel
      NullPointerException - if modelId_ is null

    • handleMessages

      @Write(K_PROCESS_DESIGN) int[] handleMessages(InternalMessage[] messages)
      Sends the messages to the design server to be handled by the Events framework, and returns appropriate result codes. The result codes can be: Message.SUCCESS_CODE if the messages are handled successfully Message.JMS_TYPE_NOT_PROVIDED_CODE if the message does not provide a valid JMS type Message.INVALID_USERNAME_CODE if the provided username is not valid. If a username is not provided, the result code will return as Message.SUCCESS_CODE because username may be anonymous. Message.DESTINATION_NOT_PROVIDED_CODE if the message does not specify a valid destination Message.DUPLICATE_MESSAGE_CODE if the message is a duplicate
      Parameters:
      messages - an array of InternalMessage objects to be processed by the Events framework
      Returns:
      the result codes
      Throws:
      NullPointerException - if any of the messages in the messages_ array are null or if the array itself is null

    • validateUsernames

      @Read(K_PROCESS_DESIGN) Boolean[] validateUsernames(String[] usernames)
      Returns an array of Boolean values, Boolean.TRUE if the user given by the username exists and Boolean.FALSE otherwise.
      Parameters:
      usernames - An array of usernames to validate
      Returns:
      An array of Boolean values

    • getProcessVariablesForModel

      @Read(K_PROCESS_DESIGN) ProcessVariable[] getProcessVariablesForModel(Long pmId, boolean recursive)
      Returns the list of all process variables in a given process model. If the recursive flag is set to true, process variables for all sub-process models (that have the transparency flag set to true) will also be returned.
      Parameters:
      pmId - Id of the ProcessModel to retrieve the process variables of
      recursive - true if you want to retrieve process variables from the child process models (and their child models in turn).
      Returns:
      An array of ProcessVariable objects.
      Throws:
      NullPointerException - if pmId_ is null.

    • getProcessVariablesForModel

      @Read(K_PROCESS_DESIGN) ProcessVariable[] getProcessVariablesForModel(@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) String uuid, boolean recursive) throws InvalidProcessModelException
      Returns the list of all process variables in a given process model. If the recursive flag is set to true, process variables for all sub-process models (that have the transparency flag set to true) will also be returned.
      Parameters:
      uuid - UUID which specifies the ProcessModel to retrieve the process variables of, as if by getProcessModelIdByUuid
      recursive - true if you want to retrieve process variables from the child process models (and their child models in turn).
      Returns:
      An array of ProcessVariable objects.
      Throws:
      NullPointerException - if pmId_ is null.
      InvalidProcessModelException

    • getCurrentNotePaths

      @Deprecated @Read(K_PROCESS_DESIGN) String[] getCurrentNotePaths()
      Deprecated.
      since 23.2

    • setCurrentNotePaths

      @Deprecated @Write(K_PROCESS_DESIGN) void setCurrentNotePaths(String[] notePaths) throws PrivilegeException
      Deprecated.
      since 23.2
      Throws:
      PrivilegeException

    • getExpressionDependencies

      @Read(K_PROCESS_DESIGN) ExpressionDependency getExpressionDependencies(String expressionText, String... parameterNames)
      Returns the expression dependencies for the given expressionText. See ExpressionDependency
      Parameters:
      expressionText - Expression for which the dependencies will be determined
      parameterNames - Parameters of the expression. Only apply when the expression is part of a rule definition; pass null if it's not a rule definition.
      Returns:
      The ExpressionDependency for the given expression

    • getExpressionDependencies

      @Read(K_PROCESS_DESIGN) ExpressionDependency[] getExpressionDependencies(String[] expression, String[] parameterNames)
      Returns an array of the ExpressionDependency objects for the given expressions.
      Parameters:
      expression - Array of expressions for which the dependencies are to be determined.
      parameterNames - Parameters of the expressions. Only apply when the expressions are part of a rule definition; pass null if it's not a rule definition.
      Returns:
      An array of ExpressionDependency objects for the given expressions.

    • evaluateExpressionInVariableContext

      @Read(K_PROCESS_DESIGN) PartialResult evaluateExpressionInVariableContext(String expression, NamedTypedValue[] typedVariables, NamedTypedValue[] continueParams)

    • evaluateExpression

      @Read(K_PROCESS_DESIGN) TypedValue evaluateExpression(String expression) throws com.appiancorp.process.expression.ExpressionEvaluationException
      Evaluate the given expression (including java expression functions). The time zone used for the evaluation is the time zone in the service context used to acquire the service.
      Parameters:
      expression - The expression to evaluate.
      Returns:
      The result of the expression.
      Throws:
      com.appiancorp.process.expression.ExpressionEvaluationException - If an error occurs during the evaluation of the expression.

    • externalizeExpression

      @Read(K_PROCESS_DESIGN) String externalizeExpression(String expression, String... parameterNames)
      Replaces rule names with UUIDs within the given expression. Replaces type literals by id with type literals by name of exact type (including deactivated types).
      Parameters:
      expression - expression with rule names
      parameterNames - parameter names in expressions. Used to resolve conflicts between unqualified variables, like unqualified rule inputs in rule definitions, and other rule names
      Returns:
      expression with rule names replaced by UUIDs

    • internalizeExpression

      @Read(K_PROCESS_DESIGN) String internalizeExpression(String expression)
      Replaces UUIDs with rule names within the given expression. Replaces type literals by name with type literals by id.
      Parameters:
      expression - expression with UUIDs
      Returns:
      expression with UUIds replaced by rule names

    • getRuleIdReferences

      @Read(K_PROCESS_DESIGN) Long[] getRuleIdReferences(Long pmId) throws PrivilegeException, InvalidProcessModelException
      Gets all the rule ids that the expressions within the process model with pmId id contain, including nested rules referenced by all the expressions.
      Parameters:
      pmId - process model id
      Returns:
      collection of rule ids
      Throws:
      InvalidProcessModelException - if the ProcessModel specified by pmId does not exist
      PrivilegeException - if the current User does not have sufficient privileges to view the ProcessModel

    • getRuleUuidReferences

      @Read(K_PROCESS_DESIGN) String[] getRuleUuidReferences(ProcessModel pm)
      Gets all the rule UUID references that the expressions within the process model bean (pm) contain.
      Parameters:
      pm - process model bean
      Returns:
      collection of rule UUID references

    • evaluateExpression

      @Read(K_PROCESS_DESIGN) TypedValue evaluateExpression(String expression, NamedTypedValue[] variableValues) throws com.appiancorp.process.expression.ExpressionEvaluationException
      Evaluate the given expression (including java expression functions). The given variable values are substituted into the expression during evaluation. For example, if the expression is a rule's definition, the variable values should hold values for all of the rule's parameters.
      Parameters:
      expression - The expression to evaluate.
      variableValues - Values for all the variables used in the given expression. The name, instance type, and value of each variable value must be set. For example, if the expression is: ="Hello "&!firstName The variableValues array should hold a single NamedTypedValue object with the name "firstName", instance type AppianTypeLong.STRING and a value such as "John".
      Returns:
      The result of the expression.
      Throws:
      com.appiancorp.process.expression.ExpressionEvaluationException - If an error occurrs during the evaluation of the expression.

    • setProcessDashboardPageForProcessModel

      @Write(K_PROCESS_DESIGN) void setProcessDashboardPageForProcessModel(Long processModelId, Long pageId) throws InvalidProcessModelException, PrivilegeException
      Sets a particular page as the dashboard for every instance of a given ProcessModel by processModelId.
      Parameters:
      processModelId - The ID of the process model whose processes will be nabbed
      pageId - The ID of the page that will serve as the dashboard for those processes.
      Throws:
      InvalidProcessModelException - if the ProcessModel specified does not exist
      PrivilegeException - if the current user does not have permission to associate the Dashboard page for the ProcessModel

    • getProcessDashboardPageForProcessModel

      @Read(K_PROCESS_DESIGN) Long getProcessDashboardPageForProcessModel(Long processModelId) throws InvalidProcessModelException
      Returns the dashboard Id that is used for all processes spawned from the ProcessModel by given processModelId_
      Parameters:
      processModelId - Id of the process model
      Returns:
      Id of the dahsboard
      Throws:
      InvalidProcessModelException - if the ProcessModel specified does not exist

    • removeProcessDashboardPageForProcessModel

      @Write(K_PROCESS_DESIGN) void removeProcessDashboardPageForProcessModel(Long processModelId) throws InvalidProcessModelException, PrivilegeException
      Removes any custom dashboards created for instances of a particular process model. Instances will use the system default dashboard page instead.
      Parameters:
      processModelId - The ID of the process model
      Throws:
      InvalidProcessModelException - if the ProcessModel specified does not exist
      PrivilegeException - if the current user does not have permission to associate the Dashboard page for the ProcessModel

    • getLingeringTasksForProcessModel

      @Read(K_PROCESS_DESIGN) ResultPage getLingeringTasksForProcessModel(Long processModelId, boolean recursive, int startIndex, int batchSize, Integer sortProperty, Integer sortOrder) throws InvalidProcessException, PrivilegeException
      Returns all instances of lingering nodes in the specified process. Lingering nodes are those whose instances are known only to the execution server and are not notified externally as long as they are active. One example of such nodes is quick tasks.
      Parameters:
      processModelId - the id of the process model for which the lingering tasks should be retrieved
      recursive - whether to return the lingering tasks of the sub-process models of the given process model also
      startIndex - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      batchSize - the number of results to return. use of Constants.COUNT_ALL will result in the entire collection being returned, but this is STRONGLY discouraged.
      sortProperty - the property by which the results will be sorted This is one of the SORT_BY_XXX constants in TaskDesignProperties
      sortOrder - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
      Returns:
      a ResultPage of TaskDesignProperties objects
      Throws:
      InvalidProcessException - if the given process id is invalid
      PrivilegeException - if the user doesn't have privileges to see the model

    • validateTypedValues

      @Read(K_PROCESS_DESIGN) boolean validateTypedValues(TypedValue[] typedValues)
      Validates given TypedValues. This method is free to throw an exception or to return false if any TypedValue passed is invalid for this engine. This engine supports: AppianType.PROCESS_MODEL
      Parameters:
      typedValues -
      Returns:
      true if valid, false if invalid

    • setTimeZone

      @Write(K_PROCESS_DESIGN) void setTimeZone(BackendTimeZoneSimple tz)
      Set a backend timezone.
      Parameters:
      tz -

    • setTimeZoneSameAs

      @Write(K_PROCESS_DESIGN) void setTimeZoneSameAs(BackendTimeZoneSimple tz, String sameAsId)
      Set a backend timezone to have the same rules as another backend timezone the sameAsId.
      Parameters:
      tz -
      sameAsId -