ProcessExecutionService (Appian API)

All Superinterfaces:

com.appiancorp.services.ContextSensitiveService, Service
```
public interface ProcessExecutionService
extends com.appiancorp.services.ContextSensitiveService
```
Interface to the business logic for the process runtime.
A process is an instance of a process model. The nodes added to processes at design time are translated into activities at execution time. Activities may need to be attended by human actors (in which case they are also called "tasks") or may be unattended. Activities can be run asynchronously.
Processes may contain process variables, or process-scoped variables that may be used and set by activities. Process variables can also be set up as process parameters, or variables for which the value can be set upon starting the process (and may also be required).
See: #addProcessVariable(Long,ProcessVariable), #addProcessVariables(Long,ProcessVariable[]), getProcessParameter(Long,String), getProcessParameters(Long), getProcessVariable(Long,String), getProcessVariables(Long), #setProcessVariable(Long,ProcessVariable), and #setProcessVariables(Long,ProcessVariable[])
Nodes may be executed more than once if they are set up with recurrence.
See: skipRecurrence(Long,Long,Long), triggerRecurrence(Long,Long,Long), and getNextRecurrence(Long,Long)
Nodes may be set up with escalations, or actions that should be taken after a certain amount of time if the task is not complete.
See: skipTaskEscalation(Long,Long) and triggerTaskEscalation(Long,Long)
Processes can be archived, or saved to files, and unarchived.
See: archiveProcess(Long), archiveProcesses(Long[]), unarchiveProcess(Long), unarchiveProcesses(Long[])
The methods of this class may throw a PrivilegeException if the current user does not have privileges (permission) to perform an action, as specified in NodePermissions and ProcessModelPermissions *
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:

ExceptionHandlerService, NotesContentService, ProcessAdministrationService, ProcessAnalyticsService, ProcessDesignService

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`acceptTask$UPDATES`
`static boolean`	`acknowledgeActivity$UPDATES`
`static boolean`	`acknowledgeMessages$UPDATES`
`static int`	`ACTIVITY_CANCELLED` A constant indicating that an activity has been cancelled
`static int`	`ACTIVITY_COMPLETED` A constant indicating that an activity is in an invalid state.
`static int`	`ACTIVITY_INVALID_STATE` A constant indicating that an activity is in an invalid state
`static int`	`ACTIVITY_PAUSED` A constant indicating that an activity has been paused
`static int`	`ACTIVITY_PROCESS_CANCELLED` A constant indicating that an activity exists in a process that has been cancelled
`static int`	`ACTIVITY_PROCESS_COMPLETED` A constant indicating that an activity exists in a process that has been completed
`static int`	`ACTIVITY_PROCESS_DELETED` A constant indicating that an activity has been deleted, since its parent process has been deleted
`static int`	`ACTIVITY_PROCESS_PAUSED` A constant indicating that the process for an activity is paused
`static int`	`ACTIVITY_SKIPPED` A constant indicating that an activity has been skipped by an exception flow.
`static int`	`ACTIVITY_VALID` A constant indicating that an activity is valid.
`static int`	`ACTIVITY_WAITING` A constant indicating that an activity is waiting on an asynchronous workq item in Java.
`static boolean`	`addAttachmentsToProcess$UPDATES`
`static boolean`	`addAttachmentsToTask$UPDATES`
`static boolean`	`addAttachmentToProcess$UPDATES`
`static boolean`	`addAttachmentToProcesses$UPDATES`
`static boolean`	`addAttachmentToTask$UPDATES`
`static boolean`	`addAttachmentToTasks$UPDATES`
`static boolean`	`addProcessToFavorites$UPDATES`
`static boolean`	`addProcessVariable$UPDATES`
`static boolean`	`addProcessVariables$UPDATES`
`static boolean`	`addTaskToFavorites$UPDATES`
`static boolean`	`archiveProcess$UPDATES`
`static boolean`	`archiveProcesses$UPDATES`
`static java.lang.Integer`	`ATTACHMENT_RETURN_INVALID` Result code indicating that an attachment may not be added/removed because the specified process, task, or attachment does not exist
`static java.lang.Integer`	`ATTACHMENT_RETURN_PERMISSIONS` Result code indicating that an attachment may not be added/removed because the user does not have permission to do so
`static java.lang.Integer`	`ATTACHMENT_RETURN_PROCESS_CANCELLED` Result code indicating that an attachment may not be added to the process because the process was cancelled
`static java.lang.Integer`	`ATTACHMENT_RETURN_SUCCESS` Return code indicating that adding an attachment was successful
`static java.lang.Integer`	`ATTACHMENT_RETURN_TASK_CANCELLED` Result code indicating that an attachment may not be added to the task because the task was cancelled
`static java.lang.Integer`	`ATTACHMENT_RETURN_TASK_UNATTENDED` Result code indicating that an attachment may not be added to the task because the task is unattended
`static java.lang.Integer`	`ATTACHMENT_RETURN_TOO_MANY` Result code indicating that an attachment may not be added because too many attachments have been added
`static int`	`ATTENDED_TASKS` Code for attended tasks only
`static boolean`	`cancelAllNodes$UPDATES`
`static boolean`	`cancelProcess$UPDATES`
`static boolean`	`cancelProcesses$UPDATES`
`static boolean`	`cancelStore$UPDATES`
`static boolean`	`cancelTask$UPDATES`
`static boolean`	`cancelTasks$UPDATES`
`static boolean`	`canCompleteActivity$UPDATES`
`static boolean`	`canCompleteClone$UPDATES`
`static boolean`	`checkActivityValidity$UPDATES`
`static boolean`	`commitUpdateUsernames$UPDATES`
`static boolean`	`completeActivity$UPDATES`
`static boolean`	`completeClone$UPDATES`
`static boolean`	`completeStore$UPDATES`
`static boolean`	`containsAsynchronousSubProcesses$UPDATES`
`static boolean`	`containsLinkProcesses$UPDATES`
`static boolean`	`containsLinkProcessesInheritingPriority$UPDATES`
`static boolean`	`containsSubProcesses$UPDATES`
`static boolean`	`containsSubProcessesInheritingPriority$UPDATES`
`static boolean`	`containsSynchronousSubProcesses$UPDATES`
`static boolean`	`createNoteMetadata$UPDATES`
`static boolean`	`createNoteMetadataForProcess$UPDATES`
`static boolean`	`createNoteMetadataForProcesses$UPDATES`
`static boolean`	`createNoteMetadataForTask$UPDATES`
`static boolean`	`createNoteMetadataForTasks$UPDATES`
`static boolean`	`createNoteMetadatas$UPDATES`
`static boolean`	`createNoteMetadatasForProcess$UPDATES`
`static boolean`	`createNoteMetadatasForTask$UPDATES`
`static boolean`	`deleteNoteMetadataForProcess$UPDATES`
`static boolean`	`deleteNoteMetadataForTask$UPDATES`
`static boolean`	`deleteNoteMetadatasForProcess$UPDATES`
`static boolean`	`deleteNoteMetadatasForTask$UPDATES`
`static boolean`	`deleteProcess$UPDATES`
`static boolean`	`deleteProcesses$UPDATES`
`static boolean`	`execute$UPDATES`
`static int`	`EXECUTION_FAILURE_EXCEPTION` Constant indicating that unattended activities could not be completed because an exception occurred
`static int`	`EXECUTION_FAILURE_TIMEOUT` Constant indicating that unattended activities could not be completed because a timeout occurred connecting to Java from the process engine
`static boolean`	`executionFailure$UPDATES`
`static boolean`	`executionFailureMessage$UPDATES`
`static boolean`	`getActivitiesMetadata$UPDATES`
`static boolean`	`getActivityMetadata$UPDATES`
`static boolean`	`getActivityProperties$UPDATES`
`static boolean`	`getAllExceptionNoteMetadatasForProcess$UPDATES`
`static boolean`	`getArchivePaths$UPDATES`
`static boolean`	`getAssigneePoolForTasks$UPDATES`
`static boolean`	`getAsynchronousSubProcessesForProcess$UPDATES`
`static boolean`	`getAttachmentsAndNotesForTask$UPDATES`
`static boolean`	`getAttachmentsForProcess$UPDATES`
`static boolean`	`getAttachmentsForTask$UPDATES`
`static boolean`	`getAttachmentsInProcess$UPDATES`
`static boolean`	`getAutoArchiveProperties$UPDATES`
`static boolean`	`getCancelledTasksForProcess$UPDATES`
`static boolean`	`getCompletedTasksForProcess$UPDATES`
`static boolean`	`getCurrentNotePaths$UPDATES`
`static boolean`	`getCurrentTasksForProcess$UPDATES`
`static boolean`	`getDeadlineForProcess$UPDATES`
`static boolean`	`getDeadlineForTask$UPDATES`
`static boolean`	`getExceptionNoteMetadataForTask$UPDATES`
`static boolean`	`getExceptionNoteMetadatasForProcess$UPDATES`
`static boolean`	`getLingeringTasksForProcess$UPDATES`
`static boolean`	`getLingeringTasksForProcessAndNode$UPDATES`
`static boolean`	`getLinkProcessesForProcess$UPDATES`
`static boolean`	`getMaximumNumberOfAttachments$UPDATES`
`static boolean`	`getMaximumNumberOfNotes$UPDATES`
`static boolean`	`getMemoryUsageForExecEngine$UPDATES`
`static boolean`	`getMemoryUsageForNodesInProcesses$UPDATES`
`static boolean`	`getMemoryUsageForProcesses$UPDATES`
`static boolean`	`getMemoryUsageForProcessesByModelUUID$UPDATES`
`static boolean`	`getMemoryUsageForProcessModels$UPDATES`
`static boolean`	`getMemoryUsageForProcessModelsByUUID$UPDATES`
`static boolean`	`getNextRecurrence$UPDATES`
`static boolean`	`getNoteMetadataForProcess$UPDATES`
`static boolean`	`getNoteMetadataForTask$UPDATES`
`static boolean`	`getNoteMetadatasForProcess$UPDATES`
`static boolean`	`getNoteMetadatasForProcesses$UPDATES`
`static boolean`	`getNoteMetadatasForTask$UPDATES`
`static boolean`	`getNoteMetadatasForTasks$UPDATES`
`static boolean`	`getNoteMetadatasInProcess$UPDATES`
`static boolean`	`getNotePath$UPDATES`
`static boolean`	`getNotePaths$UPDATES`
`static boolean`	`getPausedTasksForProcess$UPDATES`
`static boolean`	`getPermissionsForNode$UPDATES`
`static boolean`	`getPermissionsForNodes$UPDATES`
`static boolean`	`getPermissionsForProcess$UPDATES`
`static boolean`	`getPermissionsForProcessDiagram$UPDATES`
`static boolean`	`getPermissionsForProcesses$UPDATES`
`static boolean`	`getPmIdForProcess$UPDATES`
`static boolean`	`getPriorityOfProcess$UPDATES`
`static boolean`	`getPriorityOfProcesses$UPDATES`
`static boolean`	`getPriorityOfTask$UPDATES`
`static boolean`	`getPriorityOfTasks$UPDATES`
`static boolean`	`getProcessDetails$UPDATES`
`static boolean`	`getProcessDiagram$UPDATES`
`static boolean`	`getProcessHistoryRecords$UPDATES`
`static boolean`	`getProcessHistoryRecordsPaging$UPDATES`
`static boolean`	`getProcessParameter$UPDATES`
`static boolean`	`getProcessParameters$UPDATES`
`static boolean`	`getProcessProperties$UPDATES`
`static boolean`	`getProcessVariable$UPDATES`
`static boolean`	`getProcessVariables$UPDATES`
`static boolean`	`getProcessVariablesPaging$UPDATES`
`static boolean`	`getRecursiveProcessVariables$UPDATES`
`static boolean`	`getScheduleSummariesForNode$UPDATES`
`static boolean`	`getSecurityForNode$UPDATES`
`static boolean`	`getSecurityForProcess$UPDATES`
`static boolean`	`getSubProcessesForProcess$UPDATES`
`static boolean`	`getSynchronousSubProcessesForProcess$UPDATES`
`static boolean`	`getTaskAssignees$UPDATES`
`static boolean`	`getTaskDetails$UPDATES`
`static boolean`	`getTaskFormExpression$UPDATES`
`static boolean`	`getTaskFormExpressions$UPDATES`
`static boolean`	`getTaskOpaqueUri$UPDATES`
`static boolean`	`getTaskPrivileges$UPDATES`
`static boolean`	`getTaskProperties$UPDATES`
`static boolean`	`getTasksAssignees$UPDATES`
`static boolean`	`getTasksDetails$UPDATES`
`static boolean`	`getTasksForProcess$UPDATES`
`static boolean`	`getTasksWithExceptionsForProcess$UPDATES`
`static boolean`	`getTasksWithStatusForProcess$UPDATES`
`static boolean`	`getTasksWithStatusForProcesses$UPDATES`
`static boolean`	`getTasksWithStatusForProcessModel$UPDATES`
`static boolean`	`getTasksWithStatusForProcessModels$UPDATES`
`static boolean`	`getTaskUrl$UPDATES`
`static boolean`	`getTopLevelProcessForProcess$UPDATES`
`static boolean`	`handleMessages$UPDATES`
`static boolean`	`isAsynchronousSubProcess$UPDATES`
`static boolean`	`isLinkProcess$UPDATES`
`static boolean`	`isSubProcess$UPDATES`
`static boolean`	`isSynchronousSubProcess$UPDATES`
`static boolean`	`keepSubmittedTasksAlive$UPDATES`
`static boolean`	`lockProcesses$UPDATES`
`static boolean`	`lockProcessModelForProcess$UPDATES`
`static boolean`	`lowerPriorityOfProcess$UPDATES`
`static boolean`	`lowerPriorityOfProcesses$UPDATES`
`static boolean`	`lowerPriorityOfTask$UPDATES`
`static boolean`	`lowerPriorityOfTasks$UPDATES`
`static java.lang.Integer`	`NOTE_CREATION_PROCESS_CANCELLED` Result code indicating that the creation of note metadata for a process failed because the process has been cancelled
`static java.lang.Integer`	`NOTE_CREATION_PROCESS_INSUFFICIENT_PRIVILEGES` Result code indicating that the creation of note metadata for a process failed because the current user has insufficient privileges to attach notes to the process.
`static java.lang.Integer`	`NOTE_CREATION_PROCESS_INVALID` Result code indicating that the creation of note metadata for a process failed because the process is invalid
`static java.lang.Integer`	`NOTE_CREATION_PROCESS_INVALID_BEAN` Result code indicating that the creation of note metadata for a process failed because a null or invalid bean was passed as a parameter.
`static java.lang.Integer`	`NOTE_CREATION_PROCESS_NOTE_LIMIT_EXCEEDED` Result code indicating that the creation of note metadata for a process failed because the process already has the maximum allowed number of notes
`static java.lang.Integer`	`NOTE_CREATION_PROCESS_SUCCESS` Result code indicating that the creation of note metadata for a process was successful
`static java.lang.Integer`	`NOTE_CREATION_TASK_CANCELLED` Result code indicating that the creation of note metadata for a task failed because the task has been cancelled
`static java.lang.Integer`	`NOTE_CREATION_TASK_INSUFFICIENT_PRIVILEGES` Result code indicating that the creation of note metadata for a task failed because the current user has insufficient privileges to attach notes to the task.
`static java.lang.Integer`	`NOTE_CREATION_TASK_INVALID` Result code indicating that the creation of note metadata for a task failed because the task is invalid
`static java.lang.Integer`	`NOTE_CREATION_TASK_INVALID_BEAN` Result code indicating that the creation of note metadata for a task failed because a null or invalid bean was passed as a parameter.
`static java.lang.Integer`	`NOTE_CREATION_TASK_NOTE_LIMIT_EXCEEDED` Result code indicating that the creation of note metadata for a task failed because the task already has the maximum allowed number of notes
`static java.lang.Integer`	`NOTE_CREATION_TASK_SUCCESS` Result code indicating that the creation of note metadata for a task was successful
`static java.lang.Integer`	`NOTE_CREATION_TASK_UNATTENDED` Result code indicating that the creation of note metadata for a task failed because the task is unattended
`static java.lang.Integer`	`NOTE_DELETION_INSUFFICIENT_PRIVILEGES` Result code indicating that the deletion of note metadata from a process or task failed because the user does not have sufficient privileges to delete the note from the process or task.
`static java.lang.Integer`	`NOTE_DELETION_INVALID` Result code indicating that the deletion of note metadata from a process or task failed because the note does not exist
`static java.lang.Integer`	`NOTE_DELETION_SUCCESS` Result code indicating that the deletion of note metadata from a process or task succeeded
`static java.lang.Integer`	`NOTES_RETURN_INVALID` Return code indicating that a note may not be added/removed because the specified process, task, or note does not exist
`static java.lang.Integer`	`NOTES_RETURN_PERMISSIONS` Return code indicating that a note may not be added/removed because the user does not have permission to do so
`static java.lang.Integer`	`NOTES_RETURN_SUCCESS` Return code indicating that adding/removing a Note was successful
`static boolean`	`notifyException$UPDATES`
`static boolean`	`notifyInvalidParameters$UPDATES`
`static boolean`	`notifyUsersCreationByJava$UPDATES`
`static boolean`	`pauseAllNodes$UPDATES`
`static boolean`	`pauseProcess$UPDATES`
`static boolean`	`pauseProcesses$UPDATES`
`static boolean`	`pauseTask$UPDATES`
`static boolean`	`pauseTasks$UPDATES`
`static java.lang.Integer`	`PROCESS_CANCELLATION_INSUFFICIENT_PRIVILEGES` Result code indicating that the cancellation of a process failed because the current user has insufficient privileges to cancel the process - that is, if `ProcessPermissions.isStopAndPause()` returns false
`static java.lang.Integer`	`PROCESS_CANCELLATION_INVALID_PROCESS` Result code indicating that the cancellation of a process failed because the process is invalid
`static java.lang.Integer`	`PROCESS_CANCELLATION_INVALID_STATE` Result code indicating that the cancellation of a process failed because the process is in an invalid state - that is, if the status of the process is not one of `ProcessSummary.STATE_ACTIVE`, `ProcessSummary.STATE_PAUSED` or `ProcessSummary.STATE_PAUSED_BY_EXCEPTION`
`static java.lang.Integer`	`PROCESS_CANCELLATION_LOCKED_PROCESS` Result code indicating that the cancellation of a process failed because the process is locked (see `lockProcessModelForProcess(Long,boolean)`)
`static java.lang.Integer`	`PROCESS_CANCELLATION_SUCCESS` Result code indicating that the cancellation of a process was successful
`static boolean`	`processToNextAttended$UPDATES`
`static boolean`	`raisePriorityOfProcess$UPDATES`
`static boolean`	`raisePriorityOfProcesses$UPDATES`
`static boolean`	`raisePriorityOfTask$UPDATES`
`static boolean`	`raisePriorityOfTasks$UPDATES`
`static boolean`	`reassignTask$UPDATES`
`static boolean`	`reassignTasksToAssigneePool$UPDATES`
`static boolean`	`reassignTasksToSameAssigneePool$UPDATES`
`static boolean`	`reassignTaskToSameAssigneePool$UPDATES`
`static boolean`	`refreshTaskForm$UPDATES`
`static boolean`	`rejectTask$UPDATES`
`static boolean`	`reloadProperties$UPDATES`
`static boolean`	`removeDashboardPageForProcesses$UPDATES`
`static boolean`	`removeProcessAttachment$UPDATES`
`static boolean`	`removeProcessAttachments$UPDATES`
`static boolean`	`removeProcessFromFavorites$UPDATES`
`static boolean`	`removeTaskAttachment$UPDATES`
`static boolean`	`removeTaskAttachments$UPDATES`
`static boolean`	`removeTaskFromFavorites$UPDATES`
`static boolean`	`restartAllNodes$UPDATES`
`static java.lang.Integer`	`RESULT_CODE_INSUFFICIENT_PRIVILEGES` Result code indicating that the current user does not have sufficient privileges to perform the action
`static java.lang.Integer`	`RESULT_CODE_INVALID_NODE` Result code indicating that the node is invalid because its activity chaining settings prohibit multiple instances
`static java.lang.Integer`	`RESULT_CODE_INVALID_OPERATION` Result code indicating that the attempted operation was invalid for the current user
`static java.lang.Integer`	`RESULT_CODE_INVALID_PROCESS` Result code indicating that the specified process is invalid
`static java.lang.Integer`	`RESULT_CODE_INVALID_STATE` Result code indicating that something is in an invalid state for the action to succeed
`static java.lang.Integer`	`RESULT_CODE_INVALID_TASK` Result code indicating that the specified task is invalid
`static java.lang.Integer`	`RESULT_CODE_LOCK_EXCEPTION` Result code indicating that an item is locked
`static java.lang.Integer`	`RESULT_CODE_LOGIC_NODE` Result code indicating that an item is a logic node and cannot be started
`static java.lang.Integer`	`RESULT_CODE_NODE_CANNOT_PAUSE` Result code indicating that this is an event and cannot be paused
`static java.lang.Integer`	`RESULT_CODE_NODE_MULTIPLICITY` Result code indicating that a node cannot be started because multiple instances of the node are not allowed.
`static java.lang.Integer`	`RESULT_CODE_RECURRING_TASK` Result code indicating that the task is set to recur
`static java.lang.Integer`	`RESULT_CODE_SUCCESS` Result code indicating that the action is successful
`static java.lang.Integer`	`RESULT_CODE_TOO_MANY_INSTANCES` Result code indicating that the maximum number of task instances has been reached and a new one cannot be created.
`static boolean`	`resumeAllNodes$UPDATES`
`static boolean`	`resumeProcess$UPDATES`
`static boolean`	`resumeProcesses$UPDATES`
`static boolean`	`resumeTask$UPDATES`
`static boolean`	`resumeTasks$UPDATES`
`static int`	`RETRIEVE_PROCESS_MODEL_NOTES` Constant indicating that that the notes and attachments of the underlying process model should be retrieved by `getProcessDiagram(java.lang.Long, int)`
`static int`	`RETRIEVE_PROCESS_NOTES` Constant indicating that that the notes and attachments of the process should be retrieved by `getProcessDiagram(java.lang.Long, int)`
`static boolean`	`rollbackUpdateUsernames$UPDATES`
`static boolean`	`saveActivityParameters$UPDATES`
`static boolean`	`setActorsInRolesForNode$UPDATES`
`static boolean`	`setActorsInRolesForProcess$UPDATES`
`static boolean`	`setApplicationAdministratorGroup$UPDATES`
`static boolean`	`setArchivePaths$UPDATES`
`static boolean`	`setCurrentNotePaths$UPDATES`
`static boolean`	`setDashboardPageForProcesses$UPDATES`
`static boolean`	`setDeadlineForProcess$UPDATES`
`static boolean`	`setDeadlineForTask$UPDATES`
`static boolean`	`setInheritanceForNode$UPDATES`
`static boolean`	`setInheritanceForProcess$UPDATES`
`static boolean`	`setPriorityOfProcess$UPDATES`
`static boolean`	`setPriorityOfProcesses$UPDATES`
`static boolean`	`setPriorityOfTask$UPDATES`
`static boolean`	`setPriorityOfTasks$UPDATES`
`static boolean`	`setProcessProperties$UPDATES`
`static boolean`	`setProcessVariable$UPDATES`
`static boolean`	`setProcessVariables$UPDATES`
`static boolean`	`setSecurityForNode$UPDATES`
`static boolean`	`setSecurityForProcess$UPDATES`
`static boolean`	`setSiteLocaleSettings$UPDATES`
`static boolean`	`setTaskDisplayName$UPDATES`
`static boolean`	`setTaskProperties$UPDATES`
`static boolean`	`setTaskStateRunning$UPDATES`
`static boolean`	`setTaskStateSubmitted$UPDATES`
`static boolean`	`setTimeZone$UPDATES`
`static boolean`	`setTimeZoneSameAs$UPDATES`
`static boolean`	`skipRecurrence$UPDATES`
`static boolean`	`skipTaskEscalation$UPDATES`
`static boolean`	`startAllNodes$UPDATES`
`static boolean`	`startQuickTask$UPDATES`
`static boolean`	`startTask$UPDATES`
`static boolean`	`startTasks$UPDATES`
`static java.lang.Integer`	`TASK_ACCEPTANCE_ACCEPTED_BY_ANOTHER` Result code indicating that a task could not be accepted because it was already accepted by another user.
`static java.lang.Integer`	`TASK_ACCEPTANCE_INVALID_STATE` Result code indicating that a task could not be accepted because it is in an invalid state.
`static java.lang.Integer`	`TASK_ACCEPTANCE_NOT_ASSIGNEE` Result code indicating that a task could not be accepted because the current user is not an assignee
`static java.lang.Integer`	`TASK_ACCEPTANCE_NOT_ASSIGNEE_CAN_COMPLETE` Result code indicating that a task could not be accepted because the current user is not an assignee, but the user has complete permissions
`static java.lang.Integer`	`TASK_ACCEPTANCE_PAUSED` Result code indicating that a task could not be accepted because the task is paused
`static java.lang.Integer`	`TASK_ACCEPTANCE_PROCESS_PAUSED` Result code indicating that a task could not be accepted because the process is paused
`static java.lang.Integer`	`TASK_ACCEPTANCE_SUCCESS` Result code indicating that a task was accepted successfully
`static java.lang.Integer`	`TASK_CANCELLATION_INSUFFICIENT_PRIVILEGES` Result code indicating that the cancellation of a task failed because the current user has insufficient privileges to cancel the task - that is, if `ProcessPermissions.isStopAndPause()` returns false for the process containing the task
`static java.lang.Integer`	`TASK_CANCELLATION_INVALID_STATE` Result code indicating that the cancellation of a task failed because the task is in an invalid state
`static java.lang.Integer`	`TASK_CANCELLATION_INVALID_TASK` Result code indicating that the cancellation of a task failed because the task is invalid
`static java.lang.Integer`	`TASK_CANCELLATION_SUCCESS` Result code indicating that the cancellation of a task was successful
`static java.lang.Integer`	`TASK_PRIVILEGE_REASSIGN_ANY` Constant indicating that the current user has the privileges to reject a given task, or to reassign the task to any user or group (inside or outside of the assignment pool)
`static java.lang.Integer`	`TASK_PRIVILEGE_REASSIGN_WITHIN_POOL` Constant indicating that the current user has the privileges to reject a given task, or to reassign the task within the assignment pool
`static java.lang.Integer`	`TASK_PRIVILEGE_REJECT_ONLY` Constant indicating that the current user only has the privileges to reject a given task
`static java.lang.Integer`	`TASK_REJECTION_RESULT_INVALID_STATE` Result code indicating that the rejection of a task was unsuccessful because the task was in an invalid state to be rejected (i.e., the task was cancelled)
`static java.lang.Integer`	`TASK_REJECTION_RESULT_NOT_OWNER` Result code indicating that the rejection of a task was unsuccessful because the current user is not the owner of the task
`static java.lang.Integer`	`TASK_REJECTION_RESULT_SUCCESS` Result code indicating that the rejection of a task was successful
`static boolean`	`triggerRecurrence$UPDATES`
`static boolean`	`triggerSchedule$UPDATES`
`static boolean`	`triggerTaskEscalation$UPDATES`
`static boolean`	`unarchiveProcess$UPDATES`
`static boolean`	`unarchiveProcesses$UPDATES`
`static int`	`UNATTENDED_AND_ATTENDED_TASKS` Code for attended and unattended tasks
`static int`	`UNATTENDED_TASKS` Code for unattended tasks only
`static boolean`	`uncompleteActivity$UPDATES`
`static boolean`	`unlockProcesses$UPDATES`
`static boolean`	`unlockProcessModelForProcess$UPDATES`
`static boolean`	`unlockProcessModels$UPDATES`
`static boolean`	`updateNoteMetadataForProcess$UPDATES`
`static boolean`	`updateNoteMetadataForTask$UPDATES`
`static boolean`	`updateNoteMetadatasForProcess$UPDATES`
`static boolean`	`updateNoteMetadatasForTask$UPDATES`
`static boolean`	`updateProcessModelForProcess$UPDATES`
`static boolean`	`updateUsernames$UPDATES`
`static boolean`	`upgradeProcesses$UPDATES`
`static boolean`	`validate$UPDATES`

Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`acceptTask(java.lang.Long activityId_)` Accepts a task for a user.
`void`	`acknowledgeActivity(java.lang.Long activityId_)` Deprecated. no longer necessary
`void`	`acknowledgeActivity(java.lang.Long[] activityId_)` Deprecated. no longer necessary
`void`	`acknowledgeMessages(java.lang.Long[] messageIds_)` Deprecated. replaced by work queue, no longer requires separate acknowledgement: call does nothing now
`java.lang.Long[]`	`addAttachmentsToProcess(java.lang.Long processId_, Attachment[] attachments_)` Add attachments to a given process.
`java.lang.Long[]`	`addAttachmentsToTask(java.lang.Long taskId_, Attachment[] attachments_)` Adds attachments to a given task.
`java.lang.Long`	`addAttachmentToProcess(java.lang.Long processId_, Attachment attachment_)` Add an attachment to a process.
`java.lang.Long[]`	`addAttachmentToProcesses(java.lang.Long[] processIds_, Attachment attachment_)` Adds a single attachment to a list of processes.
`java.lang.Long`	`addAttachmentToTask(java.lang.Long taskId_, Attachment attachment_)` Add an attachment to a task
`java.lang.Long[]`	`addAttachmentToTasks(java.lang.Long[] taskIds_, Attachment attachment_)` Add an attachment to the given tasks
`void`	`addProcessToFavorites(java.lang.Long processId_)` Adds a `Process` to the user's favorites list.
`void`	`addProcessVariable(java.lang.Long processId_, ProcessVariableInstance pv_)` Adds a new variable to the specified process.
`void`	`addProcessVariables(java.lang.Long processId_, ProcessVariableInstance[] pvs_)` Adds new variables to the specified process.
`void`	`addTaskToFavorites(java.lang.Long taskId_)` Adds a `Task` to the user's favorites list.
`void`	`archiveProcess(java.lang.Long processId_)` Archive the process with the given id.
`java.lang.Integer[]`	`archiveProcesses(java.lang.Long[] processIds_)` Manually archive the processes with the given ids.
`NodeActionResult`	`cancelAllNodes(java.lang.String[] nodeUuids, java.lang.Long[] withinProcessIds)` Cancel each given node in every applicable process.
`void`	`cancelProcess(java.lang.Long processId_, boolean cancelLinkedProcesses_)` Cancels the specified process.
`java.lang.Integer[]`	`cancelProcesses(java.lang.Long[] processIds_, boolean cancelLinkedProcesses_)` Cancel a list of processes.
`void`	`cancelStore(java.lang.Long expressionGroupId, java.lang.String cancelMessage)` Cancel an external data store.
`void`	`cancelTask(java.lang.Long activityId_)` Cancels a given task
`java.lang.Integer[]`	`cancelTasks(java.lang.Long[] activityIds_)` Cancels a list of tasks.
`boolean`	`canCompleteActivity(java.lang.Long activityId_)` Determines whether the specified activity can be completed by the user.
`boolean`	`canCompleteClone(java.lang.Long activityId_)` Indicates whether the current user can use `completeClone(java.lang.Long, com.appiancorp.suiteapi.process.ActivityClassParameter[], com.appiancorp.suiteapi.process.ActivityReturnVariable[])` on the given task to complete the activity.
`int`	`checkActivityValidity(java.lang.Long activityId_)` Determines whether the specified activity is valid.
`void`	`commitUpdateUsernames()` Deprecated. instead use `UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])`
`java.lang.Long`	`completeActivity(java.lang.Long activityId_, ActivityReturnVariable[] outputs_)` Signals the completion of an activity not implemented within the process engine itself.
`java.lang.Long`	`completeClone(java.lang.Long activityId_, ActivityClassParameter[] inputs_, ActivityReturnVariable[] outputs_)` Clones the given task (only a new id is assigned to the cloned task, everything else stays the same), and completes it using the passed inputs (i.e. calls execute or completeActivity).
`void`	`completeStore(java.lang.Long expressionGroupId)` Complete an external data store.
`boolean`	`containsAsynchronousSubProcesses(java.lang.Long processId_)` Determines whether or not the given process contains asynchronous subprocesses.
`java.lang.Boolean[]`	`containsAsynchronousSubProcesses(java.lang.Long[] processId_)`
`boolean`	`containsLinkProcesses(java.lang.Long processId_)` Deprecated. Use `containsAsynchronousSubProcesses(Long)` instead.
`boolean`	`containsLinkProcessesInheritingPriority(java.lang.Long processId_)` Deprecated. Use `containsSubProcessesInheritingPriority(Long)` instead.
`boolean`	`containsSubProcesses(java.lang.Long processId_)` Deprecated. Use `containsSynchronousSubProcesses(Long)` instead.
`boolean`	`containsSubProcessesInheritingPriority(java.lang.Long processId_)` Checks if the specified `Process` contains sub-processes that inherit their priority instead of defining their own priority levels.
`boolean`	`containsSynchronousSubProcesses(java.lang.Long processId_)` Determines whether or not the given process contains synchronous subprocesses.
`java.lang.Boolean[]`	`containsSynchronousSubProcesses(java.lang.Long[] processId_)`
`NoteMetadata`	`createNoteMetadata(NoteMetadata nm_)` Create note metadata that is not attached to a process or task.
`NoteMetadata`	`createNoteMetadataForProcess(java.lang.Long processId_, NoteMetadata nm_)` Creates a new Note for the specified Process.
`ResultList`	`createNoteMetadataForProcesses(java.lang.Long[] processIds_, NoteMetadata nm_)` Creates a new Note for the specified Processes.
`NoteMetadata`	`createNoteMetadataForTask(java.lang.Long taskId_, NoteMetadata nm_)` Creates a new Note for a given Task.
`ResultList`	`createNoteMetadataForTasks(java.lang.Long[] taskIds_, NoteMetadata nm_)` Creates a new Note for the given Tasks.
`NoteMetadata[]`	`createNoteMetadatas(NoteMetadata[] nms_)` Bulk create note metadata.
`ResultList`	`createNoteMetadatasForProcess(java.lang.Long processId_, NoteMetadata[] nms_)` Creates multiple notes for a given Process.
`ResultList`	`createNoteMetadatasForTask(java.lang.Long taskId_, NoteMetadata[] nms_)` Creates multiple notes for a given task.
`java.lang.String`	`deleteNoteMetadataForProcess(java.lang.Long noteId_, java.lang.Long processId_)` Deletes the specified Note for the given process.
`java.lang.String`	`deleteNoteMetadataForTask(java.lang.Long noteId_, java.lang.Long taskId_)` Deletes the specified Note from a given task.
`ResultList`	`deleteNoteMetadatasForProcess(java.lang.Long[] noteIds_, java.lang.Long processId_)` Deletes the specified notes from the given process
`ResultList`	`deleteNoteMetadatasForTask(java.lang.Long[] noteIds_, java.lang.Long taskId_)` Deletes the specified notes for the given task
`void`	`deleteProcess(java.lang.Long processId_, boolean deleteSubProcesses_)` Deletes the specified process.
`void`	`deleteProcesses(java.lang.Long[] processIds_, boolean deleteSubProcesses_)` Deletes all of the specified processes.
`java.lang.Long`	`execute(java.lang.Long activityId_)` Requests execution of an activity implemented within the process engine.
`void`	`executionFailure(int errorType_, java.lang.Long[] activities_)` Deprecated. unattended activities now run from the work queue.
`void`	`executionFailureMessage(int errorType_, java.lang.Long[] activities_, java.lang.String message_)` Deprecated. unattended activities now run from the work queue.
`ActivityExecutionMetadata[]`	`getActivitiesMetadata(java.lang.Long[] activityIds_)` Gets metadata for the specified activities.
`ActivityExecutionMetadata`	`getActivityMetadata(java.lang.Long activityId_)` Gets the metadata for a specified activity.
`ActivityProperties`	`getActivityProperties(java.lang.Long activityId_)` Retrieves the activity properties for the given activity.
`ResultPage`	`getAllExceptionNoteMetadatasForProcess(java.lang.Long processId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets a page out of the note metadatas for process and task exceptions for a specified process and all its tasks.
`java.lang.String[]`	`getArchivePaths()` Retrieve the paths where archived processes are stored.
`Assignment.Assignee[]`	`getAssigneePoolForTasks(java.lang.Long[] taskIds_)` Gets the set of unique assignees among all the specified tasks.
`ResultList`	`getAsynchronousSubProcessesForProcess(java.lang.Long processId_, int asynchronousSubProcessStatus_)` Gets the asynchronous subprocesses of the given process.
`ResultPage`	`getAttachmentsAndNotesForTask(java.lang.Long taskId_, boolean recursive_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Returns the attachments and notes for a specified task
`Attachment[]`	`getAttachmentsForProcess(java.lang.Long processId_)` Deprecated.
`ResultPage`	`getAttachmentsForProcess(java.lang.Long id_, boolean recursive_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Returns the attachments for a specified process
`Attachment[]`	`getAttachmentsForTask(java.lang.Long taskId_)` Gets all the attachments for a given task and its related process
`ResultList`	`getAttachmentsInProcess(java.lang.Long processId_, java.lang.Long[] attachmentIds_)` Gets the specified attachments associated with a given process, or tasks in this process
`java.util.Map`	`getAutoArchiveProperties()` Retrieves auto archive properties from the backend
`ResultPage`	`getCancelledTasksForProcess(java.lang.Long processId_, int type_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets the cancelled tasks for a process
`ResultPage`	`getCompletedTasksForProcess(java.lang.Long processId_, int type_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets the completed tasks for a process
`java.lang.String[]`	`getCurrentNotePaths()` Retrieve the paths where notes are stored on Execution engine 0.
`ResultPage`	`getCurrentTasksForProcess(java.lang.Long processId_, int type_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets the current tasks for a process
`java.sql.Timestamp`	`getDeadlineForProcess(java.lang.Long processId_)` Retrieve the deadline of a given process.
`java.sql.Timestamp`	`getDeadlineForTask(java.lang.Long taskId_)` Retrieve the deadline for a given task.
`NoteMetadata`	`getExceptionNoteMetadataForTask(java.lang.Long taskId_)` Gets the last exception note (that is, the note attached to the exception) for the specified task; `null` if no exceptions have been raised on the task
`ResultPage`	`getExceptionNoteMetadatasForProcess(java.lang.Long processId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets a page out of the note metadatas for process exceptions for a specified process.
`ResultPage`	`getLingeringTasksForProcess(java.lang.Long processId_, boolean recursive, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Returns all instances of lingering nodes currently active in the specified process.
`TaskSummary[]`	`getLingeringTasksForProcessAndNode(java.lang.Long processId_, java.lang.Long nodeId_)` Returns all instances of the specified lingering node currently active in the specified process.
`ResultList`	`getLinkProcessesForProcess(java.lang.Long processId_, int linkProcessStatus_)` Deprecated. Use `getAsynchronousSubProcessesForProcess(Long, int)` instead.
`int`	`getMaximumNumberOfAttachments()` Returns the Maximum number of attachmnets that can be added to Process or Task
`int`	`getMaximumNumberOfNotes()` Returns the Maximum number of notes that can be added to Process or Task
`SizingReport`	`getMemoryUsageForExecEngine()` Returns the `SizingReport` which contains top-level summary of memory usage by various objects in all Execution Engines.
`SizingReport`	`getMemoryUsageForNodesInProcesses(java.lang.Long[] processIds_)` Returns the `SizingReport` which contains a breakdown of memory usage by individual nodes/activities in specific Process instances.
`SizingReport`	`getMemoryUsageForProcesses(java.lang.Long[] processIds_)` Returns the `SizingReport` which contains a breakdown of memory usage by individual process instances
`SizingReport`	`getMemoryUsageForProcessesByModelUUID(java.lang.String[] processModelUUIDs_)` Returns the `SizingReport` which contains a breakdown of memory usage by individual process instances based of of specific Process Models given by Process Model UUIDs.
`SizingReport`	`getMemoryUsageForProcessModels(java.lang.Long[] processModelIds_)` Returns the `SizingReport` which contains a breakdown of memory usage by all process instances based off of specific Process Models given by the Process Model IDs.
`SizingReport`	`getMemoryUsageForProcessModelsByUUID(java.lang.String[] processModelUUIDs_)` Returns the `SizingReport` which contains a breakdown of memory usage by all process instances based off of specific Process Models given by Process Model UUIDs.
`RecurrenceInstance`	`getNextRecurrence(java.lang.Long processId_, java.lang.Long nodeId_)` Gets the next recurrence for a node within a process
`NoteMetadata`	`getNoteMetadataForProcess(java.lang.Long noteId_, java.lang.Long processId_)` Returns a specified note for given process
`NoteMetadata`	`getNoteMetadataForTask(java.lang.Long noteId_, java.lang.Long taskId_)` Returns a specified note for given task
`ResultPage`	`getNoteMetadatasForProcess(java.lang.Long id_, boolean recursive_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Returns the metadata for the notes for a specified process
`ResultPage`	`getNoteMetadatasForProcess(java.lang.Long id_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated.
`ResultList`	`getNoteMetadatasForProcesses(java.lang.Long[] ids_)` Returns the metadata for the notes for specified processes.
`ResultPage`	`getNoteMetadatasForTask(java.lang.Long id_, boolean includeProcess_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets the metadata for the notes of a specified task.
`ResultList`	`getNoteMetadatasForTasks(java.lang.Long[] ids_, boolean includeProcess_)` Gets the notes for the specified tasks
`ResultList`	`getNoteMetadatasInProcess(java.lang.Long processId_, java.lang.Long[] noteIds_)` Gets the specified notes associated with a given process, or tasks in this process
`java.lang.String`	`getNotePath(java.lang.Long noteId_)` Gets the location for storage of the content of an unattached note.
`java.lang.String[]`	`getNotePaths(java.lang.Long[] noteIds_)` Gets the locations for storage of the content of unattached notes.
`ResultPage`	`getPausedTasksForProcess(java.lang.Long processId_, int type_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets the paused tasks for a process
`NodePermissions`	`getPermissionsForNode(java.lang.Long activityId_)` Gets the permissions that the user has by default on tasks of the specified node.
`NodePermissions[]`	`getPermissionsForNodes(java.lang.Long[] activityIds_)` Gets the permissions that the user has by default on tasks of the specified nodes.
`ProcessPermissions`	`getPermissionsForProcess(java.lang.Long id_)` Gets the permissions that the user has on a specified process.
`ProcessModelPermissions`	`getPermissionsForProcessDiagram(java.lang.Long processId_)` Gets a `ProcessModelPermissions` object that says which In-Flight Modifications the user can or cannot perform to a given process.
`ProcessPermissions[]`	`getPermissionsForProcesses(java.lang.Long[] ids_)` Gets the permissions that the user has on specified processes.
`java.lang.Long`	`getPmIdForProcess(java.lang.Long processId_)` Get the specified Process's Process Model's ID
`Priority`	`getPriorityOfProcess(java.lang.Long processId_)` Gets the priority of a specified Process.
`Priority[]`	`getPriorityOfProcesses(java.lang.Long[] processIds_)` Gets the priority for a list of processes.
`Priority`	`getPriorityOfTask(java.lang.Long taskId_)` Get the priority of the specified task.
`Priority[]`	`getPriorityOfTasks(java.lang.Long[] taskIds_)` Get the priorities of the specified tasks.
`ProcessDetails`	`getProcessDetails(java.lang.Long processId_)` Gets the details for a specified process.
`ProcessDiagram`	`getProcessDiagram(java.lang.Long processId_, int typeOfNotesToRetrieve_)` Allows users to retrieve the instance of the process model that the process is run off.
`HistoryRecord[]`	`getProcessHistoryRecords(java.lang.Long processId_)` Get the process history record of the given process.
`ResultPage`	`getProcessHistoryRecordsPaging(java.lang.Long processId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Get the process history record of the given process.
`ProcessVariableInstance`	`getProcessParameter(java.lang.Long processId_, java.lang.String parameterName_)` Retrieves the specified process parameter of the specified process.
`ProcessVariableInstance[]`	`getProcessParameters(java.lang.Long processId_)` Retrieves process parameters for the specified process.
`ProcessProperties`	`getProcessProperties(java.lang.Long processId_)` Retrieves the properties for the given process.
`ProcessVariableInstance`	`getProcessVariable(java.lang.Long processId_, java.lang.String pvName_)` Retrieves the specified process variable for the specified process.
`ProcessVariableInstance[]`	`getProcessVariables(java.lang.Long processId_)` Deprecated. Use `getRecursiveProcessVariables(Long, boolean)` instead.
`ResultPage`	`getProcessVariablesPaging(java.lang.Long processId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Retrieves the process variables for the specified process.
`ProcessVariableInstance[]`	`getRecursiveProcessVariables(java.lang.Long processId_, boolean recursive_)` Retrieves the process variables for the specified process.
`ResultPage`	`getScheduleSummariesForNode(java.lang.Long processId_, java.lang.Long nodeId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets Summaries of schedules that are attached to the node.
`Security`	`getSecurityForNode(java.lang.Long id_)` Gets the default security configuration of tasks for a specified node.
`Security`	`getSecurityForProcess(java.lang.Long id_)` Gets the security configuration of a process.
`ResultList`	`getSubProcessesForProcess(java.lang.Long processId_, int subProcessStatus_)` Deprecated. Use `getSynchronousSubProcessesForProcess(Long, int)` instead.
`ResultList`	`getSynchronousSubProcessesForProcess(java.lang.Long processId_, int synchronousSubProcessStatus_)` Gets the synchronous subprocesses of the given process.
`Assignment.Assignee[]`	`getTaskAssignees(java.lang.Long taskId_)` Gets all assignees for a specified task.
`TaskDetails`	`getTaskDetails(java.lang.Long taskId_)` Gets the details for the specified task.
`java.lang.String`	`getTaskFormExpression(java.lang.Long taskId)` Gets task form expressions for the specified task.
`java.lang.String[]`	`getTaskFormExpressions(java.lang.Long[] taskIds)` Gets task form expressions for the specified tasks.
`java.lang.String`	`getTaskOpaqueUri(java.lang.Long taskId_)` Gets the opaque URI for the specified task.
`java.lang.Integer`	`getTaskPrivileges(java.lang.Long activityId_)` Determines whether the user who is executing an attended activity is permitted to reject or reassign the task.
`TaskProperties`	`getTaskProperties(java.lang.Long taskId_)` Retrieves the properties for the given task.
`Assignment.Assignee[][]`	`getTasksAssignees(java.lang.Long[] taskIds_)` Gets all assignees for the specified tasks.
`TaskDetails[]`	`getTasksDetails(java.lang.Long[] taskIds_)` Gets the details for the specified tasks.
`ResultPage`	`getTasksForProcess(java.lang.Long processId_, boolean recursive_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets the summaries of the tasks in the process.
`ResultPage`	`getTasksForProcess(java.lang.Long processId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated.
`ResultPage`	`getTasksWithExceptionsForProcess(java.lang.Long processId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets the tasks that are paused by exception for a specified process.
`ResultPage`	`getTasksWithStatusForProcess(java.lang.Long processId_, java.lang.Integer taskStatus_, boolean recursive_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Get the pages of tasks, within a particular process or its subprocesses, currently in a given state.
`ResultPage`	`getTasksWithStatusForProcesses(java.lang.Long[] processIds_, java.lang.Integer taskStatus_, boolean recursive_, int startIndex_, int batchSize_)` Get the pages of tasks, within particular processes or their subprocesses, currently in a given state.
`ResultPage`	`getTasksWithStatusForProcessModel(java.lang.Long processModelId_, java.lang.Integer taskStatus_, boolean recursive_, int startIndex_, int batchSize_)` Get the pages of tasks, within a particular process model, currently in a given state.
`ResultPage`	`getTasksWithStatusForProcessModels(java.lang.Long[] processModelIds_, java.lang.Integer taskStatus_, boolean recursive_, int startIndex_, int batchSize_)` Get the pages of tasks, within any of particular process models, currently in a given state.
`java.lang.String`	`getTaskUrl(java.lang.Long taskId_)` Gets the URL for the specified task.
`ProcessSummary`	`getTopLevelProcessForProcess(java.lang.Long processId_)` Gets the top level process for a given process.
`int[]`	`handleMessages(InternalMessage[] messages_)` Sends messages to the execution server, to be handled by the events framework.
`boolean`	`isAsynchronousSubProcess(java.lang.Long processId_)` Determines whether or not the given process is an asynchronous subprocess.
`boolean`	`isLinkProcess(java.lang.Long processId_)` Deprecated. Use `isAsynchronousSubProcess(Long)` instead.
`boolean`	`isSubProcess(java.lang.Long processId_)` Deprecated. Use `#isSynchronousSubProcesses(Long)` instead.
`boolean`	`isSynchronousSubProcess(java.lang.Long processId_)` Determines whether or not the given process is a synchronous subprocess.
`void`	`keepSubmittedTasksAlive(java.lang.Long[] activities_)` This method informs the Process Engine that the specified tasks are still in the queue, waiting to be executed asynchronously.
`int[]`	`lockProcesses(java.lang.Long[] processIds, boolean override)` Attempts to lock the specified processes.
`void`	`lockProcessModelForProcess(java.lang.Long processId_, boolean override_)` Locks the underlying process model of the specified process.
`void`	`lowerPriorityOfProcess(java.lang.Long processId_, boolean propagatePriorityChangeToLinkProcesses_)` Lowers the priority of a process by one level.
`void`	`lowerPriorityOfProcesses(java.lang.Long[] processIds_, boolean propagatePriorityChangeToLinkProcesses_)` Lowers the priority of the specified processes by one level.
`void`	`lowerPriorityOfTask(java.lang.Long taskId_)` Lowers the priority of a task by one level.
`void`	`lowerPriorityOfTasks(java.lang.Long[] taskIds_)` Lowers the priority of specified tasks by one level.
`void`	`notifyException(java.lang.Long activityId_, java.lang.String exceptionClassName_, java.lang.String message_, java.lang.String stackTrace_)` Notifies the server that an exception has occurred while executing an activity.
`void`	`notifyInvalidParameters(java.lang.Long activityId_, ActivityClassParameter[] acps_)` Notifies the user that the parameters sent as inputs to an unattended activity were invalid.
`void`	`notifyUsersCreationByJava(java.lang.Long activityId_, java.lang.String[] usernames_)` Deprecated. This call should never be necessary.
`void`	`notifyUsersCreationByJava(java.lang.String[] usernames_)` Deprecated. done automatically by UserService.createUser
`NodeActionResult`	`pauseAllNodes(java.lang.String[] nodeUuids, java.lang.Long[] withinProcessIds)` Pause each given node in every applicable process.
`void`	`pauseProcess(java.lang.Long processId_)` Pauses the process, and all of its nodes.
`java.lang.Integer[]`	`pauseProcesses(java.lang.Long[] processIds_)` Pauses the processes, and all of their nodes.
`void`	`pauseTask(java.lang.Long activityId_)` Pauses the task
`java.lang.Integer[]`	`pauseTasks(java.lang.Long[] activityIds_)` Tries to pause the tasks, and returns an array of result codes on whether the operation was successful or an error had occurred.
`void`	`processToNextAttended(java.lang.Long activityId, boolean isQuickTask, ActivityClassParameter[] parameters)` This method can be used to programatically execute an attended task and continue flow to the next attended activity.
`void`	`raisePriorityOfProcess(java.lang.Long processId_, boolean propagatePriorityChangeToLinkProcesses_)` Raises the priority of a specified process by one level.
`void`	`raisePriorityOfProcesses(java.lang.Long[] processIds_, boolean propagatePriorityChangeToLinkProcesses_)` Raises the priority of the specified processes by one level.
`void`	`raisePriorityOfTask(java.lang.Long taskId_)` Raises the priority of the specified task by one level.
`void`	`raisePriorityOfTasks(java.lang.Long[] taskIds_)` Raises the priority of the specified tasks by one level.
`void`	`reassignTask(java.lang.Long taskId_, Assignment.Assignee[] assignees_)` Reassigns a task to new assignees.
`java.lang.Integer[]`	`reassignTasksToAssigneePool(java.lang.Long[] activityIds_, Assignment.Assignee[] assignees_)` Deprecated. Use `reassignTask(java.lang.Long, com.appiancorp.suiteapi.process.Assignment.Assignee[])` instead
`java.lang.Integer[]`	`reassignTasksToSameAssigneePool(java.lang.Long[] activityIds_)` Tries to reassign the tasks, and returns an array of result codes on whether the operation was successful or an error had occurred.
`void`	`reassignTaskToSameAssigneePool(java.lang.Long activityId_)` Reassigns the task to the assignee pool.
`void`	`refreshTaskForm(java.lang.Long activityId_)` Deprecated. This method will cause a race condition between ACP refresh and form label refresh. Instead, use the "Refresh default values every time the task form is viewed" execution option in the task configuration in the model.
`java.lang.Integer`	`rejectTask(java.lang.Long taskId_)` Rejects a task that has already been accepted.
`void`	`reloadProperties()` Deprecated. reloading properties is now automatic, so this call is now unnecessary and does nothing.
`void`	`removeDashboardPageForProcesses(java.lang.Long processModelId)` Deprecated. Use `ProcessDesignService.removeProcessDashboardPageForProcessModel(Long)` instead.
`java.lang.Long`	`removeProcessAttachment(java.lang.Long attachmentId_, java.lang.Long processId_)` Removes the specified attachment from a process.
`java.lang.Long[]`	`removeProcessAttachments(java.lang.Long[] attachmentIds_, java.lang.Long processId_)` Removes specified attachments from the specified process.
`void`	`removeProcessFromFavorites(java.lang.Long processId_)` Removes a process from the user's Favorite's list
`java.lang.Long`	`removeTaskAttachment(java.lang.Long attachmentId_, java.lang.Long taskId_)` Removes a specified attachment from a task
`java.lang.Long[]`	`removeTaskAttachments(java.lang.Long[] attachmentIds_, java.lang.Long taskId_)` Removes the specified attachments from a task
`void`	`removeTaskFromFavorites(java.lang.Long taskId_)` Removes a task from the user's Favorite's list
`NodeActionResult`	`restartAllNodes(java.lang.String[] nodeUuids, java.lang.Long[] withinProcessIds, BulkNodeOption... bulkNodeOption)` Restart a task for each of the given nodeUuids in every applicable process.
`NodeActionResult`	`resumeAllNodes(java.lang.String[] nodeUuids, java.lang.Long[] withinProcessIds)` Resume each given node in every applicable process.
`void`	`resumeProcess(java.lang.Long processId_)` Resumes the process.
`java.lang.Integer[]`	`resumeProcesses(java.lang.Long[] processIds_)` Tries to resume the processes, and returns an array of result codes on whether the operation was successful or an error had occurred.
`void`	`resumeTask(java.lang.Long activityId_)` Resumes the task
`java.lang.Integer[]`	`resumeTasks(java.lang.Long[] activityIds_)` Tries to resume the tasks, and returns an array of result codes on whether the operation was successful or an error had occurred.
`void`	`rollbackUpdateUsernames()` Deprecated. instead use `UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])`
`void`	`saveActivityParameters(java.lang.Long activityId_, ActivityClassParameter[] acps_)` Saves the values for parameters of an activity.
`void`	`setActorsInRolesForNode(java.lang.Long id_, java.lang.String[] users_, java.lang.String[][] userRoles_, java.lang.Long[] groups_, java.lang.String[][] groupRoles_)` Adds and/or modifies the default roles of users and groups for a node instance (activity).
`void`	`setActorsInRolesForProcess(java.lang.Long id_, java.lang.String[] users_, java.lang.String[][] userRoles_, java.lang.Long[] groups_, java.lang.String[][] groupRoles_)` Adds and/or modifies the roles of users and groups for a specified process.
`void`	`setApplicationAdministratorGroup(java.lang.Long groupId_)` Determines which group users need to be in to have the application administrator role.
`void`	`setArchivePaths(java.lang.String[] archivePaths)` Set the paths where archived processes will be stored.
`void`	`setCurrentNotePaths(java.lang.String[] notePaths)` Sets the paths where notes are stored on Execution engine 0.
`void`	`setDashboardPageForProcesses(java.lang.Long processModelId, java.lang.Long pageId)` Deprecated. Use `ProcessDesignService.setProcessDashboardPageForProcessModel(Long, Long)` instead.
`void`	`setDeadlineForProcess(java.lang.Long processId_, java.sql.Timestamp deadline_)` Set the deadline for a given process.
`void`	`setDeadlineForTask(java.lang.Long taskId_, java.sql.Timestamp deadline_)` Set the deadline for a given task.
`void`	`setInheritanceForNode(java.lang.Long id_, boolean doesInherit_)` Sets whether a specified task inherits security from its process.
`void`	`setInheritanceForProcess(java.lang.Long id_, boolean doesInherit_)` Sets whether a specified process inherits security from the process model of which it is an instance.
`void`	`setPriorityOfProcess(java.lang.Long processId_, java.lang.Long priorityId_, boolean propagatePriorityChangeToSubProcesses_)` Sets the priority of a specified process
`void`	`setPriorityOfProcesses(java.lang.Long[] processIds_, java.lang.Long priorityId_, boolean propagatePriorityChangeToSubProcesses_)` Sets the priority `Priority` of the specified processes `ProcessDetails`.
`void`	`setPriorityOfTask(java.lang.Long taskId_, java.lang.Long priorityId_)` Sets the priority of a specified task.
`void`	`setPriorityOfTasks(java.lang.Long[] taskIds_, java.lang.Long priorityId_)` Sets the priorities of specified tasks.
`void`	`setProcessProperties(ProcessProperties properties_)` Sets the properties of the specified process.
`void`	`setProcessVariable(java.lang.Long pProcessId_, ProcessVariableInstance pv_)` Sets the value of the specified process variable for the specified process.
`void`	`setProcessVariables(java.lang.Long pProcessId_, ProcessVariableInstance[] pvs_)` Sets the values of the specified process variables for the specified process.
`void`	`setSecurityForNode(java.lang.Long id_, Security s_)` Sets the default security configuration of tasks for a specified node.
`void`	`setSecurityForProcess(java.lang.Long id_, Security s_)` Sets the security configuration of a process.
`void`	`setSiteLocaleSettings(SiteLocaleSettings settings_)` Registers the site locale settings on the process execution server.
`void`	`setTaskDisplayName(java.lang.Long taskId, LocaleString displayName)` Sets the display name for the specified task to the specified string.
`void`	`setTaskProperties(TaskProperties properties_)` Sets the properties of the specified task .
`void`	`setTaskStateRunning(java.lang.Long taskId_)` Sets the Task in the Running state.
`void`	`setTaskStateSubmitted(java.lang.Long taskId_)` Sets the Task in the 'Submitted' state.
`void`	`setTimeZone(BackendTimeZoneSimple tz)` Set the time zone information using the format used by the engines to encapsulate time zone information.
`void`	`setTimeZoneSameAs(BackendTimeZoneSimple tz, java.lang.String sameAsId)` Deprecated. this method will be removed in a future release
`RecurrenceInstance`	`skipRecurrence(java.lang.Long processId_, java.lang.Long nodeId_, java.lang.Long recurrenceNumber_)` Skips the recurrence instance of the given node
`void`	`skipTaskEscalation(java.lang.Long activityId_, java.lang.Long escalationId_)` Skips the desired escalation instance for the task
`NodeActionResult`	`startAllNodes(java.lang.String[] nodeUuids, java.lang.Long[] withinProcessIds, BulkNodeOption... bulkNodeOption)` Start a task for each of the given nodeUuids in every applicable process.
`java.lang.Long`	`startQuickTask(java.lang.Long processId_, java.lang.Long nodeId_)` Starts a new task from the node If the process to which the node belongs is cancelled or completed, then the process is reactivated.
`boolean`	`startTask(java.lang.Long processId_, java.lang.Long nodeId_)` Starts a new task from the node If the process to which the node belongs is cancelled or completed, then the process is reactivated.
`java.lang.Integer[]`	`startTasks(java.lang.Long processId_, java.lang.Long[] nodeIds_)` Tries to start the tasks, and returns an array of result codes on whether the operation was successful or an error had occurred.
`RecurrenceInstance`	`triggerRecurrence(java.lang.Long processId_, java.lang.Long nodeId_, java.lang.Long recurrenceNumber_)` Triggers the recurrence instance of the given node
`void`	`triggerSchedule(java.lang.Integer scheduleType_, java.lang.Long scheduleId_)` Triggers the schedule instance for the task or node
`void`	`triggerTaskEscalation(java.lang.Long activityId_, java.lang.Long escalationId_)` Triggers the desired escalation instance for the task.Users must obtain escalation id from TaskDetails object.
`void`	`unarchiveProcess(java.lang.Long processId_)` Bring all process data back to memory.
`java.lang.Integer[]`	`unarchiveProcesses(java.lang.Long[] processIds_)` Bring all process data back to memory.
`ActivityExecutionMetadata`	`uncompleteActivity(java.lang.Long activityId_)` Changes the status of an activity to ACCEPTED or ASSIGNED.
`int[]`	`unlockProcesses(java.lang.Long[] processIds, boolean override)` Attempts to unlock the specified processes.
`void`	`unlockProcessModelForProcess(java.lang.Long processId_, boolean override_)` Unlocks the underlying process model for the process
`void`	`unlockProcessModels()` Unlocks all process models locked by the current user.
`NoteMetadata`	`updateNoteMetadataForProcess(NoteMetadata nm_, java.lang.Long processId_)` Updates the specified Note for given process The following field must be populated in the `NoteMetadata` object: `id`
`NoteMetadata`	`updateNoteMetadataForTask(NoteMetadata nm_, java.lang.Long taskId_)` Updates the specified Note for given task The following field must be populated in the `NoteMetadata` object: `id`
`ResultList`	`updateNoteMetadatasForProcess(NoteMetadata[] nms_, java.lang.Long processId_)` Updates all the specified notes for the given process.
`ResultList`	`updateNoteMetadatasForTask(NoteMetadata[] nms_, java.lang.Long taskId_)` Updates all the specified notes for a given task.
`ProcessDiagram`	`updateProcessModelForProcess(java.lang.Long processId_, ProcessDiagram pd_, ProcessModel[] childProcessModels_)` Deprecated. Use `upgradeProcesses(java.lang.Long, java.lang.String, java.lang.Long[])` instead
`void`	`updateUsernames(java.lang.String[] oldUsernames_, java.lang.String[] newUsernames_, long maxExpirationTimeInSeconds_)` Deprecated. instead use `UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])`
`UpgradeResult`	`upgradeProcesses(java.lang.Long toProcessModelId, java.lang.String toVersion, java.lang.Long[] processIds)` Attempts to upgrade the given processes to the specified process model id and version.
`UpgradeResult`	`upgradeProcesses(java.lang.Long toProcessModelId, java.lang.String toVersion, java.lang.Long fromProcessModelId, java.lang.String[] fromVersions)` Attempts to upgrade the processes of the 'from' process model id and version to the 'to' process model id and version.
`java.lang.String`	`validate()` Runs validation tests against the database to check whether it is corrupt, and returns a line-separated list of validation results

Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext

- Field Detail
  - TASK_ACCEPTANCE_SUCCESS
```
static final java.lang.Integer TASK_ACCEPTANCE_SUCCESS
```
    Result code indicating that a task was accepted successfully
  - TASK_ACCEPTANCE_ACCEPTED_BY_ANOTHER
```
static final java.lang.Integer TASK_ACCEPTANCE_ACCEPTED_BY_ANOTHER
```
    Result code indicating that a task could not be accepted because it was already accepted by another user.
  - TASK_ACCEPTANCE_INVALID_STATE
```
static final java.lang.Integer TASK_ACCEPTANCE_INVALID_STATE
```
    Result code indicating that a task could not be accepted because it is in an invalid state. A task may only be accepted if it has a status of TaskSummary.TASK_STATUS_ASSIGNED or TaskSummary.TASK_STATUS_ACCEPTED
  - TASK_ACCEPTANCE_NOT_ASSIGNEE
```
static final java.lang.Integer TASK_ACCEPTANCE_NOT_ASSIGNEE
```
    Result code indicating that a task could not be accepted because the current user is not an assignee
  - TASK_ACCEPTANCE_PROCESS_PAUSED
```
static final java.lang.Integer TASK_ACCEPTANCE_PROCESS_PAUSED
```
    Result code indicating that a task could not be accepted because the process is paused
  - TASK_ACCEPTANCE_PAUSED
```
static final java.lang.Integer TASK_ACCEPTANCE_PAUSED
```
    Result code indicating that a task could not be accepted because the task is paused
  - TASK_ACCEPTANCE_NOT_ASSIGNEE_CAN_COMPLETE
```
static final java.lang.Integer TASK_ACCEPTANCE_NOT_ASSIGNEE_CAN_COMPLETE
```
    Result code indicating that a task could not be accepted because the current user is not an assignee, but the user has complete permissions
  - TASK_PRIVILEGE_REJECT_ONLY
```
static final java.lang.Integer TASK_PRIVILEGE_REJECT_ONLY
```
    Constant indicating that the current user only has the privileges to reject a given task
  - TASK_PRIVILEGE_REASSIGN_WITHIN_POOL
```
static final java.lang.Integer TASK_PRIVILEGE_REASSIGN_WITHIN_POOL
```
    Constant indicating that the current user has the privileges to reject a given task, or to reassign the task within the assignment pool
  - TASK_PRIVILEGE_REASSIGN_ANY
```
static final java.lang.Integer TASK_PRIVILEGE_REASSIGN_ANY
```
    Constant indicating that the current user has the privileges to reject a given task, or to reassign the task to any user or group (inside or outside of the assignment pool)
  - TASK_REJECTION_RESULT_SUCCESS
```
static final java.lang.Integer TASK_REJECTION_RESULT_SUCCESS
```
    Result code indicating that the rejection of a task was successful
  - TASK_REJECTION_RESULT_INVALID_STATE
```
static final java.lang.Integer TASK_REJECTION_RESULT_INVALID_STATE
```
    Result code indicating that the rejection of a task was unsuccessful because the task was in an invalid state to be rejected (i.e., the task was cancelled)
  - TASK_REJECTION_RESULT_NOT_OWNER
```
static final java.lang.Integer TASK_REJECTION_RESULT_NOT_OWNER
```
    Result code indicating that the rejection of a task was unsuccessful because the current user is not the owner of the task
  - PROCESS_CANCELLATION_SUCCESS
```
static final java.lang.Integer PROCESS_CANCELLATION_SUCCESS
```
    Result code indicating that the cancellation of a process was successful
  - PROCESS_CANCELLATION_INVALID_PROCESS
```
static final java.lang.Integer PROCESS_CANCELLATION_INVALID_PROCESS
```
    Result code indicating that the cancellation of a process failed because the process is invalid
  - PROCESS_CANCELLATION_INSUFFICIENT_PRIVILEGES
```
static final java.lang.Integer PROCESS_CANCELLATION_INSUFFICIENT_PRIVILEGES
```
    Result code indicating that the cancellation of a process failed because the current user has insufficient privileges to cancel the process - that is, if ProcessPermissions.isStopAndPause() returns false
  - PROCESS_CANCELLATION_INVALID_STATE
```
static final java.lang.Integer PROCESS_CANCELLATION_INVALID_STATE
```
    Result code indicating that the cancellation of a process failed because the process is in an invalid state - that is, if the status of the process is not one of ProcessSummary.STATE_ACTIVE, ProcessSummary.STATE_PAUSED or ProcessSummary.STATE_PAUSED_BY_EXCEPTION
  - PROCESS_CANCELLATION_LOCKED_PROCESS
```
static final java.lang.Integer PROCESS_CANCELLATION_LOCKED_PROCESS
```
    Result code indicating that the cancellation of a process failed because the process is locked (see lockProcessModelForProcess(Long,boolean))
  - TASK_CANCELLATION_SUCCESS
```
static final java.lang.Integer TASK_CANCELLATION_SUCCESS
```
    Result code indicating that the cancellation of a task was successful
  - TASK_CANCELLATION_INVALID_TASK
```
static final java.lang.Integer TASK_CANCELLATION_INVALID_TASK
```
    Result code indicating that the cancellation of a task failed because the task is invalid
  - TASK_CANCELLATION_INSUFFICIENT_PRIVILEGES
```
static final java.lang.Integer TASK_CANCELLATION_INSUFFICIENT_PRIVILEGES
```
    Result code indicating that the cancellation of a task failed because the current user has insufficient privileges to cancel the task - that is, if ProcessPermissions.isStopAndPause() returns false for the process containing the task
  - TASK_CANCELLATION_INVALID_STATE
```
static final java.lang.Integer TASK_CANCELLATION_INVALID_STATE
```
    Result code indicating that the cancellation of a task failed because the task is in an invalid state
  - NOTE_CREATION_PROCESS_INVALID_BEAN
```
static final java.lang.Integer NOTE_CREATION_PROCESS_INVALID_BEAN
```
    Result code indicating that the creation of note metadata for a process failed because a null or invalid bean was passed as a parameter.
  - NOTE_CREATION_PROCESS_CANCELLED
```
static final java.lang.Integer NOTE_CREATION_PROCESS_CANCELLED
```
    Result code indicating that the creation of note metadata for a process failed because the process has been cancelled
  - NOTE_CREATION_PROCESS_NOTE_LIMIT_EXCEEDED
```
static final java.lang.Integer NOTE_CREATION_PROCESS_NOTE_LIMIT_EXCEEDED
```
    Result code indicating that the creation of note metadata for a process failed because the process already has the maximum allowed number of notes
  - NOTE_CREATION_PROCESS_INVALID
```
static final java.lang.Integer NOTE_CREATION_PROCESS_INVALID
```
    Result code indicating that the creation of note metadata for a process failed because the process is invalid
  - NOTE_CREATION_PROCESS_INSUFFICIENT_PRIVILEGES
```
static final java.lang.Integer NOTE_CREATION_PROCESS_INSUFFICIENT_PRIVILEGES
```
    Result code indicating that the creation of note metadata for a process failed because the current user has insufficient privileges to attach notes to the process. This will be the case if ProcessPermissions.isAddAttachment() returns false
  - NOTE_CREATION_PROCESS_SUCCESS
```
static final java.lang.Integer NOTE_CREATION_PROCESS_SUCCESS
```
    Result code indicating that the creation of note metadata for a process was successful
  - NOTE_CREATION_TASK_INVALID_BEAN
```
static final java.lang.Integer NOTE_CREATION_TASK_INVALID_BEAN
```
    Result code indicating that the creation of note metadata for a task failed because a null or invalid bean was passed as a parameter.
  - NOTE_CREATION_TASK_UNATTENDED
```
static final java.lang.Integer NOTE_CREATION_TASK_UNATTENDED
```
    Result code indicating that the creation of note metadata for a task failed because the task is unattended
  - NOTE_CREATION_TASK_CANCELLED
```
static final java.lang.Integer NOTE_CREATION_TASK_CANCELLED
```
    Result code indicating that the creation of note metadata for a task failed because the task has been cancelled
  - NOTE_CREATION_TASK_NOTE_LIMIT_EXCEEDED
```
static final java.lang.Integer NOTE_CREATION_TASK_NOTE_LIMIT_EXCEEDED
```
    Result code indicating that the creation of note metadata for a task failed because the task already has the maximum allowed number of notes
  - NOTE_CREATION_TASK_INVALID
```
static final java.lang.Integer NOTE_CREATION_TASK_INVALID
```
    Result code indicating that the creation of note metadata for a task failed because the task is invalid
  - NOTE_CREATION_TASK_INSUFFICIENT_PRIVILEGES
```
static final java.lang.Integer NOTE_CREATION_TASK_INSUFFICIENT_PRIVILEGES
```
    Result code indicating that the creation of note metadata for a task failed because the current user has insufficient privileges to attach notes to the task. This will be the case if NodePermissions.isAddAttachment() returns false
  - NOTE_CREATION_TASK_SUCCESS
```
static final java.lang.Integer NOTE_CREATION_TASK_SUCCESS
```
    Result code indicating that the creation of note metadata for a task was successful
  - NOTE_DELETION_INVALID
```
static final java.lang.Integer NOTE_DELETION_INVALID
```
    Result code indicating that the deletion of note metadata from a process or task failed because the note does not exist
  - NOTE_DELETION_INSUFFICIENT_PRIVILEGES
```
static final java.lang.Integer NOTE_DELETION_INSUFFICIENT_PRIVILEGES
```
    Result code indicating that the deletion of note metadata from a process or task failed because the user does not have sufficient privileges to delete the note from the process or task. This is the case when ProcessPermissions.isRemoveAttachment() returns false for the process, or for the process containing the task, respectively.
  - NOTE_DELETION_SUCCESS
```
static final java.lang.Integer NOTE_DELETION_SUCCESS
```
    Result code indicating that the deletion of note metadata from a process or task succeeded
  - ACTIVITY_VALID
```
static final int ACTIVITY_VALID
```
    A constant indicating that an activity is valid. There are two options for an activity to be considered valid: 1) when the activity is unattended and not completed, and 2) when the activity is waiting on Java. For both options it is necessary that the process where the activity is contained must not be cancelled, completed or halted. ).
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_PROCESS_CANCELLED
```
static final int ACTIVITY_PROCESS_CANCELLED
```
    A constant indicating that an activity exists in a process that has been cancelled
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_PROCESS_COMPLETED
```
static final int ACTIVITY_PROCESS_COMPLETED
```
    A constant indicating that an activity exists in a process that has been completed
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_PROCESS_DELETED
```
static final int ACTIVITY_PROCESS_DELETED
```
    A constant indicating that an activity has been deleted, since its parent process has been deleted
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_COMPLETED
```
static final int ACTIVITY_COMPLETED
```
    A constant indicating that an activity is in an invalid state. Either the activity has been completed or the activity is in an invalid state.
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_PROCESS_PAUSED
```
static final int ACTIVITY_PROCESS_PAUSED
```
    A constant indicating that the process for an activity is paused
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_PAUSED
```
static final int ACTIVITY_PAUSED
```
    A constant indicating that an activity has been paused
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_CANCELLED
```
static final int ACTIVITY_CANCELLED
```
    A constant indicating that an activity has been cancelled
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_INVALID_STATE
```
static final int ACTIVITY_INVALID_STATE
```
    A constant indicating that an activity is in an invalid state
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_SKIPPED
```
static final int ACTIVITY_SKIPPED
```
    A constant indicating that an activity has been skipped by an exception flow.
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_WAITING
```
static final int ACTIVITY_WAITING
```
    A constant indicating that an activity is waiting on an asynchronous workq item in Java.
    
    See Also:
    
    Constant Field Values
  - RESULT_CODE_RECURRING_TASK
```
static final java.lang.Integer RESULT_CODE_RECURRING_TASK
```
    Result code indicating that the task is set to recur
  - RESULT_CODE_TOO_MANY_INSTANCES
```
static final java.lang.Integer RESULT_CODE_TOO_MANY_INSTANCES
```
    Result code indicating that the maximum number of task instances has been reached and a new one cannot be created.
  - RESULT_CODE_SUCCESS
```
static final java.lang.Integer RESULT_CODE_SUCCESS
```
    Result code indicating that the action is successful
  - RESULT_CODE_INVALID_PROCESS
```
static final java.lang.Integer RESULT_CODE_INVALID_PROCESS
```
    Result code indicating that the specified process is invalid
  - RESULT_CODE_INSUFFICIENT_PRIVILEGES
```
static final java.lang.Integer RESULT_CODE_INSUFFICIENT_PRIVILEGES
```
    Result code indicating that the current user does not have sufficient privileges to perform the action
  - RESULT_CODE_INVALID_STATE
```
static final java.lang.Integer RESULT_CODE_INVALID_STATE
```
    Result code indicating that something is in an invalid state for the action to succeed
  - RESULT_CODE_INVALID_OPERATION
```
static final java.lang.Integer RESULT_CODE_INVALID_OPERATION
```
    Result code indicating that the attempted operation was invalid for the current user
  - RESULT_CODE_INVALID_TASK
```
static final java.lang.Integer RESULT_CODE_INVALID_TASK
```
    Result code indicating that the specified task is invalid
  - RESULT_CODE_LOCK_EXCEPTION
```
static final java.lang.Integer RESULT_CODE_LOCK_EXCEPTION
```
    Result code indicating that an item is locked
  - RESULT_CODE_LOGIC_NODE
```
static final java.lang.Integer RESULT_CODE_LOGIC_NODE
```
    Result code indicating that an item is a logic node and cannot be started
  - RESULT_CODE_INVALID_NODE
```
static final java.lang.Integer RESULT_CODE_INVALID_NODE
```
    Result code indicating that the node is invalid because its activity chaining settings prohibit multiple instances
  - RESULT_CODE_NODE_MULTIPLICITY
```
static final java.lang.Integer RESULT_CODE_NODE_MULTIPLICITY
```
    Result code indicating that a node cannot be started because multiple instances of the node are not allowed.
  - RESULT_CODE_NODE_CANNOT_PAUSE
```
static final java.lang.Integer RESULT_CODE_NODE_CANNOT_PAUSE
```
    Result code indicating that this is an event and cannot be paused
  - ATTACHMENT_RETURN_TASK_UNATTENDED
```
static final java.lang.Integer ATTACHMENT_RETURN_TASK_UNATTENDED
```
    Result code indicating that an attachment may not be added to the task because the task is unattended
  - ATTACHMENT_RETURN_TASK_CANCELLED
```
static final java.lang.Integer ATTACHMENT_RETURN_TASK_CANCELLED
```
    Result code indicating that an attachment may not be added to the task because the task was cancelled
  - ATTACHMENT_RETURN_PROCESS_CANCELLED
```
static final java.lang.Integer ATTACHMENT_RETURN_PROCESS_CANCELLED
```
    Result code indicating that an attachment may not be added to the process because the process was cancelled
  - ATTACHMENT_RETURN_TOO_MANY
```
static final java.lang.Integer ATTACHMENT_RETURN_TOO_MANY
```
    Result code indicating that an attachment may not be added because too many attachments have been added
  - ATTACHMENT_RETURN_INVALID
```
static final java.lang.Integer ATTACHMENT_RETURN_INVALID
```
    Result code indicating that an attachment may not be added/removed because the specified process, task, or attachment does not exist
  - ATTACHMENT_RETURN_PERMISSIONS
```
static final java.lang.Integer ATTACHMENT_RETURN_PERMISSIONS
```
    Result code indicating that an attachment may not be added/removed because the user does not have permission to do so
  - ATTACHMENT_RETURN_SUCCESS
```
static final java.lang.Integer ATTACHMENT_RETURN_SUCCESS
```
    Return code indicating that adding an attachment was successful
  - NOTES_RETURN_INVALID
```
static final java.lang.Integer NOTES_RETURN_INVALID
```
    Return code indicating that a note may not be added/removed because the specified process, task, or note does not exist
  - NOTES_RETURN_PERMISSIONS
```
static final java.lang.Integer NOTES_RETURN_PERMISSIONS
```
    Return code indicating that a note may not be added/removed because the user does not have permission to do so
  - NOTES_RETURN_SUCCESS
```
static final java.lang.Integer NOTES_RETURN_SUCCESS
```
    Return code indicating that adding/removing a Note was successful
  - UNATTENDED_TASKS
```
static final int UNATTENDED_TASKS
```
    Code for unattended tasks only
    
    See Also:
    
    Constant Field Values
  - ATTENDED_TASKS
```
static final int ATTENDED_TASKS
```
    Code for attended tasks only
    
    See Also:
    
    Constant Field Values
  - UNATTENDED_AND_ATTENDED_TASKS
```
static final int UNATTENDED_AND_ATTENDED_TASKS
```
    Code for attended and unattended tasks
    
    See Also:
    
    Constant Field Values
  - EXECUTION_FAILURE_EXCEPTION
```
static final int EXECUTION_FAILURE_EXCEPTION
```
    Constant indicating that unattended activities could not be completed because an exception occurred
    
    See Also:
    
    Constant Field Values
  - EXECUTION_FAILURE_TIMEOUT
```
static final int EXECUTION_FAILURE_TIMEOUT
```
    Constant indicating that unattended activities could not be completed because a timeout occurred connecting to Java from the process engine
    
    See Also:
    
    Constant Field Values
  - RETRIEVE_PROCESS_MODEL_NOTES
```
static final int RETRIEVE_PROCESS_MODEL_NOTES
```
    Constant indicating that that the notes and attachments of the underlying process model should be retrieved by getProcessDiagram(java.lang.Long, int)
    
    See Also:
    
    Constant Field Values
  - RETRIEVE_PROCESS_NOTES
```
static final int RETRIEVE_PROCESS_NOTES
```
    Constant indicating that that the notes and attachments of the process should be retrieved by getProcessDiagram(java.lang.Long, int)
    
    See Also:
    
    Constant Field Values
  - saveActivityParameters$UPDATES
```
static final boolean saveActivityParameters$UPDATES
```
    See Also:
    
    Constant Field Values
  - completeActivity$UPDATES
```
static final boolean completeActivity$UPDATES
```
    See Also:
    
    Constant Field Values
  - acknowledgeActivity$UPDATES
```
static final boolean acknowledgeActivity$UPDATES
```
    See Also:
    
    Constant Field Values
  - completeClone$UPDATES
```
static final boolean completeClone$UPDATES
```
    See Also:
    
    Constant Field Values
  - getLingeringTasksForProcess$UPDATES
```
static final boolean getLingeringTasksForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getLingeringTasksForProcessAndNode$UPDATES
```
static final boolean getLingeringTasksForProcessAndNode$UPDATES
```
    See Also:
    
    Constant Field Values
  - refreshTaskForm$UPDATES
```
static final boolean refreshTaskForm$UPDATES
```
    See Also:
    
    Constant Field Values
  - execute$UPDATES
```
static final boolean execute$UPDATES
```
    See Also:
    
    Constant Field Values
  - getActivityMetadata$UPDATES
```
static final boolean getActivityMetadata$UPDATES
```
    See Also:
    
    Constant Field Values
  - getActivitiesMetadata$UPDATES
```
static final boolean getActivitiesMetadata$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTaskFormExpression$UPDATES
```
static final boolean getTaskFormExpression$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTaskFormExpressions$UPDATES
```
static final boolean getTaskFormExpressions$UPDATES
```
    See Also:
    
    Constant Field Values
  - acceptTask$UPDATES
```
static final boolean acceptTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTaskPrivileges$UPDATES
```
static final boolean getTaskPrivileges$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTaskAssignees$UPDATES
```
static final boolean getTaskAssignees$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTasksAssignees$UPDATES
```
static final boolean getTasksAssignees$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAssigneePoolForTasks$UPDATES
```
static final boolean getAssigneePoolForTasks$UPDATES
```
    See Also:
    
    Constant Field Values
  - reassignTask$UPDATES
```
static final boolean reassignTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - rejectTask$UPDATES
```
static final boolean rejectTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTaskDetails$UPDATES
```
static final boolean getTaskDetails$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTasksDetails$UPDATES
```
static final boolean getTasksDetails$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTaskOpaqueUri$UPDATES
```
static final boolean getTaskOpaqueUri$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTaskUrl$UPDATES
```
static final boolean getTaskUrl$UPDATES
```
    See Also:
    
    Constant Field Values
  - getProcessDetails$UPDATES
```
static final boolean getProcessDetails$UPDATES
```
    See Also:
    
    Constant Field Values
  - notifyException$UPDATES
```
static final boolean notifyException$UPDATES
```
    See Also:
    
    Constant Field Values
  - executionFailure$UPDATES
```
static final boolean executionFailure$UPDATES
```
    See Also:
    
    Constant Field Values
  - executionFailureMessage$UPDATES
```
static final boolean executionFailureMessage$UPDATES
```
    See Also:
    
    Constant Field Values
  - deleteProcess$UPDATES
```
static final boolean deleteProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - deleteProcesses$UPDATES
```
static final boolean deleteProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - cancelProcess$UPDATES
```
static final boolean cancelProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - notifyInvalidParameters$UPDATES
```
static final boolean notifyInvalidParameters$UPDATES
```
    See Also:
    
    Constant Field Values
  - notifyUsersCreationByJava$UPDATES
```
static final boolean notifyUsersCreationByJava$UPDATES
```
    See Also:
    
    Constant Field Values
  - checkActivityValidity$UPDATES
```
static final boolean checkActivityValidity$UPDATES
```
    See Also:
    
    Constant Field Values
  - canCompleteActivity$UPDATES
```
static final boolean canCompleteActivity$UPDATES
```
    See Also:
    
    Constant Field Values
  - canCompleteClone$UPDATES
```
static final boolean canCompleteClone$UPDATES
```
    See Also:
    
    Constant Field Values
  - getSubProcessesForProcess$UPDATES
```
static final boolean getSubProcessesForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getSynchronousSubProcessesForProcess$UPDATES
```
static final boolean getSynchronousSubProcessesForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTopLevelProcessForProcess$UPDATES
```
static final boolean getTopLevelProcessForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - isSubProcess$UPDATES
```
static final boolean isSubProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - isSynchronousSubProcess$UPDATES
```
static final boolean isSynchronousSubProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - containsSubProcesses$UPDATES
```
static final boolean containsSubProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - containsLinkProcesses$UPDATES
```
static final boolean containsLinkProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - containsSynchronousSubProcesses$UPDATES
```
static final boolean containsSynchronousSubProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - containsAsynchronousSubProcesses$UPDATES
```
static final boolean containsAsynchronousSubProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - getLinkProcessesForProcess$UPDATES
```
static final boolean getLinkProcessesForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAsynchronousSubProcessesForProcess$UPDATES
```
static final boolean getAsynchronousSubProcessesForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - isLinkProcess$UPDATES
```
static final boolean isLinkProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - isAsynchronousSubProcess$UPDATES
```
static final boolean isAsynchronousSubProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getActivityProperties$UPDATES
```
static final boolean getActivityProperties$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTaskProperties$UPDATES
```
static final boolean getTaskProperties$UPDATES
```
    See Also:
    
    Constant Field Values
  - setTaskProperties$UPDATES
```
static final boolean setTaskProperties$UPDATES
```
    See Also:
    
    Constant Field Values
  - setTaskDisplayName$UPDATES
```
static final boolean setTaskDisplayName$UPDATES
```
    See Also:
    
    Constant Field Values
  - getProcessProperties$UPDATES
```
static final boolean getProcessProperties$UPDATES
```
    See Also:
    
    Constant Field Values
  - setProcessProperties$UPDATES
```
static final boolean setProcessProperties$UPDATES
```
    See Also:
    
    Constant Field Values
  - getProcessParameters$UPDATES
```
static final boolean getProcessParameters$UPDATES
```
    See Also:
    
    Constant Field Values
  - getProcessParameter$UPDATES
```
static final boolean getProcessParameter$UPDATES
```
    See Also:
    
    Constant Field Values
  - getProcessVariables$UPDATES
```
static final boolean getProcessVariables$UPDATES
```
    See Also:
    
    Constant Field Values
  - getRecursiveProcessVariables$UPDATES
```
static final boolean getRecursiveProcessVariables$UPDATES
```
    See Also:
    
    Constant Field Values
  - getProcessVariablesPaging$UPDATES
```
static final boolean getProcessVariablesPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getProcessVariable$UPDATES
```
static final boolean getProcessVariable$UPDATES
```
    See Also:
    
    Constant Field Values
  - setProcessVariables$UPDATES
```
static final boolean setProcessVariables$UPDATES
```
    See Also:
    
    Constant Field Values
  - setProcessVariable$UPDATES
```
static final boolean setProcessVariable$UPDATES
```
    See Also:
    
    Constant Field Values
  - addProcessVariable$UPDATES
```
static final boolean addProcessVariable$UPDATES
```
    See Also:
    
    Constant Field Values
  - addProcessVariables$UPDATES
```
static final boolean addProcessVariables$UPDATES
```
    See Also:
    
    Constant Field Values
  - getSecurityForProcess$UPDATES
```
static final boolean getSecurityForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - setSecurityForProcess$UPDATES
```
static final boolean setSecurityForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getSecurityForNode$UPDATES
```
static final boolean getSecurityForNode$UPDATES
```
    See Also:
    
    Constant Field Values
  - setSecurityForNode$UPDATES
```
static final boolean setSecurityForNode$UPDATES
```
    See Also:
    
    Constant Field Values
  - setActorsInRolesForProcess$UPDATES
```
static final boolean setActorsInRolesForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - setActorsInRolesForNode$UPDATES
```
static final boolean setActorsInRolesForNode$UPDATES
```
    See Also:
    
    Constant Field Values
  - setInheritanceForProcess$UPDATES
```
static final boolean setInheritanceForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - setInheritanceForNode$UPDATES
```
static final boolean setInheritanceForNode$UPDATES
```
    See Also:
    
    Constant Field Values
  - getPermissionsForProcess$UPDATES
```
static final boolean getPermissionsForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getPermissionsForProcesses$UPDATES
```
static final boolean getPermissionsForProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - getPermissionsForNode$UPDATES
```
static final boolean getPermissionsForNode$UPDATES
```
    See Also:
    
    Constant Field Values
  - getPermissionsForNodes$UPDATES
```
static final boolean getPermissionsForNodes$UPDATES
```
    See Also:
    
    Constant Field Values
  - getPermissionsForProcessDiagram$UPDATES
```
static final boolean getPermissionsForProcessDiagram$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAttachmentsForProcess$UPDATES
```
static final boolean getAttachmentsForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAttachmentsAndNotesForTask$UPDATES
```
static final boolean getAttachmentsAndNotesForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAttachmentsForTask$UPDATES
```
static final boolean getAttachmentsForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeProcessAttachments$UPDATES
```
static final boolean removeProcessAttachments$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeProcessAttachment$UPDATES
```
static final boolean removeProcessAttachment$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeTaskAttachments$UPDATES
```
static final boolean removeTaskAttachments$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeTaskAttachment$UPDATES
```
static final boolean removeTaskAttachment$UPDATES
```
    See Also:
    
    Constant Field Values
  - addAttachmentToProcess$UPDATES
```
static final boolean addAttachmentToProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - addAttachmentToProcesses$UPDATES
```
static final boolean addAttachmentToProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - addAttachmentsToProcess$UPDATES
```
static final boolean addAttachmentsToProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - addAttachmentToTask$UPDATES
```
static final boolean addAttachmentToTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - addAttachmentToTasks$UPDATES
```
static final boolean addAttachmentToTasks$UPDATES
```
    See Also:
    
    Constant Field Values
  - addAttachmentsToTask$UPDATES
```
static final boolean addAttachmentsToTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - getDeadlineForProcess$UPDATES
```
static final boolean getDeadlineForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - setDeadlineForProcess$UPDATES
```
static final boolean setDeadlineForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getDeadlineForTask$UPDATES
```
static final boolean getDeadlineForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - setDeadlineForTask$UPDATES
```
static final boolean setDeadlineForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - getPriorityOfTask$UPDATES
```
static final boolean getPriorityOfTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - getPriorityOfTasks$UPDATES
```
static final boolean getPriorityOfTasks$UPDATES
```
    See Also:
    
    Constant Field Values
  - getPriorityOfProcess$UPDATES
```
static final boolean getPriorityOfProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getPriorityOfProcesses$UPDATES
```
static final boolean getPriorityOfProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - setPriorityOfTask$UPDATES
```
static final boolean setPriorityOfTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - setPriorityOfTasks$UPDATES
```
static final boolean setPriorityOfTasks$UPDATES
```
    See Also:
    
    Constant Field Values
  - setPriorityOfProcess$UPDATES
```
static final boolean setPriorityOfProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - setPriorityOfProcesses$UPDATES
```
static final boolean setPriorityOfProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - raisePriorityOfTask$UPDATES
```
static final boolean raisePriorityOfTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - raisePriorityOfTasks$UPDATES
```
static final boolean raisePriorityOfTasks$UPDATES
```
    See Also:
    
    Constant Field Values
  - raisePriorityOfProcess$UPDATES
```
static final boolean raisePriorityOfProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - raisePriorityOfProcesses$UPDATES
```
static final boolean raisePriorityOfProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - lowerPriorityOfTask$UPDATES
```
static final boolean lowerPriorityOfTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - lowerPriorityOfTasks$UPDATES
```
static final boolean lowerPriorityOfTasks$UPDATES
```
    See Also:
    
    Constant Field Values
  - lowerPriorityOfProcess$UPDATES
```
static final boolean lowerPriorityOfProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - lowerPriorityOfProcesses$UPDATES
```
static final boolean lowerPriorityOfProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - containsLinkProcessesInheritingPriority$UPDATES
```
static final boolean containsLinkProcessesInheritingPriority$UPDATES
```
    See Also:
    
    Constant Field Values
  - containsSubProcessesInheritingPriority$UPDATES
```
static final boolean containsSubProcessesInheritingPriority$UPDATES
```
    See Also:
    
    Constant Field Values
  - createNoteMetadata$UPDATES
```
static final boolean createNoteMetadata$UPDATES
```
    See Also:
    
    Constant Field Values
  - createNoteMetadatas$UPDATES
```
static final boolean createNoteMetadatas$UPDATES
```
    See Also:
    
    Constant Field Values
  - getNotePath$UPDATES
```
static final boolean getNotePath$UPDATES
```
    See Also:
    
    Constant Field Values
  - getNotePaths$UPDATES
```
static final boolean getNotePaths$UPDATES
```
    See Also:
    
    Constant Field Values
  - getCurrentNotePaths$UPDATES
```
static final boolean getCurrentNotePaths$UPDATES
```
    See Also:
    
    Constant Field Values
  - setCurrentNotePaths$UPDATES
```
static final boolean setCurrentNotePaths$UPDATES
```
    See Also:
    
    Constant Field Values
  - getExceptionNoteMetadataForTask$UPDATES
```
static final boolean getExceptionNoteMetadataForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - getExceptionNoteMetadatasForProcess$UPDATES
```
static final boolean getExceptionNoteMetadatasForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAllExceptionNoteMetadatasForProcess$UPDATES
```
static final boolean getAllExceptionNoteMetadatasForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - createNoteMetadataForProcess$UPDATES
```
static final boolean createNoteMetadataForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - createNoteMetadataForProcesses$UPDATES
```
static final boolean createNoteMetadataForProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - createNoteMetadatasForProcess$UPDATES
```
static final boolean createNoteMetadatasForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getNoteMetadatasForProcess$UPDATES
```
static final boolean getNoteMetadatasForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getNoteMetadatasForProcesses$UPDATES
```
static final boolean getNoteMetadatasForProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - createNoteMetadataForTask$UPDATES
```
static final boolean createNoteMetadataForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - createNoteMetadataForTasks$UPDATES
```
static final boolean createNoteMetadataForTasks$UPDATES
```
    See Also:
    
    Constant Field Values
  - createNoteMetadatasForTask$UPDATES
```
static final boolean createNoteMetadatasForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - getNoteMetadatasForTask$UPDATES
```
static final boolean getNoteMetadatasForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - getNoteMetadatasForTasks$UPDATES
```
static final boolean getNoteMetadatasForTasks$UPDATES
```
    See Also:
    
    Constant Field Values
  - deleteNoteMetadataForProcess$UPDATES
```
static final boolean deleteNoteMetadataForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - deleteNoteMetadataForTask$UPDATES
```
static final boolean deleteNoteMetadataForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - deleteNoteMetadatasForProcess$UPDATES
```
static final boolean deleteNoteMetadatasForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - deleteNoteMetadatasForTask$UPDATES
```
static final boolean deleteNoteMetadatasForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - updateNoteMetadataForProcess$UPDATES
```
static final boolean updateNoteMetadataForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - updateNoteMetadataForTask$UPDATES
```
static final boolean updateNoteMetadataForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - updateNoteMetadatasForProcess$UPDATES
```
static final boolean updateNoteMetadatasForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - updateNoteMetadatasForTask$UPDATES
```
static final boolean updateNoteMetadatasForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - getNoteMetadataForTask$UPDATES
```
static final boolean getNoteMetadataForTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - getNoteMetadataForProcess$UPDATES
```
static final boolean getNoteMetadataForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTasksForProcess$UPDATES
```
static final boolean getTasksForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - pauseProcess$UPDATES
```
static final boolean pauseProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - pauseProcesses$UPDATES
```
static final boolean pauseProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - resumeProcess$UPDATES
```
static final boolean resumeProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - resumeProcesses$UPDATES
```
static final boolean resumeProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - cancelProcesses$UPDATES
```
static final boolean cancelProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - startQuickTask$UPDATES
```
static final boolean startQuickTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - startTask$UPDATES
```
static final boolean startTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - startTasks$UPDATES
```
static final boolean startTasks$UPDATES
```
    See Also:
    
    Constant Field Values
  - resumeTask$UPDATES
```
static final boolean resumeTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - resumeTasks$UPDATES
```
static final boolean resumeTasks$UPDATES
```
    See Also:
    
    Constant Field Values
  - pauseTask$UPDATES
```
static final boolean pauseTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - pauseTasks$UPDATES
```
static final boolean pauseTasks$UPDATES
```
    See Also:
    
    Constant Field Values
  - cancelTask$UPDATES
```
static final boolean cancelTask$UPDATES
```
    See Also:
    
    Constant Field Values
  - cancelTasks$UPDATES
```
static final boolean cancelTasks$UPDATES
```
    See Also:
    
    Constant Field Values
  - startAllNodes$UPDATES
```
static final boolean startAllNodes$UPDATES
```
    See Also:
    
    Constant Field Values
  - restartAllNodes$UPDATES
```
static final boolean restartAllNodes$UPDATES
```
    See Also:
    
    Constant Field Values
  - pauseAllNodes$UPDATES
```
static final boolean pauseAllNodes$UPDATES
```
    See Also:
    
    Constant Field Values
  - resumeAllNodes$UPDATES
```
static final boolean resumeAllNodes$UPDATES
```
    See Also:
    
    Constant Field Values
  - cancelAllNodes$UPDATES
```
static final boolean cancelAllNodes$UPDATES
```
    See Also:
    
    Constant Field Values
  - reassignTaskToSameAssigneePool$UPDATES
```
static final boolean reassignTaskToSameAssigneePool$UPDATES
```
    See Also:
    
    Constant Field Values
  - reassignTasksToAssigneePool$UPDATES
```
static final boolean reassignTasksToAssigneePool$UPDATES
```
    See Also:
    
    Constant Field Values
  - reassignTasksToSameAssigneePool$UPDATES
```
static final boolean reassignTasksToSameAssigneePool$UPDATES
```
    See Also:
    
    Constant Field Values
  - getProcessDiagram$UPDATES
```
static final boolean getProcessDiagram$UPDATES
```
    See Also:
    
    Constant Field Values
  - updateProcessModelForProcess$UPDATES
```
static final boolean updateProcessModelForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - upgradeProcesses$UPDATES
```
static final boolean upgradeProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - triggerSchedule$UPDATES
```
static final boolean triggerSchedule$UPDATES
```
    See Also:
    
    Constant Field Values
  - triggerTaskEscalation$UPDATES
```
static final boolean triggerTaskEscalation$UPDATES
```
    See Also:
    
    Constant Field Values
  - skipTaskEscalation$UPDATES
```
static final boolean skipTaskEscalation$UPDATES
```
    See Also:
    
    Constant Field Values
  - getScheduleSummariesForNode$UPDATES
```
static final boolean getScheduleSummariesForNode$UPDATES
```
    See Also:
    
    Constant Field Values
  - lockProcessModelForProcess$UPDATES
```
static final boolean lockProcessModelForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - lockProcesses$UPDATES
```
static final boolean lockProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - unlockProcesses$UPDATES
```
static final boolean unlockProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - unlockProcessModelForProcess$UPDATES
```
static final boolean unlockProcessModelForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - unlockProcessModels$UPDATES
```
static final boolean unlockProcessModels$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMaximumNumberOfNotes$UPDATES
```
static final boolean getMaximumNumberOfNotes$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMaximumNumberOfAttachments$UPDATES
```
static final boolean getMaximumNumberOfAttachments$UPDATES
```
    See Also:
    
    Constant Field Values
  - skipRecurrence$UPDATES
```
static final boolean skipRecurrence$UPDATES
```
    See Also:
    
    Constant Field Values
  - triggerRecurrence$UPDATES
```
static final boolean triggerRecurrence$UPDATES
```
    See Also:
    
    Constant Field Values
  - setTaskStateSubmitted$UPDATES
```
static final boolean setTaskStateSubmitted$UPDATES
```
    See Also:
    
    Constant Field Values
  - keepSubmittedTasksAlive$UPDATES
```
static final boolean keepSubmittedTasksAlive$UPDATES
```
    See Also:
    
    Constant Field Values
  - setTaskStateRunning$UPDATES
```
static final boolean setTaskStateRunning$UPDATES
```
    See Also:
    
    Constant Field Values
  - getCurrentTasksForProcess$UPDATES
```
static final boolean getCurrentTasksForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getCompletedTasksForProcess$UPDATES
```
static final boolean getCompletedTasksForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getCancelledTasksForProcess$UPDATES
```
static final boolean getCancelledTasksForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getPausedTasksForProcess$UPDATES
```
static final boolean getPausedTasksForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTasksWithExceptionsForProcess$UPDATES
```
static final boolean getTasksWithExceptionsForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - unarchiveProcess$UPDATES
```
static final boolean unarchiveProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - unarchiveProcesses$UPDATES
```
static final boolean unarchiveProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - archiveProcess$UPDATES
```
static final boolean archiveProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - archiveProcesses$UPDATES
```
static final boolean archiveProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - getArchivePaths$UPDATES
```
static final boolean getArchivePaths$UPDATES
```
    See Also:
    
    Constant Field Values
  - setArchivePaths$UPDATES
```
static final boolean setArchivePaths$UPDATES
```
    See Also:
    
    Constant Field Values
  - getNextRecurrence$UPDATES
```
static final boolean getNextRecurrence$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAttachmentsInProcess$UPDATES
```
static final boolean getAttachmentsInProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getNoteMetadatasInProcess$UPDATES
```
static final boolean getNoteMetadatasInProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - updateUsernames$UPDATES
```
static final boolean updateUsernames$UPDATES
```
    See Also:
    
    Constant Field Values
  - commitUpdateUsernames$UPDATES
```
static final boolean commitUpdateUsernames$UPDATES
```
    See Also:
    
    Constant Field Values
  - rollbackUpdateUsernames$UPDATES
```
static final boolean rollbackUpdateUsernames$UPDATES
```
    See Also:
    
    Constant Field Values
  - uncompleteActivity$UPDATES
```
static final boolean uncompleteActivity$UPDATES
```
    See Also:
    
    Constant Field Values
  - setApplicationAdministratorGroup$UPDATES
```
static final boolean setApplicationAdministratorGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - reloadProperties$UPDATES
```
static final boolean reloadProperties$UPDATES
```
    See Also:
    
    Constant Field Values
  - validate$UPDATES
```
static final boolean validate$UPDATES
```
    See Also:
    
    Constant Field Values
  - setSiteLocaleSettings$UPDATES
```
static final boolean setSiteLocaleSettings$UPDATES
```
    See Also:
    
    Constant Field Values
  - handleMessages$UPDATES
```
static final boolean handleMessages$UPDATES
```
    See Also:
    
    Constant Field Values
  - acknowledgeMessages$UPDATES
```
static final boolean acknowledgeMessages$UPDATES
```
    See Also:
    
    Constant Field Values
  - getPmIdForProcess$UPDATES
```
static final boolean getPmIdForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - addProcessToFavorites$UPDATES
```
static final boolean addProcessToFavorites$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeProcessFromFavorites$UPDATES
```
static final boolean removeProcessFromFavorites$UPDATES
```
    See Also:
    
    Constant Field Values
  - addTaskToFavorites$UPDATES
```
static final boolean addTaskToFavorites$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeTaskFromFavorites$UPDATES
```
static final boolean removeTaskFromFavorites$UPDATES
```
    See Also:
    
    Constant Field Values
  - setDashboardPageForProcesses$UPDATES
```
static final boolean setDashboardPageForProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeDashboardPageForProcesses$UPDATES
```
static final boolean removeDashboardPageForProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAutoArchiveProperties$UPDATES
```
static final boolean getAutoArchiveProperties$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemoryUsageForExecEngine$UPDATES
```
static final boolean getMemoryUsageForExecEngine$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemoryUsageForProcessModels$UPDATES
```
static final boolean getMemoryUsageForProcessModels$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemoryUsageForProcessModelsByUUID$UPDATES
```
static final boolean getMemoryUsageForProcessModelsByUUID$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemoryUsageForProcesses$UPDATES
```
static final boolean getMemoryUsageForProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemoryUsageForProcessesByModelUUID$UPDATES
```
static final boolean getMemoryUsageForProcessesByModelUUID$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemoryUsageForNodesInProcesses$UPDATES
```
static final boolean getMemoryUsageForNodesInProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - setTimeZone$UPDATES
```
static final boolean setTimeZone$UPDATES
```
    See Also:
    
    Constant Field Values
  - setTimeZoneSameAs$UPDATES
```
static final boolean setTimeZoneSameAs$UPDATES
```
    See Also:
    
    Constant Field Values
  - getProcessHistoryRecords$UPDATES
```
static final boolean getProcessHistoryRecords$UPDATES
```
    See Also:
    
    Constant Field Values
  - getProcessHistoryRecordsPaging$UPDATES
```
static final boolean getProcessHistoryRecordsPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTasksWithStatusForProcessModel$UPDATES
```
static final boolean getTasksWithStatusForProcessModel$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTasksWithStatusForProcessModels$UPDATES
```
static final boolean getTasksWithStatusForProcessModels$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTasksWithStatusForProcess$UPDATES
```
static final boolean getTasksWithStatusForProcess$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTasksWithStatusForProcesses$UPDATES
```
static final boolean getTasksWithStatusForProcesses$UPDATES
```
    See Also:
    
    Constant Field Values
  - completeStore$UPDATES
```
static final boolean completeStore$UPDATES
```
    See Also:
    
    Constant Field Values
  - cancelStore$UPDATES
```
static final boolean cancelStore$UPDATES
```
    See Also:
    
    Constant Field Values
  - processToNextAttended$UPDATES
```
static final boolean processToNextAttended$UPDATES
```
    See Also:
    
    Constant Field Values
- Method Detail
  - saveActivityParameters
```
void saveActivityParameters(java.lang.Long activityId_,
                            ActivityClassParameter[] acps_)
                     throws InvalidActivityException,
                            PrivilegeException,
                            InvalidActivityClassParameterException,
                            InvalidUserException
```
    Saves the values for parameters of an activity. Does not complete the activity. The saved parameter values will be returned by calls to getActivityMetadata(Long). In addition to persisting parameters for later retrieval, this method is used to set the parameters for activities executed within the process engine through a call to execute(Long). The following fields must be populated in the ActivityClassParameter objects: id, value, type, and multiple
    
    Parameters:
    
    activityId_ - the id of the activity whose parameters will be saved
    
    acps_ - the parameters for the activity class, with desired values filled-in.
    
    Throws:
    
    InvalidActivityException - if the activity specified does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    java.lang.NullPointerException - if acps_ is null
    
    InvalidActivityClassParameterException - if an ActivityClassParameter provided does not exist
    
    InvalidUserException - if any of the users referenced by a ActivityClassParameter does not exist
    
    ServiceException - if any system-level error occurs
  - completeActivity
```
java.lang.Long completeActivity(java.lang.Long activityId_,
                                ActivityReturnVariable[] outputs_)
                         throws InvalidActivityException,
                                InvalidStateException,
                                PrivilegeException,
                                InvalidActivityClassParameterException,
                                InvalidUserException
```
    Signals the completion of an activity not implemented within the process engine itself. This notifies the engine that an activity has been completed so that the engine can continue the process. The ActivityReturnVariables should be the identical to those provided by getActivityMetadata(java.lang.Long), except for having the values filled-in.
    
    Parameters:
    
    activityId_ - the id of the activity that has been completed
    
    outputs_ - the return values of the completed activity
    
    Returns:
    
    the id of the next task for the user to perform, if available; null otherwise.
    
    Throws:
    
    InvalidActivityException - if the activity does not exist
    
    InvalidStateException - if activity is in a state other than in-progress, or if it is not a Java activity (attended or unattended)
    
    java.lang.NullPointerException - if outputs_ is null
    
    PrivilegeException - (for attended only) if user is not the task owner or does not have permission to complete task
    
    InvalidActivityClassParameterException - if an ActivityClassParameter provided does not exist
    
    InvalidUserException - if any of the users referenced by a ActivityReturnVariable do not exist
    
    ServiceException - if any system-level error occurs
  - acknowledgeActivity
```
@Deprecated
void acknowledgeActivity(java.lang.Long activityId_)
                              throws InvalidActivityException
```
    Deprecated. no longer necessary
    
    Acknowledge the receipt of an activity request, preventing retry of the request. After acknowledgement, an activity will timeout rather than be retried. This method is intended for use only by the Unattended Activity Server.
    
    Parameters:
    
    activityId_ - the id of the activity that has been completed
    
    Throws:
    
    InvalidActivityException - if the activity does not exist
    
    ServiceException - if any system-level error occurs
  - acknowledgeActivity
```
@Deprecated
void acknowledgeActivity(java.lang.Long[] activityId_)
                              throws InvalidActivityException
```
    Deprecated. no longer necessary
    
    Acknowledge the receipt of an activity request, preventing retry of the request. After acknowledgement, an activity will timeout rather than be retried. This method is intended for use only by the Unattended Activity Server.
    
    Parameters:
    
    activityId_ - the id of the activity that has been completed
    
    Throws:
    
    InvalidActivityException - if the activity does not exist
    
    ServiceException - if any system-level error occurs
  - completeClone
```
java.lang.Long completeClone(java.lang.Long activityId_,
                             ActivityClassParameter[] inputs_,
                             ActivityReturnVariable[] outputs_)
                      throws InvalidActivityException,
                             InvalidStateException,
                             PrivilegeException,
                             InvalidActivityClassParameterException,
                             InvalidUserException
```
    Clones the given task (only a new id is assigned to the cloned task, everything else stays the same), and completes it using the passed inputs (i.e. calls execute or completeActivity).
    
    Parameters:
    
    activityId_ - the id of the task to clone and complete
    
    inputs_ - the parameters for the activity class, with desired values filled in
    
    outputs_ - the return values of the completed activity
    
    Returns:
    
    the id of the next task for the user to perform, if available; null otherwise
    
    Throws:
    
    InvalidActivityException - if the activity does not exist
    
    InvalidStateException - if activity is in a state other than in-progress, or if it is not a Java activity (attended or unattended)
    
    PrivilegeException - (for attended only) if user is not the task owner or does not have permission to complete task
    
    InvalidActivityClassParameterException - if an ActivityClassParameter provided does not exist
    
    InvalidUserException - if any of the users referenced by a ActivityReturnVariable do not exist
  - getLingeringTasksForProcess
```
ResultPage getLingeringTasksForProcess(java.lang.Long processId_,
                                       boolean recursive,
                                       int startIndex_,
                                       int batchSize_,
                                       java.lang.Integer sortProperty_,
                                       java.lang.Integer sortOrder_)
                                throws InvalidProcessException
```
    Returns all instances of lingering nodes currently active 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:
    
    processId_ - the id of the process for which the lingering tasks should be retrieved
    
    recursive - whether to return the lingering tasks of the sub-processes of the given process 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 TaskSummary
    
    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 TaskSummary objects
    
    Throws:
    
    InvalidProcessException - if the given process id is invalid
  - getLingeringTasksForProcessAndNode
```
TaskSummary[] getLingeringTasksForProcessAndNode(java.lang.Long processId_,
                                                 java.lang.Long nodeId_)
                                          throws InvalidProcessException,
                                                 InvalidNodeException
```
    Returns all instances of the specified lingering node currently active in the specified process.
    
    Parameters:
    
    processId_ - the id of the process for which to retrieve the lingering nodes
    
    nodeId_ - the id of the node within the model of the given process for which to retrieve the lingering nodes
    
    Throws:
    
    InvalidProcessException - if the given process id is invalid
    
    InvalidNodeException - if the given node id is invalid
  - refreshTaskForm
```
@Deprecated
void refreshTaskForm(java.lang.Long activityId_)
                          throws InvalidActivityException,
                                 java.lang.IllegalArgumentException,
                                 PrivilegeException
```
    Deprecated. This method will cause a race condition between ACP refresh and form label refresh. Instead, use the "Refresh default values every time the task form is viewed" execution option in the task configuration in the model.
    
    Forces the form for a given task to be re-evaluated to reflect changes in the process state since the task was originally instantiated.
    
    Parameters:
    
    activityId_ - the id of the task
    
    Throws:
    
    InvalidActivityException - if the given activity id is invalid
    
    java.lang.IllegalArgumentException - if the given task is not attended
    
    PrivilegeException - if the current user does not have sufficient privileges to complete the given task
  - execute
```
java.lang.Long execute(java.lang.Long activityId_)
                throws InvalidActivityException,
                       PrivilegeException,
                       InvalidStateException
```
    Requests execution of an activity implemented within the process engine. Parameters for the activity should have been previously provided to the engine through saveActivityParameters(java.lang.Long, com.appiancorp.suiteapi.process.ActivityClassParameter[]).
    
    Parameters:
    
    activityId_ - the id of the activity to execute
    
    Returns:
    
    the id of the next task for the user to perform, if available; null otherwise.
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    PrivilegeException - if user is not the task owner or does not have permission to complete task
    
    InvalidStateException - if the process is in paused by exception or cancelled state, or if the task is not in-progress, or if the activity is not implemented within the process engine (attended or unattended)
    
    ServiceException - if any system-level error occurs
  - getActivityMetadata
```
ActivityExecutionMetadata getActivityMetadata(java.lang.Long activityId_)
                                       throws InvalidActivityException
```
    Gets the metadata for a specified activity. The metadata provides the necessary information for the activity to be presented to the user, if the activity is attended, and then executed either by the process engine (see execute(java.lang.Long)) or outside of the engine (see completeActivity(java.lang.Long, com.appiancorp.suiteapi.process.ActivityReturnVariable[])).
    
    Parameters:
    
    activityId_ - the id of the activity for which to get metadata
    
    Returns:
    
    ActivityExecutionMetadata for the activity
    
    Throws:
    
    InvalidActivityException - if the activity does not exist
    
    ServiceException - if any system-level error occurs
  - getActivitiesMetadata
```
ActivityExecutionMetadata[] getActivitiesMetadata(java.lang.Long[] activityIds_)
                                           throws InvalidActivityException
```
    Gets metadata for the specified activities. This method performs the same as getActivityMetadata(java.lang.Long), but in bulk.
    
    Parameters:
    
    activityIds_ - an array of the ids of the activities for which to get metadata
    
    Returns:
    
    the metadata for the activities
    
    Throws:
    
    InvalidActivityException - if the activity does not exist
    
    ServiceException - if any system-level error occurs
  - getTaskFormExpression
```
java.lang.String getTaskFormExpression(java.lang.Long taskId)
                                throws InvalidActivityException
```
    Gets task form expressions for the specified task. If a task's form is not in SAIL, return the empty string for the corresponding task id.
    
    Parameters:
    
    taskId - the id of the task for which to get the task form
    
    Returns:
    
    the task form expression for the task
    
    Throws:
    
    InvalidActivityException - if the activity does not exist
    
    ServiceException - if any system-level error occurs
  - getTaskFormExpressions
```
java.lang.String[] getTaskFormExpressions(java.lang.Long[] taskIds)
                                   throws InvalidActivityException
```
    Gets task form expressions for the specified tasks. This method performs the same as getTaskFormExpression(Long), but in bulk.
    
    Parameters:
    
    taskIds - an array of the ids of the tasks for which to get the task forms
    
    Returns:
    
    the task form expressions for the tasks
    
    Throws:
    
    InvalidActivityException - if the activity does not exist
    
    ServiceException - if any system-level error occurs
  - acceptTask
```
java.lang.Integer acceptTask(java.lang.Long activityId_)
                      throws InvalidActivityException,
                             PrivilegeException
```
    Accepts a task for a user.
    
    Parameters:
    
    activityId_ - id of Task to accept
    
    Returns:
    
    a result code for the acceptance. This is one of the TASK_ACCEPTANCE_XXX constants.
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    ServiceException - if any system-level error occurs
  - getTaskPrivileges
```
java.lang.Integer getTaskPrivileges(java.lang.Long activityId_)
                             throws InvalidActivityException,
                                    PrivilegeException
```
    Determines whether the user who is executing an attended activity is permitted to reject or reassign the task. These privileges are configured for the assignee at process model design time.
    
    Parameters:
    
    activityId_ - The id of the activity for which to get the privileges.
    
    Returns:
    
    the current users privileges. This is one of the TASK_PRIVILEGE_XXX constants. If the task is completed then this method will always return TASK_PRIVILEGE_REASSIGN_ANY.
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    ServiceException - if any system-level error occurs
  - getTaskAssignees
```
Assignment.Assignee[] getTaskAssignees(java.lang.Long taskId_)
                                throws InvalidActivityException,
                                       PrivilegeException
```
    Gets all assignees for a specified task. Assignees have been assigned and can accept the task.
    
    Parameters:
    
    taskId_ - The id of the task for which to get assignees.
    
    Returns:
    
    assignees for the task with the specified id. If the task is completed then this method will return an empty array.
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    ServiceException - if any system-level error occurs
  - getTasksAssignees
```
Assignment.Assignee[][] getTasksAssignees(java.lang.Long[] taskIds_)
                                   throws InvalidActivityException,
                                          PrivilegeException
```
    Gets all assignees for the specified tasks.
    
    Parameters:
    
    taskIds_ - The ids of the tasks for which to get assignees
    
    Returns:
    
    assignees for each specified task; the first dimension of the returned array parallels the input array. An empty array is returned for each completed task.
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    ServiceException - if any system-level error occurs
  - getAssigneePoolForTasks
```
Assignment.Assignee[] getAssigneePoolForTasks(java.lang.Long[] taskIds_)
                                       throws InvalidActivityException,
                                              InvalidOperationException,
                                              PrivilegeException
```
    Gets the set of unique assignees among all the specified tasks.
    
    Parameters:
    
    taskIds_ - the ids of the tasks for which to get assignees
    
    Returns:
    
    the union of assignees with no duplicates for the activities
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    InvalidOperationException - if any task is unattended
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    ServiceException - if any system-level error occurs
  - reassignTask
```
void reassignTask(java.lang.Long taskId_,
                  Assignment.Assignee[] assignees_)
           throws InvalidActivityException,
                  InvalidStateException,
                  PrivilegeException,
                  InvalidUserException,
                  InvalidOperationException
```
    Reassigns a task to new assignees.
    
    Parameters:
    
    taskId_ - ID of the task to reassign
    
    assignees_ - the new assignees for the task. Note that the privilege field will be ignored for all assignees that are already in the assignment pool.
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    InvalidStateException - if the task has been cancelled
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    InvalidUserException - if any of the users referenced by an Assignment.Assignee does not exist
    
    ServiceException - if any system-level error occurs
    
    InvalidOperationException
  - rejectTask
```
java.lang.Integer rejectTask(java.lang.Long taskId_)
                      throws InvalidActivityException,
                             InvalidStateException,
                             InvalidOperationException,
                             PrivilegeException
```
    Rejects a task that has already been accepted. The process engine will determine to whom to reassign the task.
    
    Parameters:
    
    taskId_ - the ID of the task to reject
    
    Returns:
    
    status code of success or rejection TASK_REJECTION_RESULT_SUCCESS TASK_REJECTION_RESULT_INVALID_STATE TASK_REJECTION_RESULT_NOT_OWNER
    
    Throws:
    
    InvalidActivityException - if the task is invalid
    
    PrivilegeException - if the current user is the owner of the task but does not have permission to reject the task (the user was explicitly denied that privilege)
    
    ServiceException - if any system-level error occurs
    
    InvalidStateException
    
    InvalidOperationException
  - getTaskDetails
```
TaskDetails getTaskDetails(java.lang.Long taskId_)
                    throws InvalidActivityException,
                           PrivilegeException
```
    Gets the details for the specified task.
    
    Parameters:
    
    taskId_ - The id of the task for which to get details.
    
    Returns:
    
    The details of the task. For completed tasks, the assignees field of the TaskDetails bean will be an empty array.
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    ServiceException - if any system-level error occurs
  - getTasksDetails
```
TaskDetails[] getTasksDetails(java.lang.Long[] taskIds_)
                       throws InvalidActivityException,
                              PrivilegeException
```
    Gets the details for the specified tasks.
    
    Parameters:
    
    taskIds_ - The ids of the tasks for which to get details.
    
    Returns:
    
    Task details for each specified task. For completed tasks, the assignees field of the TaskDetails bean will be an empty array.
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    ServiceException - if any system-level error occurs
  - getTaskOpaqueUri
```
java.lang.String getTaskOpaqueUri(java.lang.Long taskId_)
```
    Gets the opaque URI for the specified task.
    
    Parameters:
    
    taskId_ - The id of the task for which to get the opaque URI.
    
    Returns:
    
    Opaque URI for the specified task.
  - getTaskUrl
```
java.lang.String getTaskUrl(java.lang.Long taskId_)
```
    Gets the URL for the specified task.
    
    Parameters:
    
    taskId_ - The id of the task for which to get the URL.
    
    Returns:
    
    URL for the specified task.
  - getProcessDetails
```
ProcessDetails getProcessDetails(java.lang.Long processId_)
                          throws InvalidProcessException,
                                 ArchivedProcessException,
                                 PrivilegeException
```
    Gets the details for a specified process.
    
    Parameters:
    
    processId_ - The id of the process for which to get the details.
    
    Returns:
    
    Details of the specified process.
    
    Throws:
    
    InvalidProcessException - if the specified process does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    ServiceException - if any system-level error occurs
    
    ArchivedProcessException
  - notifyException
```
void notifyException(java.lang.Long activityId_,
                     java.lang.String exceptionClassName_,
                     java.lang.String message_,
                     java.lang.String stackTrace_)
              throws InvalidActivityException,
                     InvalidStateException
```
    Notifies the server that an exception has occurred while executing an activity.
    
    Parameters:
    
    activityId_ - ID of the Activity on which the exception occurred
    
    exceptionClassName_ - the fully qualified class name of the exception
    
    message_ - message of the exception
    
    stackTrace_ - stack trace of the exception
    
    Throws:
    
    InvalidActivityException - if the activity specified does not exist
    
    InvalidStateException - if the process is in any state other than in-progress
    
    ServiceException - if any system-level error occurs
  - executionFailure
```
@Deprecated
void executionFailure(int errorType_,
                                  java.lang.Long[] activities_)
                           throws InvalidActivityException,
                                  InvalidStateException,
                                  java.lang.IllegalArgumentException
```
    Deprecated. unattended activities now run from the work queue.
    
    Called for unattended Java activities to let the process engine know that the activities could not be executed.
    
    Parameters:
    
    errorType_ - this is one of the EXECUTION_FAILURE_XXX constants. For EXECUTION_FAILURE_EXCEPTION, don't attempt to execute again until configurable delay has passed. For EXECUTION_FAILURE_TIMEOUT, attempt to execute again at next usual execution time.
    
    activities_ - acitivites that failed to execute
    
    Throws:
    
    InvalidActivityException - if the activity specified does not exist
    
    InvalidStateException - if the process is in any state other than in-progress, or if the process is not unattended, or if it is not a Java activity
    
    java.lang.IllegalArgumentException - if errorType_ is invalid
    
    ServiceException - if any system-level error occurs
  - executionFailureMessage
```
@Deprecated
void executionFailureMessage(int errorType_,
                                         java.lang.Long[] activities_,
                                         java.lang.String message_)
                                  throws InvalidActivityException,
                                         InvalidStateException,
                                         java.lang.IllegalArgumentException
```
    Deprecated. unattended activities now run from the work queue.
    
    Called for unattended Java activities to let the process engine know that the activities could not be executed.
    
    Parameters:
    
    errorType_ - this is one of the EXECUTION_FAILURE_XXX constants. For EXECUTION_FAILURE_EXCEPTION, don't attempt to execute again until configurable delay has passed. For EXECUTION_FAILURE_TIMEOUT, attempt to execute again at next usual execution time.
    
    activities_ - activities that failed to execute
    
    message_ - exception message
    
    Throws:
    
    InvalidActivityException - if the activity specified does not exist
    
    InvalidStateException - if the process is in any state other than in-progress, or if the process is not unattended, or if it is not a Java activity
    
    java.lang.IllegalArgumentException - if errorType_ is invalid
    
    ServiceException - if any system-level error occurs
  - deleteProcess
```
void deleteProcess(java.lang.Long processId_,
                   boolean deleteSubProcesses_)
            throws InvalidProcessException,
                   PrivilegeException
```
    Deletes the specified process. Purges process history in Kafka.
    
    Parameters:
    
    processId_ - the id of the process to delete
    
    deleteSubProcesses_ - true if all the sub processes in this process should also be deleted; false if not.
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - If the user does not have sufficient privileges to perform this action
    
    ServiceException - if any system-level error occurs
  - deleteProcesses
```
void deleteProcesses(java.lang.Long[] processIds_,
                     boolean deleteSubProcesses_)
              throws InvalidProcessException,
                     PrivilegeException
```
    Deletes all of the specified processes. This method performs the same as deleteProcess(java.lang.Long, boolean), but in bulk. Purges process history in Kafka.
    
    Parameters:
    
    processIds_ - the ids of the processes to delete
    
    deleteSubProcesses_ - true if all the sub processes should be deleted; false if not.
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - If the user does not have sufficient privileges to perform this action
    
    ServiceException - if any system-level error occurs
  - cancelProcess
```
void cancelProcess(java.lang.Long processId_,
                   boolean cancelLinkedProcesses_)
            throws InvalidProcessException,
                   InvalidStateException,
                   PrivilegeException,
                   LockException
```
    Cancels the specified process. Only active and paused processes can be cancelled.
    
    Parameters:
    
    processId_ - the id of the process to cancel
    
    cancelLinkedProcesses_ - true if all the linked processes should be cancelled; false if not.
    
    Throws:
    
    InvalidProcessException - if the specified process does not exist
    
    InvalidStateException - if the specified process is not active or already cancelled
    
    PrivilegeException - if the current user does not have privileges to cancel the specified process
    
    LockException - if the process is locked
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    lockProcessModelForProcess(Long, boolean)
  - notifyInvalidParameters
```
void notifyInvalidParameters(java.lang.Long activityId_,
                             ActivityClassParameter[] acps_)
                      throws InvalidActivityException,
                             InvalidStateException,
                             java.lang.IllegalArgumentException,
                             InvalidActivityClassParameterException
```
    Notifies the user that the parameters sent as inputs to an unattended activity were invalid. This is only called if ActivityParameterHelper.validate(com.appiancorp.suiteapi.process.ActivityClassParameter[], java.lang.Object, boolean, com.appiancorp.services.ServiceContext, com.appiancorp.suiteapi.process.framework.MessageHolder) returned false.
    
    Parameters:
    
    activityId_ - The ID of the activity for which validation failed
    
    acps_ - The parameters with validation messages populated.
    
    Throws:
    
    InvalidActivityException - if the activity does not exist
    
    InvalidStateException - if activity is in a state other than in-progress
    
    java.lang.NullPointerException - if acps_ is null
    
    java.lang.IllegalArgumentException - if the ACP array is empty, or if no ACPs had validation messages
    
    InvalidActivityClassParameterException - if an ActivityClassParameter provided does not exist
    
    ServiceException - if any system-level error occurs
  - notifyUsersCreationByJava
```
@Deprecated
void notifyUsersCreationByJava(java.lang.Long activityId_,
                                           java.lang.String[] usernames_)
                                    throws InvalidActivityException,
                                           java.lang.NullPointerException
```
    Deprecated. This call should never be necessary.
    
    Notifies the server that new users were created on the Personalization server
    
    Parameters:
    
    activityId_ - The ID of the activity for which validation failed
    
    usernames_ - the names of the users that were added
    
    Throws:
    
    InvalidActivityException - if the activity does not exist
    
    java.lang.NullPointerException - if any of the usernames are null
  - notifyUsersCreationByJava
```
@Deprecated
void notifyUsersCreationByJava(java.lang.String[] usernames_)
                                    throws java.lang.NullPointerException
```
    Deprecated. done automatically by UserService.createUser
    
    Notifies the server that new users were created on the Personalization server
    
    Parameters:
    
    usernames_ - the names of the users that were added
    
    Throws:
    
    java.lang.NullPointerException - if any of the usernames are null
  - checkActivityValidity
```
int checkActivityValidity(java.lang.Long activityId_)
                   throws java.lang.NullPointerException
```
    Determines whether the specified activity is valid.
    
    Parameters:
    
    activityId_ - the id of the activity
    
    Returns:
    
    one of the ACTIVITY_XXX constants
    
    Throws:
    
    java.lang.NullPointerException - if the activityId_ is null
    
    ServiceException - if any system-level error occurs
  - canCompleteActivity
```
boolean canCompleteActivity(java.lang.Long activityId_)
```
    Determines whether the specified activity can be completed by the user. It will ensure that the activity is in an assigned state and that the user is the owner of the activity. If the activity is invalid, false will be returned.
    
    Parameters:
    
    activityId_ - the id of the activity
    
    Returns:
    
    true, if the user can complete the activity; false otherwise
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - canCompleteClone
```
boolean canCompleteClone(java.lang.Long activityId_)
```
    Indicates whether the current user can use completeClone(java.lang.Long, com.appiancorp.suiteapi.process.ActivityClassParameter[], com.appiancorp.suiteapi.process.ActivityReturnVariable[]) on the given task to complete the activity. Ensures that the specified task is the correct type of task (quick task) and is in a proper state to be completed by the current user.
    
    Parameters:
    
    activityId_ - the id of the activity (aka task)
  - getSubProcessesForProcess
```
@Deprecated
ResultList getSubProcessesForProcess(java.lang.Long processId_,
                                                 int subProcessStatus_)
                                          throws InvalidProcessException,
                                                 PrivilegeException
```
    Deprecated. Use getSynchronousSubProcessesForProcess(Long, int) instead.
    
    Gets the direct subprocesses of the given process. This function will not return subprocesses of its subprocesses, if any
    
    Parameters:
    
    processId_ - The id of the process for which to get subprocesses.
    
    subProcessStatus_ - The status of the subprocesses to get, designated by one of the STATE_XXX constants in ProcessSummary. Use Constants.COUNT_ALL to retrieve subprocesses in any state.
    
    Returns:
    
    A ResultList containing ProcessSummary objects for the subprocesses of the given process. The result codes can be ResultList.CODE_NO_PERMISSION or ResultList.CODE_VALID
    
    Throws:
    
    InvalidProcessException - If the process is invalid.
    
    PrivilegeException - If the user does not have sufficient privileges to retrieve the subprocesses of this process.
    
    ServiceException - if any system-level error occurs
  - getSynchronousSubProcessesForProcess
```
ResultList getSynchronousSubProcessesForProcess(java.lang.Long processId_,
                                                int synchronousSubProcessStatus_)
                                         throws InvalidProcessException,
                                                PrivilegeException
```
    Gets the synchronous subprocesses of the given process. Only retrieves direct children, so subprocesses of subprocesses will not be returned.
    
    Parameters:
    
    processId_ - the id of the process to get synchronous subprocesses for
    
    synchronousSubProcessStatus_ - filters results by returning only those subprocesses with the status given here. Possible statuses are defined in ProcessSummary and look like STATE_XXX. Use Constants.COUNT_ALL to return ALL synchronous subprocesses, without filtering by status.
    
    Returns:
    
    a ResultList containing ProcessSummary objects that represent the synchronous subprocesses. The ResultList's result codes can be: ResultList.CODE_VALID if the nth subprocess is accessible, or ResultList.CODE_NO_PERMISSION if the user does not have permission to access the nth subprocess.
    
    Throws:
    
    InvalidProcessException - if the process is invalid
    
    PrivilegeException - if the user does not have sufficient privileges to perform this operation
    
    ServiceException - if any system-level error occurs
  - getTopLevelProcessForProcess
```
ProcessSummary getTopLevelProcessForProcess(java.lang.Long processId_)
                                     throws PrivilegeException,
                                            InvalidProcessException
```
    Gets the top level process for a given process.
    
    Parameters:
    
    processId_ - the id of the process to get the top level process for
    
    Returns:
    
    the ProcessSummary of the top level process for the given process if one exists. Returns only true top level processes. In the case that the process itself is a top level process the call will return itself.
    
    Throws:
    
    PrivilegeException - if the user cannot view the top level process or the current process
    
    InvalidProcessException - if the process specified does not exist
    
    ServiceException - if any system-level error occurs
  - isSubProcess
```
@Deprecated
boolean isSubProcess(java.lang.Long processId_)
                          throws InvalidProcessException
```
    Deprecated. Use #isSynchronousSubProcesses(Long) instead.
    
    Determines whether or not the given process is a subprocess.
    
    Parameters:
    
    processId_ - the ID of the process to check
    
    Returns:
    
    true if the process given is a subprocess, otherwise false
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    ServiceException - if any system-level error occurs
  - isSynchronousSubProcess
```
boolean isSynchronousSubProcess(java.lang.Long processId_)
                         throws InvalidProcessException
```
    Determines whether or not the given process is a synchronous subprocess.
    
    Parameters:
    
    processId_ - the ID of the process to check
    
    Returns:
    
    true if the process given is a synchronous subprocess, otherwise false
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    ServiceException - if any system-level error occurs
  - containsSubProcesses
```
@Deprecated
boolean containsSubProcesses(java.lang.Long processId_)
                                  throws InvalidProcessException
```
    Deprecated. Use containsSynchronousSubProcesses(Long) instead.
    
    Determines whether or not the given process contains subprocesses.
    
    Parameters:
    
    processId_ - the id of the process to check for subprocesses
    
    Returns:
    
    true if the process given contains subprocesses, otherwise false
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    ServiceException - if any system-level error occurs
  - containsLinkProcesses
```
@Deprecated
boolean containsLinkProcesses(java.lang.Long processId_)
                                   throws InvalidProcessException
```
    Deprecated. Use containsAsynchronousSubProcesses(Long) instead.
    
    Determines whether or not the given process contains linked processes.
    
    Parameters:
    
    processId_ - the id of the process to check for linked processes
    
    Returns:
    
    true if the process given contains linked processes, otherwise false
    
    Throws:
    
    ServiceException - if any system-level error occurs
    
    InvalidProcessException
  - containsSynchronousSubProcesses
```
boolean containsSynchronousSubProcesses(java.lang.Long processId_)
                                 throws InvalidProcessException
```
    Determines whether or not the given process contains synchronous subprocesses.
    
    Parameters:
    
    processId_ - the id of the process to check
    
    Returns:
    
    true if the process given contains synchronous subprocesses, otherwise false
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    ServiceException - if any system-level error occurs
  - containsSynchronousSubProcesses
```
java.lang.Boolean[] containsSynchronousSubProcesses(java.lang.Long[] processId_)
                                             throws InvalidProcessException
```
    Throws:
    
    InvalidProcessException
  - containsAsynchronousSubProcesses
```
boolean containsAsynchronousSubProcesses(java.lang.Long processId_)
                                  throws InvalidProcessException
```
    Determines whether or not the given process contains asynchronous subprocesses.
    
    Parameters:
    
    processId_ - the id of the process to check
    
    Returns:
    
    true if the process given contains asynchronous subprocesses, otherwise false
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    ServiceException - if any system-level error occurs
  - containsAsynchronousSubProcesses
```
java.lang.Boolean[] containsAsynchronousSubProcesses(java.lang.Long[] processId_)
                                              throws InvalidProcessException
```
    Throws:
    
    InvalidProcessException
  - getLinkProcessesForProcess
```
@Deprecated
ResultList getLinkProcessesForProcess(java.lang.Long processId_,
                                                  int linkProcessStatus_)
                                           throws InvalidProcessException,
                                                  PrivilegeException
```
    Deprecated. Use getAsynchronousSubProcessesForProcess(Long, int) instead.
    
    Gets the linked processes of the given process
    
    Parameters:
    
    processId_ - the id of the process to get linked processes for
    
    linkProcessStatus_ - the status of the linked processes to get; designated by one of the STATE_XXX constants in ProcessSummary, or Constants.COUNT_ALL to return linked processes of any status
    
    Returns:
    
    a ResultList containing ProcessSummary objects for the linked processes of the given process. The result codes can be: ResultList.CODE_VALID if the action succeeded, or ResultList.CODE_NO_PERMISSION if the user does not have permission
    
    Throws:
    
    InvalidProcessException - if the process is invalid
    
    PrivilegeException - if the user does not have sufficient privileges to perform this operation
    
    ServiceException - if any system-level error occurs
  - getAsynchronousSubProcessesForProcess
```
ResultList getAsynchronousSubProcessesForProcess(java.lang.Long processId_,
                                                 int asynchronousSubProcessStatus_)
                                          throws InvalidProcessException,
                                                 PrivilegeException
```
    Gets the asynchronous subprocesses of the given process. Only retrieves direct children, so subprocesses of subprocesses will not be returned.
    
    Parameters:
    
    processId_ - the id of the process to get asynchronous subprocesses for
    
    asynchronousSubProcessStatus_ - filters results by returning only those subprocesses with the status given here. Possible statuses are defined in ProcessSummary and look like STATE_XXX. Use Constants.COUNT_ALL to return ALL asynchronous subprocesses, without filtering by status.
    
    Returns:
    
    a ResultList containing ProcessSummary objects that represent the asynchronous subprocesses. The ResultList's result codes can be: ResultList.CODE_VALID if the nth subprocess is accessible, or ResultList.CODE_NO_PERMISSION if the user does not have permission to access the nth subprocess.
    
    Throws:
    
    InvalidProcessException - if the process is invalid
    
    PrivilegeException - if the user does not have sufficient privileges to perform this operation
    
    ServiceException - if any system-level error occurs
  - isLinkProcess
```
@Deprecated
boolean isLinkProcess(java.lang.Long processId_)
                           throws InvalidProcessException
```
    Deprecated. Use isAsynchronousSubProcess(Long) instead.
    
    Determines whether or not the given process is a linked process.
    
    Parameters:
    
    processId_ - the ID of the process to check
    
    Returns:
    
    true if the given process is a linked process, otherwise false
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    ServiceException - if any system-level error occurs
  - isAsynchronousSubProcess
```
boolean isAsynchronousSubProcess(java.lang.Long processId_)
                          throws InvalidProcessException
```
    Determines whether or not the given process is an asynchronous subprocess.
    
    Parameters:
    
    processId_ - the ID of the process to check
    
    Returns:
    
    true if the given process is an asynchronous subprocess, otherwise false
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    ServiceException - if any system-level error occurs
  - getActivityProperties
```
ActivityProperties getActivityProperties(java.lang.Long activityId_)
                                  throws PrivilegeException,
                                         InvalidActivityException
```
    Retrieves the activity properties for the given activity.
    
    Parameters:
    
    activityId_ - the id of the activity (task)
    
    Returns:
    
    the properties of the task, process, and model. Because this method is on the execution server, the properties of the model that are returned are the ones that were set when the model was originally copied from the design server.
    
    Throws:
    
    PrivilegeException - if the user does not have access
    
    InvalidActivityException - if no activity exists with the given id
    
    ServiceException - if any system-level error occurs
  - getTaskProperties
```
TaskProperties getTaskProperties(java.lang.Long taskId_)
                          throws PrivilegeException,
                                 InvalidActivityException
```
    Retrieves the properties for the given task.
    
    Parameters:
    
    taskId_ - The id of the task.
    
    Returns:
    
    The properties of the task.
    
    Throws:
    
    PrivilegeException - If the user does not have access to the task.
    
    InvalidActivityException - If no task exists with the given id.
    
    ServiceException - if any system-level error occurs
  - setTaskProperties
```
void setTaskProperties(TaskProperties properties_)
                throws PrivilegeException,
                       InvalidActivityException,
                       InvalidPriorityException
```
    Sets the properties of the specified task . The task properties to update is determined by the id of the given properties object. The following fields must be populated in the TaskProperties object: displayName, priority, and id The id field must be populated in the priority member of the TaskProperties object Only displayName and priority.id may be updated
    
    Parameters:
    
    properties_ - the properties of the task
    
    Throws:
    
    PrivilegeException - if the user does not have access
    
    InvalidActivityException - if no activity exists with the given id
    
    InvalidPriorityException - if the call tries to set the priority of the task to an invalid value
    
    ServiceException - if any system-level error occurs
  - setTaskDisplayName
```
void setTaskDisplayName(java.lang.Long taskId,
                        LocaleString displayName)
                 throws PrivilegeException,
                        java.lang.IllegalArgumentException,
                        InvalidActivityException
```
    Sets the display name for the specified task to the specified string.
    
    Parameters:
    
    taskId - the id of the task whose display name should be updated
    
    displayName - the string for the new display name
    
    Throws:
    
    InvalidActivityException - if there is no task for the specified taskId
    
    java.lang.IllegalArgumentException - if the display name is null, empty, or invalid
    
    PrivilegeException - if the user lacks permissions to perform the action
  - getProcessProperties
```
ProcessProperties getProcessProperties(java.lang.Long processId_)
                                throws PrivilegeException,
                                       InvalidProcessException
```
    Retrieves the properties for the given process.
    
    Parameters:
    
    processId_ - The id of the process.
    
    Returns:
    
    The properties of the process.
    
    Throws:
    
    PrivilegeException - If the user does not have access to retrieve the properties of the process.
    
    InvalidProcessException - If no process exists with the given id.
    
    ServiceException - if any system-level error occurs
  - setProcessProperties
```
void setProcessProperties(ProcessProperties properties_)
                   throws PrivilegeException,
                          InvalidProcessException,
                          InvalidPriorityException,
                          InvalidUserException
```
    Sets the properties of the specified process. The process to update is determined by the id of the given properties object. Only name and priority.id can be updated for the process.
    
    Parameters:
    
    properties_ - The updated properties of the process. Only name and priority.id can be updated for the process. The following fields must be populated in the passed object: id, name, and priority. The id field in the priority member of the passed ProcessProperties object must also be populated.
    
    Throws:
    
    PrivilegeException - if the user does not have privileges to perform the given operation
    
    InvalidProcessException - if no process exists with the given id
    
    InvalidPriorityException - if the call tries to set the priority of the process to an invalid value
    
    InvalidUserException - if any of the users referenced by the ProcessProperties does not exist
    
    ServiceException - if any system-level error occurs
  - getProcessParameters
```
ProcessVariableInstance[] getProcessParameters(java.lang.Long processId_)
                                        throws InvalidProcessException,
                                               PrivilegeException
```
    Retrieves process parameters for the specified process.
    
    Parameters:
    
    processId_ - The id of the process.
    
    Returns:
    
    The parameters for the given process, with their initial values.
    
    Throws:
    
    InvalidProcessException - If no such process exists.
    
    PrivilegeException - If the user does not have access to retrieve the process parameters.
    
    ServiceException - if any system-level error occurs
  - getProcessParameter
```
ProcessVariableInstance getProcessParameter(java.lang.Long processId_,
                                            java.lang.String parameterName_)
                                     throws InvalidProcessException,
                                            InvalidProcessVariableNameException,
                                            PrivilegeException
```
    Retrieves the specified process parameter of the specified process.
    
    Parameters:
    
    processId_ - The id of the process
    
    parameterName_ - The name of the parameter to retrieve.
    
    Returns:
    
    The given parameter for the given process, with the initial value.
    
    Throws:
    
    InvalidProcessException - If no such process exists.
    
    InvalidProcessVariableNameException - If the process exists, but there is no process parameter with the given name for the process.
    
    PrivilegeException - If the user does not have access to retrieve the process parameter.
    
    ServiceException - if any system-level error occurs
  - getProcessVariables
```
@Deprecated
ProcessVariableInstance[] getProcessVariables(java.lang.Long processId_)
                                                   throws InvalidProcessException,
                                                          PrivilegeException
```
    Deprecated. Use getRecursiveProcessVariables(Long, boolean) instead.
    
    Retrieves the process variables for the specified process.
    
    Parameters:
    
    processId_ - The id of the process.
    
    Returns:
    
    The variables for the process.
    
    Throws:
    
    InvalidProcessException - If no such process exists.
    
    PrivilegeException - If the user does not have access to retrieve the process variables for the specified process.
    
    ServiceException - if any system-level error occurs
  - getRecursiveProcessVariables
```
ProcessVariableInstance[] getRecursiveProcessVariables(java.lang.Long processId_,
                                                       boolean recursive_)
                                                throws InvalidProcessException,
                                                       PrivilegeException
```
    Retrieves the process variables for the specified process. If the recursive flag is set to true, process variables for all sub-processes (that have the transparency flag set to true) will also be returned.
    
    Parameters:
    
    processId_ - The id of the process.
    
    recursive_ - true if you want to retrieve process variables from the child processes (and their children in turn).
    
    Returns:
    
    The variables for the process.
    
    Throws:
    
    InvalidProcessException - If no such process exists.
    
    PrivilegeException - If the user does not have access to retrieve the process variables for the specified process.
    
    ServiceException - if any system-level error occurs
  - getProcessVariablesPaging
```
ResultPage getProcessVariablesPaging(java.lang.Long processId_,
                                     int startIndex_,
                                     int batchSize_,
                                     java.lang.Integer sortProperty_,
                                     java.lang.Integer sortOrder_)
                              throws InvalidProcessException,
                                     PrivilegeException
```
    Retrieves the process variables for the specified process.
    
    Parameters:
    
    processId_ - The id of the process.
    
    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 ProcessVariable
    
    sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
    
    Returns:
    
    a ResultPage containing the variables for the process.
    
    Throws:
    
    InvalidProcessException - If no such process exists.
    
    PrivilegeException - If the user does not have access to retrieve the process variables for the specified process.
    
    ServiceException - if any system-level error occurs
  - getProcessVariable
```
ProcessVariableInstance getProcessVariable(java.lang.Long processId_,
                                           java.lang.String pvName_)
                                    throws InvalidProcessException,
                                           InvalidProcessVariableNameException,
                                           PrivilegeException
```
    Retrieves the specified process variable for the specified process.
    
    Parameters:
    
    processId_ - The id of the process.
    
    pvName_ - The name of a process variable.
    
    Returns:
    
    The variable with the given name for the specified process.
    
    Throws:
    
    InvalidProcessException - If no such process exists.
    
    InvalidProcessVariableNameException - If the process exists, but contains no variable with the given name.
    
    PrivilegeException - If the user does not have access to retrieve the process variable.
    
    ServiceException - if any system-level error occurs
  - setProcessVariables
```
void setProcessVariables(java.lang.Long pProcessId_,
                         ProcessVariableInstance[] pvs_)
                  throws InvalidProcessException,
                         InvalidProcessVariableNameException,
                         PrivilegeException,
                         InvalidUserException
```
    Sets the values of the specified process variables for the specified process. Only variables that already exist for the process can be set. New variables must first be added through #addProcessVariable(Long, ProcessVariable) or #addProcessVariables(Long, ProcessVariable[]). The process variables should be first retrieved via getProcessVariables(java.lang.Long), and their values set appropriately, before calling this method.
    
    Parameters:
    
    pProcessId_ - the id of the process
    
    pvs_ - the variables to set
    
    Throws:
    
    InvalidProcessException - if no such process exists
    
    InvalidProcessVariableNameException - if one of the names in pvs_ refers to a variable that does not exist in the given process
    
    PrivilegeException - if the user does not have sufficent privielges to perform this operation
    
    InvalidUserException - if any of the users referenced by a ProcessVariable does not exist
    
    ServiceException - if any system-level error occurs
  - setProcessVariable
```
void setProcessVariable(java.lang.Long pProcessId_,
                        ProcessVariableInstance pv_)
                 throws InvalidProcessException,
                        InvalidProcessVariableNameException,
                        PrivilegeException,
                        InvalidUserException
```
    Sets the value of the specified process variable for the specified process. Only a variable that already exists for the process can be set. New variables must first be added through ProcessExecutionService#addProcessVariable(Long, ProcessVariable) or ProcessExecutionService#addProcessVariables(Long, ProcessVariable[]). The process variable should be first retrieved via getProcessVariable(java.lang.Long, java.lang.String), and its values set appropriately, before calling this method.
    
    Parameters:
    
    pProcessId_ - the id of the process
    
    pv_ - the variable to set
    
    Throws:
    
    InvalidProcessException - if no such process exists
    
    InvalidProcessVariableNameException - if the name of pv_ refers to a variable that does not exist in the given process
    
    PrivilegeException - if the user does not have sufficent privielges to perform this operation
    
    InvalidUserException - if any of the users referenced by the ProcessVariable does not exist
    
    ServiceException - if any system-level error occurs
  - addProcessVariable
```
void addProcessVariable(java.lang.Long processId_,
                        ProcessVariableInstance pv_)
                 throws InvalidProcessException,
                        InvalidProcessVariableNameException,
                        DuplicateNameException,
                        PrivilegeException,
                        InvalidUserException
```
    Adds a new variable to the specified process.
    The following fields must be populated in the ProcessVariable object: key, type, multiple, and value
    
    Parameters:
    
    processId_ - the id of the process
    
    pv_ - a new variable to add
    
    Throws:
    
    InvalidProcessException - if no such process exists
    
    InvalidProcessVariableNameException - if the name of the process variable is null
    
    DuplicateNameException - if a variable with the same name already exists for the process
    
    PrivilegeException - if the user does not have sufficent privielges to perform this operation
    
    InvalidUserException - if any of the users referenced by the ProcessVariable does not exist
    
    ServiceException - if any system-level error occurs
  - addProcessVariables
```
void addProcessVariables(java.lang.Long processId_,
                         ProcessVariableInstance[] pvs_)
                  throws InvalidProcessException,
                         InvalidProcessVariableNameException,
                         DuplicateNameException,
                         PrivilegeException,
                         InvalidUserException
```
    Adds new variables to the specified process.
    The following fields must be populated in each ProcessVariable object: key, type, multiple, and value
    
    Parameters:
    
    processId_ - the id of the process
    
    pvs_ - the new variables to add
    
    Throws:
    
    InvalidProcessException - if no such process exists
    
    InvalidProcessVariableNameException - if the name of one of the process variables is null
    
    DuplicateNameException - if a variable with the same name as one of the process variables that already exists for the process
    
    PrivilegeException - if the user does not have sufficent privileges to perform this operation
    
    InvalidUserException - if any of the users referenced by a ProcessVariable does not exist
    
    ServiceException - if any system-level error occurs
  - getSecurityForProcess
```
Security getSecurityForProcess(java.lang.Long id_)
                        throws InvalidProcessException,
                               PrivilegeException
```
    Gets the security configuration of a process.
    
    Parameters:
    
    id_ - The id of the process.
    
    Returns:
    
    a Security object containing a ProcessRoleMap which encapsulates the security configuration of the process
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    PrivilegeException - if the current user does not have changeRole privileges for the process
    
    ServiceException - if any system-level error occurs
  - setSecurityForProcess
```
void setSecurityForProcess(java.lang.Long id_,
                           Security s_)
                    throws InvalidProcessException,
                           PrivilegeException,
                           InvalidUserException
```
    Sets the security configuration of a process. This method does NOT set canInherit and inheritable.
    
    Parameters:
    
    id_ - the id of the process
    
    s_ - a Security object containing a ProcessRoleMap which encapsulates the security configuration of the process
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    PrivilegeException - if the current user does not have changeRole privileges for the process
    
    InvalidUserException - if any of the users referenced by the Security does not exist
    
    ServiceException - if any system-level error occurs
  - getSecurityForNode
```
Security getSecurityForNode(java.lang.Long id_)
                     throws InvalidActivityException,
                            PrivilegeException
```
    Gets the default security configuration of tasks for a specified node.
    
    Parameters:
    
    id_ - The id of the primary activity of the node.
    
    Returns:
    
    a Security object containing a ProcessRoleMap which encapsulates the security configuration of the process
    
    Throws:
    
    InvalidActivityException - if the task specified does not exist
    
    PrivilegeException - if the current user does not have changeRole privileges for the task
    
    ServiceException - if any system-level error occurs
  - setSecurityForNode
```
void setSecurityForNode(java.lang.Long id_,
                        Security s_)
                 throws InvalidActivityException,
                        PrivilegeException,
                        InvalidUserException
```
    Sets the default security configuration of tasks for a specified node. This method does NOT set canInherit and inheritable.
    
    Parameters:
    
    id_ - the unique Id of the primary activity of the ProcessNode instance
    
    s_ - a Security object containing a ProcessRoleMap which encapsulates the security configuration of the process
    
    Throws:
    
    InvalidActivityException - if the task specified does not exist
    
    PrivilegeException - if the current user does not have changeRole privileges for the task
    
    InvalidUserException - if any of the users referenced by the Security does not exist
    
    ServiceException - if any system-level error occurs
  - setActorsInRolesForProcess
```
void setActorsInRolesForProcess(java.lang.Long id_,
                                java.lang.String[] users_,
                                java.lang.String[][] userRoles_,
                                java.lang.Long[] groups_,
                                java.lang.String[][] groupRoles_)
                         throws InvalidProcessException,
                                PrivilegeException,
                                InvalidUserException
```
    Adds and/or modifies the roles of users and groups for a specified process. This method will only update existing permissions for the users and groups specified in the parameters. All other users and groups will not be changed. To overwrite roles for all users and groups use setSecurityForProcess(Long, Security)
    
    Parameters:
    
    id_ - the id of the process
    
    users_ - the list of usernames for 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 whose first dimension parallels users_. The 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 for the process). It is legal to have null within this array.
    
    groups_ - the list of group ids for 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 whose first dimension parallels groups_ The 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 for the process). It is legal to have null within this array.
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    PrivilegeException - if the current user does not have changeRole privileges for the process
    
    InvalidUserException - if any of the users referenced does not exist
    
    ServiceException - if any system-level error occurs
  - setActorsInRolesForNode
```
void setActorsInRolesForNode(java.lang.Long id_,
                             java.lang.String[] users_,
                             java.lang.String[][] userRoles_,
                             java.lang.Long[] groups_,
                             java.lang.String[][] groupRoles_)
                      throws InvalidActivityException,
                             PrivilegeException,
                             InvalidUserException
```
    Adds and/or modifies the default roles of users and groups for a node instance (activity). 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 {@link #setSecurityForNode(Long, Security);
    
    Parameters:
    
    id_ - the id of the primary activity of the node
    
    users_ - the list of usernames for 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 whose first dimension parallels users_. The 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 for the tasks)
    
    groups_ - the list of group ids for 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 whose first dimension parallels groups_ The 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 for the tasks)
    
    Throws:
    
    InvalidActivityException - if the task specified does not exist
    
    PrivilegeException - if the current user does not have changeRole privileges for the task
    
    InvalidUserException - if any of the users referenced does not exist
    
    ServiceException - if any system-level error occurs
  - setInheritanceForProcess
```
void setInheritanceForProcess(java.lang.Long id_,
                              boolean doesInherit_)
                       throws InvalidProcessException,
                              PrivilegeException
```
    Sets whether a specified process inherits security from the process model of which it is an instance.
    
    Parameters:
    
    id_ - the id of the process
    
    doesInherit_ - true if the process inherits, false otherwise.
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    PrivilegeException - if the current user does not have changeRole privileges for the process
    
    ServiceException - if any system-level error occurs
  - setInheritanceForNode
```
void setInheritanceForNode(java.lang.Long id_,
                           boolean doesInherit_)
                    throws InvalidActivityException,
                           PrivilegeException
```
    Sets whether a specified task inherits security from its process.
    
    Parameters:
    
    id_ - the id of the task
    
    doesInherit_ - true if the task inherits, false otherwise.
    
    Throws:
    
    InvalidActivityException - if the task specified does not exist
    
    PrivilegeException - if the current user does not have changeRole privileges for the task
    
    ServiceException - if any system-level error occurs
  - getPermissionsForProcess
```
ProcessPermissions getPermissionsForProcess(java.lang.Long id_)
                                     throws InvalidProcessException
```
    Gets the permissions that the user has on a specified process.
    
    Parameters:
    
    id_ - The id of the process.
    
    Returns:
    
    The user's privileges.
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    ServiceException - if any system-level error occurs
  - getPermissionsForProcesses
```
ProcessPermissions[] getPermissionsForProcesses(java.lang.Long[] ids_)
                                         throws InvalidProcessException
```
    Gets the permissions that the user has on specified processes.
    
    Parameters:
    
    ids_ - The ids for the processes.
    
    Returns:
    
    The user's privileges.st
    
    Throws:
    
    InvalidProcessException - if a specified process does not exist
    
    ServiceException - if any system-level error occurs
  - getPermissionsForNode
```
NodePermissions getPermissionsForNode(java.lang.Long activityId_)
                               throws InvalidActivityException
```
    Gets the permissions that the user has by default on tasks of the specified node.
    
    Parameters:
    
    activityId_ - The primary activity id of the node
    
    Returns:
    
    The user's default privileges.
    
    Throws:
    
    InvalidActivityException - if the task specified does not exist
    
    ServiceException - if any system-level error occurs
  - getPermissionsForNodes
```
NodePermissions[] getPermissionsForNodes(java.lang.Long[] activityIds_)
                                  throws InvalidActivityException
```
    Gets the permissions that the user has by default on tasks of the specified nodes.
    
    Parameters:
    
    activityIds_ - The ids of the primary activities of the nodes.
    
    Returns:
    
    The user's default privileges.
    
    Throws:
    
    InvalidActivityException - if a specified task does not exist
    
    ServiceException - if any system-level error occurs
  - getPermissionsForProcessDiagram
```
ProcessModelPermissions getPermissionsForProcessDiagram(java.lang.Long processId_)
                                                 throws InvalidProcessException
```
    Gets a ProcessModelPermissions object that says which In-Flight Modifications the user can or cannot perform to a given process.
    
    Parameters:
    
    processId_ - The id of the process.
    
    Returns:
    
    The user's privileges.
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    ServiceException - if any system-level error occurs
  - getAttachmentsForProcess
```
ResultPage getAttachmentsForProcess(java.lang.Long id_,
                                    boolean recursive_,
                                    int startIndex_,
                                    int batchSize_,
                                    java.lang.Integer sortProperty_,
                                    java.lang.Integer sortOrder_)
                             throws InvalidProcessException,
                                    PrivilegeException
```
    Returns the attachments for a specified process
    
    Parameters:
    
    id_ - the id of the process
    
    recursive_ - return recursive results if set to true
    
    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. Should be one of the SORT_BY_XXX constants on Attachment.
    
    sortOrder_ - The order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing instances of Attachment. 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 does not exist
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    ServiceException - if any system-level errors occur
  - getAttachmentsForProcess
```
@Deprecated
Attachment[] getAttachmentsForProcess(java.lang.Long processId_)
                                           throws InvalidProcessException,
                                                  PrivilegeException
```
    Deprecated.
    
    Gets all the attachments for a given process
    
    Parameters:
    
    processId_ - the id of the process
    
    Returns:
    
    the attachments
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    ServiceException - if any system-level error occurs
  - getAttachmentsAndNotesForTask
```
ResultPage getAttachmentsAndNotesForTask(java.lang.Long taskId_,
                                         boolean recursive_,
                                         int startIndex_,
                                         int batchSize_,
                                         java.lang.Integer sortProperty_,
                                         java.lang.Integer sortOrder_)
                                  throws InvalidActivityException,
                                         PrivilegeException,
                                         InvalidOperationException
```
    Returns the attachments and notes for a specified task
    
    Parameters:
    
    taskId_ - the id of the task
    
    recursive_ - when true, fetches the attachments and notes of the parent process as well. And those of the parent of that parent, etc., all the way up the parent process totem.
    
    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. Should be one of the SORT_BY_XXX constants on Attachment.
    
    sortOrder_ - The order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing instances of Attachment. The result codes can be: ResultList.CODE_VALID if the nth attachment/note is accessible, ResultList.CODE_NO_PERMISSION if the user does not have permission to access the nth attachment/note, or ResultList.CODE_INVALID if the specified attachment/note does not exist
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    ServiceException - if any system-level errors occur
    
    InvalidActivityException
    
    InvalidOperationException
  - getAttachmentsForTask
```
Attachment[] getAttachmentsForTask(java.lang.Long taskId_)
                            throws InvalidActivityException,
                                   PrivilegeException,
                                   InvalidOperationException,
                                   InvalidProcessException
```
    Gets all the attachments for a given task and its related process
    
    Parameters:
    
    taskId_ - the id of the task
    
    Returns:
    
    the attachments
    
    Throws:
    
    InvalidActivityException - if the task specified does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    InvalidProcessException
    
    ServiceException - if any system-level error occurs
    
    InvalidOperationException
  - removeProcessAttachments
```
java.lang.Long[] removeProcessAttachments(java.lang.Long[] attachmentIds_,
                                          java.lang.Long processId_)
                                   throws InvalidProcessException,
                                          InvalidStateException
```
    Removes specified attachments from the specified process.
    
    Parameters:
    
    attachmentIds_ - the IDs of the attachments to remove
    
    processId_ - the ID of the process
    
    Returns:
    
    an Array containing return codes for each attachment: ATTACHMENT_RETURN_SUCCESS if the attachment was added successfully, ATTACHMENT_RETURN_PERMISSIONS if the user does not have permission to remove the attachment, or ATTACHMENT_RETURN_INVALID if the attachment does not exist
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    InvalidStateException - if the process is cancelled
    
    ServiceException - if any system-level error occurs
  - removeProcessAttachment
```
java.lang.Long removeProcessAttachment(java.lang.Long attachmentId_,
                                       java.lang.Long processId_)
                                throws InvalidProcessException,
                                       InvalidStateException
```
    Removes the specified attachment from a process.
    
    Parameters:
    
    attachmentId_ - the ID of the attachment to remove
    
    processId_ - the ID of the process
    
    Returns:
    
    ATTACHMENT_RETURN_SUCCESS if the attachment was added successfully, ATTACHMENT_RETURN_PERMISSIONS if the user does not have permissions to remove the attachment, or ATTACHMENT_RETURN_INVALID if the attachment does not exist
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    InvalidStateException - if the process is cancelled
    
    ServiceException - if any system-level error occurs
  - removeTaskAttachments
```
java.lang.Long[] removeTaskAttachments(java.lang.Long[] attachmentIds_,
                                       java.lang.Long taskId_)
                                throws InvalidActivityException,
                                       InvalidStateException,
                                       InvalidOperationException
```
    Removes the specified attachments from a task
    
    Parameters:
    
    attachmentIds_ - the ids of the attachments to remove
    
    taskId_ - the id of the specified task
    
    Returns:
    
    an Array containing return codes for each attachment: ATTACHMENT_RETURN_SUCCESS if the attachment was added successfully, ATTACHMENT_RETURN_PERMISSIONS if the user does not have permissions to remove the attachment, or ATTACHMENT_RETURN_INVALID if the attachment does not exist
    
    Throws:
    
    InvalidActivityException - if the task specified does not exist
    
    InvalidStateException - if the task is cancelled
    
    ServiceException - if any system-level error occurs
    
    InvalidOperationException
  - removeTaskAttachment
```
java.lang.Long removeTaskAttachment(java.lang.Long attachmentId_,
                                    java.lang.Long taskId_)
                             throws InvalidActivityException,
                                    InvalidStateException
```
    Removes a specified attachment from a task
    
    Parameters:
    
    attachmentId_ - the id of the Attachment to remove
    
    taskId_ - the id of task
    
    Returns:
    
    ATTACHMENT_RETURN_SUCCESS if the attachment was added successfully, ATTACHMENT_RETURN_PERMISSIONS if the user does not have permissions to remove the attachment, or ATTACHMENT_RETURN_INVALID if the attachment does not exist
    
    Throws:
    
    InvalidActivityException - if the task specified does not exist
    
    InvalidStateException - if the task is cancelled
    
    ServiceException - if any system-level error occurs
  - addAttachmentToProcess
```
java.lang.Long addAttachmentToProcess(java.lang.Long processId_,
                                      Attachment attachment_)
                               throws PrivilegeException,
                                      InvalidProcessException,
                                      InvalidStateException,
                                      ProcessAttachmentsLimitException
```
    Add an attachment to a process.
    The following fields must be populated in the Attachment object: attachedObject (with type and either id or stringId), and attachedUrl
    
    Parameters:
    
    processId_ - Id of process
    
    attachment_ - the Attachment to add to the process
    
    Returns:
    
    the ID of the attachment that was added
    
    Throws:
    
    PrivilegeException - if the user does not have sufficent privileges to add attachments to this process - that is, if ProcessPermissions.isAddAttachment() returns false
    
    InvalidProcessException - if the process specified does not exist
    
    InvalidStateException - if the process is cancelled
    
    ProcessAttachmentsLimitException - if no more attachments can be added to the process
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    getPermissionsForProcess(Long)
  - addAttachmentToProcesses
```
java.lang.Long[] addAttachmentToProcesses(java.lang.Long[] processIds_,
                                          Attachment attachment_)
```
    Adds a single attachment to a list of processes.
    The following fields must be populated in the Attachment object: attachedObject (with type and either id or stringId), attachedUrl, and comment (can be an empty string)
    Parameters:
    
    processIds_ - IDs of processes
    
    attachment_ - the attachment to add
    
    Returns:
    an Array of result codes for all specified processes:
    
    ATTACHMENT_RETURN_PROCESS_CANCELLED = Cancelled process
    
    ATTACHMENT_RETURN_TOO_MANY = Too many attachments
    
    ATTACHMENT_RETURN_INVALID = Process does not exist
    
    ATTACHMENT_RETURN_PERMISSIONS = Insufficient permissions
    
    ATTACHMENT_RETURN_SUCCESS = Successful
    Throws:
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    getPermissionsForProcesses(Long[])
  - addAttachmentsToProcess
```
java.lang.Long[] addAttachmentsToProcess(java.lang.Long processId_,
                                         Attachment[] attachments_)
                                  throws PrivilegeException,
                                         InvalidProcessException,
                                         InvalidStateException,
                                         ProcessAttachmentsLimitException
```
    Add attachments to a given process.
    The following fields must be populated in each Attachment object: attachedObject (with type and either id or stringId), attachedUrl, and comment (can be an empty string)
    
    Parameters:
    
    processId_ - ID of the Process
    
    attachments_ - attachments to add to process.
    
    Returns:
    
    the IDs of the attachments added to the process
    
    Throws:
    
    PrivilegeException - if the user does not have sufficent privileges to add attachments to this process - that is, if ProcessPermissions.isAddAttachment() returns false
    
    InvalidProcessException - if the process specified does not exist, or the processId_ parameter is null.
    
    InvalidStateException - if the process is cancelled
    
    ProcessAttachmentsLimitException - if no more attachments can be added to the process
    
    java.lang.NullPointerException - if the attachments_ parameter is null or contains null values.
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    getPermissionsForProcess(Long)
  - addAttachmentToTask
```
java.lang.Long addAttachmentToTask(java.lang.Long taskId_,
                                   Attachment attachment_)
                            throws PrivilegeException,
                                   InvalidActivityException,
                                   InvalidStateException,
                                   ProcessAttachmentsLimitException,
                                   InvalidOperationException
```
    Add an attachment to a task
    
    Parameters:
    
    taskId_ - Id of task
    
    attachment_ - the attachment to add to the task
    
    Returns:
    
    the ID of the attachment added to the task
    
    Throws:
    
    PrivilegeException - if the user does not have sufficent privileges to add attachments to this task - that is, if NodePermissions.isAddAttachment() returns false
    
    InvalidActivityException - if the task specified does not exist
    
    InvalidStateException - if the task is cancelled
    
    ProcessAttachmentsLimitException - if no more attachments can be added to the task
    
    InvalidOperationException - if the node is unattended
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    getPermissionsForNode(Long)
  - addAttachmentToTasks
```
java.lang.Long[] addAttachmentToTasks(java.lang.Long[] taskIds_,
                                      Attachment attachment_)
```
    Add an attachment to the given tasks
    Parameters:
    
    taskIds_ - Ids of tasks
    
    attachment_ - the attachment to add to the tasks
    
    Returns:
    an Array of result codes for all specified tasks:
    
    -4 = Unattended task
    
    -3 = Cancelled task
    
    -2 = Too many attachments
    
    -1 = Task does not exist
    
    0 = No permissions
    
    1 = Successful
    Throws:
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    getPermissionsForNodes(Long[])
  - addAttachmentsToTask
```
java.lang.Long[] addAttachmentsToTask(java.lang.Long taskId_,
                                      Attachment[] attachments_)
                               throws PrivilegeException,
                                      InvalidActivityException,
                                      InvalidStateException,
                                      InvalidOperationException,
                                      ProcessAttachmentsLimitException
```
    Adds attachments to a given task.
    
    Parameters:
    
    taskId_ - the ID of the Task.
    
    attachments_ - the attachments to be added to task.
    
    Returns:
    
    the IDs of the attachments that were added to the task
    
    Throws:
    
    PrivilegeException - if the user does not have sufficent privileges to add attachments to this task - that is, if NodePermissions.isAddAttachment() returns false
    
    InvalidActivityException - if the task specified does not exist
    
    InvalidStateException - if the task is cancelled
    
    ProcessAttachmentsLimitException - if no more attachments can be added to the task
    
    ServiceException - if any system-level error occurs
    
    InvalidOperationException - if the node is unattended
    
    See Also:
    
    getPermissionsForNode(Long)
  - getDeadlineForProcess
```
java.sql.Timestamp getDeadlineForProcess(java.lang.Long processId_)
                                  throws java.lang.NullPointerException,
                                         InvalidProcessException,
                                         PrivilegeException
```
    Retrieve the deadline of a given process.
    
    Parameters:
    
    processId_ - The id of the process.
    
    Returns:
    
    The deadline of the process, or null if no deadline is set.
    
    Throws:
    
    java.lang.NullPointerException - if processId_ is null
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
  - setDeadlineForProcess
```
void setDeadlineForProcess(java.lang.Long processId_,
                           java.sql.Timestamp deadline_)
                    throws java.lang.NullPointerException,
                           InvalidProcessException,
                           PrivilegeException
```
    Set the deadline for a given process.
    
    Parameters:
    
    processId_ - The id of a process.
    
    deadline_ - The deadline to set for the process, or null to disable the deadline for the process.
    
    Throws:
    
    java.lang.NullPointerException - if processId_ is null
    
    InvalidProcessException - if the process specified does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
  - getDeadlineForTask
```
java.sql.Timestamp getDeadlineForTask(java.lang.Long taskId_)
                               throws java.lang.NullPointerException,
                                      InvalidActivityException,
                                      PrivilegeException
```
    Retrieve the deadline for a given task.
    
    Parameters:
    
    taskId_ - The id of the task.
    
    Returns:
    
    The deadline of the task, or null if no deadline is set.
    
    Throws:
    
    java.lang.NullPointerException - if taskId_ is null
    
    InvalidActivityException - if the task specified does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
  - setDeadlineForTask
```
void setDeadlineForTask(java.lang.Long taskId_,
                        java.sql.Timestamp deadline_)
                 throws java.lang.NullPointerException,
                        InvalidActivityException,
                        PrivilegeException
```
    Set the deadline for a given task.
    
    Parameters:
    
    taskId_ - The id of a task.
    
    deadline_ - The deadline to set for the task, or null to disable the deadline for the task.
    
    Throws:
    
    java.lang.NullPointerException - if taskId_ is null
    
    InvalidActivityException - if the task specified
    
    PrivilegeException - if the current user does not have privileges to perform this action does not exist
  - getPriorityOfTask
```
Priority getPriorityOfTask(java.lang.Long taskId_)
                    throws InvalidActivityException,
                           PrivilegeException
```
    Get the priority of the specified task.
    
    Parameters:
    
    taskId_ - The id of the task for which to get the priority.
    
    Returns:
    
    The priority of the specified task.
    
    Throws:
    
    InvalidActivityException - if the task does not exist.
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    ServiceException - if any system-level error occurs
  - getPriorityOfTasks
```
Priority[] getPriorityOfTasks(java.lang.Long[] taskIds_)
                       throws InvalidActivityException,
                              PrivilegeException
```
    Get the priorities of the specified tasks.
    
    Parameters:
    
    taskIds_ - The ids of the tasks for which to get the priorities.
    
    Returns:
    
    An array of priorities corresponding to the given tasks.
    
    Throws:
    
    InvalidActivityException - If any of the tasks do not exist.
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    ServiceException - if any system-level error occurs
  - getPriorityOfProcess
```
Priority getPriorityOfProcess(java.lang.Long processId_)
                       throws InvalidProcessException,
                              PrivilegeException
```
    Gets the priority of a specified Process.
    
    Parameters:
    
    processId_ - The id of the process for which to retrieve the priority.
    
    Returns:
    
    The priority of the specified process.
    
    Throws:
    
    InvalidProcessException - If the process does not exist.
    
    PrivilegeException - If the user does not have the permissions to retrieve the priority of the process.
    
    ServiceException - if any system-level error occurs
  - getPriorityOfProcesses
```
Priority[] getPriorityOfProcesses(java.lang.Long[] processIds_)
                           throws InvalidProcessException,
                                  PrivilegeException
```
    Gets the priority for a list of processes.
    
    Parameters:
    
    processIds_ - The ids of the processes for which to retrieve the priorities.
    
    Returns:
    
    An array of priorities corresponding to the given process ids.
    
    Throws:
    
    InvalidProcessException - If any of the processes do not exist.
    
    PrivilegeException - If the user does not have the permissions to retrieve the priority of any of the processes.
    
    ServiceException - if any system-level error occurs
  - setPriorityOfTask
```
void setPriorityOfTask(java.lang.Long taskId_,
                       java.lang.Long priorityId_)
                throws InvalidActivityException,
                       InvalidPriorityException,
                       PrivilegeException,
                       InvalidStateException
```
    Sets the priority of a specified task.
    
    Parameters:
    
    taskId_ - the task for which to set the priority
    
    priorityId_ - the id of the priority to which to set the task; the id is one of the ids from web.war/WEB-INF/conf/process/priority-config-process.xml
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    InvalidPriorityException - if the priority does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    InvalidStateException - if the process is already CANCELLED OR COMPLETED
    
    ServiceException - if any system-level error occurs
  - setPriorityOfTasks
```
void setPriorityOfTasks(java.lang.Long[] taskIds_,
                        java.lang.Long priorityId_)
                 throws InvalidActivityException,
                        InvalidPriorityException,
                        PrivilegeException,
                        InvalidStateException
```
    Sets the priorities of specified tasks.
    
    Parameters:
    
    taskIds_ - the tasks for which to set the priorities
    
    priorityId_ - the id of the priority to which to set the tasks; the id is one of the ids from web.war/WEB-INF/conf/process/priority-config-process.xml
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    InvalidPriorityException - if the priority does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    InvalidStateException - if the process is already CANCELLED OR PAUSED
    
    ServiceException - if any system-level error occurs
  - setPriorityOfProcess
```
void setPriorityOfProcess(java.lang.Long processId_,
                          java.lang.Long priorityId_,
                          boolean propagatePriorityChangeToSubProcesses_)
                   throws InvalidProcessException,
                          InvalidPriorityException,
                          PrivilegeException,
                          InvalidStateException
```
    Sets the priority of a specified process
    
    Parameters:
    
    processId_ - the id of the process
    
    priorityId_ - the id of the priority to which to set the process; the id is one of the ids from web.war/WEB-INF/conf/process/priority-config-process.xml
    
    propagatePriorityChangeToSubProcesses_ - true if the priority will propagate to sub processes within this process, otherwise false
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    InvalidPriorityException - if the priority does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    InvalidStateException - if the process is already CANCELLED OR COMPLETED
    
    ServiceException - if any system-level error occurs
  - setPriorityOfProcesses
```
void setPriorityOfProcesses(java.lang.Long[] processIds_,
                            java.lang.Long priorityId_,
                            boolean propagatePriorityChangeToSubProcesses_)
                     throws InvalidProcessException,
                            InvalidPriorityException,
                            PrivilegeException,
                            InvalidStateException
```
    Sets the priority Priority of the specified processes ProcessDetails.
    
    Parameters:
    
    processIds_ - the ids of the processes for which to set the priority
    
    priorityId_ - the priority to set for the processes; the id is one of the ids from web.war/WEB-INF/conf/process/priority-config-process.xml
    
    propagatePriorityChangeToSubProcesses_ - true if the priority will propagate to sub processes within the processes, otherwise false.
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    InvalidPriorityException - if the priority does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    InvalidStateException - if the process is already CANCELLED OR COMPLETED
    
    ServiceException - if any system-level error occurs
  - raisePriorityOfTask
```
void raisePriorityOfTask(java.lang.Long taskId_)
                  throws InvalidActivityException,
                         PrivilegeException,
                         InvalidStateException
```
    Raises the priority of the specified task by one level.
    
    Parameters:
    
    taskId_ - the id of the task for which to raise the priority
    
    Throws:
    
    InvalidTaskExpcetion - if the task does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    InvalidStateException - if the process is already CANCELLED OR COMPLETED
    
    ServiceException - if any system-level error occurs
    
    InvalidActivityException
  - raisePriorityOfTasks
```
void raisePriorityOfTasks(java.lang.Long[] taskIds_)
                   throws InvalidActivityException,
                          PrivilegeException,
                          InvalidStateException
```
    Raises the priority of the specified tasks by one level.
    
    Parameters:
    
    taskIds_ - the ids of the tasks of which to raise the priority
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    InvalidStateException - if the process is already CANCELLED OR COMPLETED
    
    ServiceException - if any system-level error occurs
  - raisePriorityOfProcess
```
void raisePriorityOfProcess(java.lang.Long processId_,
                            boolean propagatePriorityChangeToLinkProcesses_)
                     throws InvalidProcessException,
                            PrivilegeException,
                            InvalidStateException
```
    Raises the priority of a specified process by one level.
    
    Parameters:
    
    processId_ - the ID of a process of which to raise the priority
    
    propagatePriorityChangeToLinkProcesses_ - true if the priority will propagate to linked processes within the processes, otherwise false
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    InvalidStateException - if the process is already CANCELLED OR COMPLETED
    
    ServiceException - if any system-level error occurs
  - raisePriorityOfProcesses
```
void raisePriorityOfProcesses(java.lang.Long[] processIds_,
                              boolean propagatePriorityChangeToLinkProcesses_)
                       throws InvalidProcessException,
                              PrivilegeException,
                              InvalidStateException
```
    Raises the priority of the specified processes by one level.
    
    Parameters:
    
    processIds_ - the ids of the processes of which to raise the priority
    
    propagatePriorityChangeToLinkProcesses_ - true if the priority will propagate to linked processes within the processes, otherwise false
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    InvalidStateException - if the process is already CANCELLED OR COMPLETED
    
    ServiceException - if any system-level error occurs
  - lowerPriorityOfTask
```
void lowerPriorityOfTask(java.lang.Long taskId_)
                  throws InvalidActivityException,
                         PrivilegeException,
                         InvalidStateException
```
    Lowers the priority of a task by one level. If the priority of the task is at the lowest level, then no action is performed.
    
    Parameters:
    
    taskId_ - the ID of the task of which to lower the priority
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    InvalidStateException - if the process is already CANCELLED OR COMPLETED
    
    ServiceException - if any system-level error occurs
  - lowerPriorityOfTasks
```
void lowerPriorityOfTasks(java.lang.Long[] taskIds_)
                   throws InvalidActivityException,
                          PrivilegeException,
                          InvalidStateException
```
    Lowers the priority of specified tasks by one level. If the priority of any task is at the lowest level, then no action is performed on that task
    
    Parameters:
    
    taskIds_ - the ID's of the tasks of which to lower the priority
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    InvalidStateException - if the process is already CANCELLED OR COMPLETED
    
    ServiceException - if any system-level error occurs
  - lowerPriorityOfProcess
```
void lowerPriorityOfProcess(java.lang.Long processId_,
                            boolean propagatePriorityChangeToLinkProcesses_)
                     throws InvalidProcessException,
                            PrivilegeException,
                            InvalidStateException
```
    Lowers the priority of a process by one level. If the priority of the process is at the lowest level, then no action is performed on that process.
    
    Parameters:
    
    processId_ - the ID of the process of which to lower the priority
    
    propagatePriorityChangeToLinkProcesses_ - true if the priority will propagate to linked processes within the process, otherwise false
    
    Throws:
    
    InvalidProcessException - if the specified process does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    InvalidStateException - if the process is already CANCELLED OR COMPLETED
    
    ServiceException - if any system-level error occurs
  - lowerPriorityOfProcesses
```
void lowerPriorityOfProcesses(java.lang.Long[] processIds_,
                              boolean propagatePriorityChangeToLinkProcesses_)
                       throws InvalidProcessException,
                              PrivilegeException,
                              InvalidStateException
```
    Lowers the priority of the specified processes by one level. If the priority of the any process is at the lowest level, then no action is performed on that process.
    
    Parameters:
    
    processIds_ - the ID's of the processes of which to lower the priority
    
    propagatePriorityChangeToLinkProcesses_ - true if the priority will propagate to linked processes within the processes, otherwise false
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    InvalidStateException - if the process is already CANCELLED OR COMPLETED
    
    ServiceException - if any system-level error occurs
  - containsLinkProcessesInheritingPriority
```
@Deprecated
boolean containsLinkProcessesInheritingPriority(java.lang.Long processId_)
                                                     throws InvalidProcessException
```
    Deprecated. Use containsSubProcessesInheritingPriority(Long) instead.
    
    Checks if the process specified contains linked processes inheriting its priority.
    
    Parameters:
    
    processId_ - id of process for which to check linked processes
    
    Returns:
    
    true if the given process contains at least one linked process inheriting its priority, false otherwise
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    ServiceException - if any system-level errors occur
  - containsSubProcessesInheritingPriority
```
boolean containsSubProcessesInheritingPriority(java.lang.Long processId_)
                                        throws InvalidProcessException
```
    Checks if the specified Process contains sub-processes that inherit their priority instead of defining their own priority levels.
    
    Parameters:
    
    processId_ - The ID of the parent Process.
    
    Returns:
    
    true if the given Process contains at least one sub-process that inherits its priority and false otherwise.
    
    Throws:
    
    InvalidProcessException - If the given Process does not exist.
    
    ServiceException - If an error occurs in the backend.
  - createNoteMetadata
```
NoteMetadata createNoteMetadata(NoteMetadata nm_)
                         throws InvalidUserException
```
    Create note metadata that is not attached to a process or task. The minimum required fields to create a note metadata are: type
    
    Parameters:
    
    nm_ - the note metadata to be created
    
    Returns:
    
    the note metadata with location field populated, so that the note can be written to disk using NotesContentService.createNoteContent(NoteMetadata, String)
    
    Throws:
    
    InvalidUserException - if any of the users referenced by the NoteMetadata does not exist
    
    ServiceException - if any system-level errors occur
  - createNoteMetadatas
```
NoteMetadata[] createNoteMetadatas(NoteMetadata[] nms_)
                            throws InvalidUserException
```
    Bulk create note metadata. This method performs the same action as createNoteMetadata(NoteMetadata), except in bulk
    
    Parameters:
    
    nms_ - the note metadatas to be created. If any of the NoteMetadata objects is null the method will throw a NullPointerException.
    
    Returns:
    
    the note metadata with location field populated, so that the notes can be created using NotesContentService.createNoteContent(NoteMetadata, String)
    
    Throws:
    
    InvalidUserException - if any of the users referenced by a NoteMetadata does not exist
    
    ServiceException - if any system-level errors occur
  - getNotePath
```
java.lang.String getNotePath(java.lang.Long noteId_)
                      throws InvalidNoteException
```
    Gets the location for storage of the content of an unattached note. Unattached notes are not attached to a particular process or task.
    
    Parameters:
    
    noteId_ - Note id of the note path to get.
    
    Returns:
    
    Returns the path of the note whose id was passed.
    
    Throws:
    
    InvalidNoteException - if the note is invalid or does not exist.
    
    ServiceException - if any system-level errors occur
  - getNotePaths
```
java.lang.String[] getNotePaths(java.lang.Long[] noteIds_)
                         throws InvalidNoteException
```
    Gets the locations for storage of the content of unattached notes. Unattached notes are not attached to a particular process or task.
    
    Parameters:
    
    noteIds_ - Note ids of the note paths to get.
    
    Returns:
    
    Returns the paths of the notes whose ids were passed.
    
    Throws:
    
    InvalidNoteException - If any of the notes are invalid or do not exist.
    
    ServiceException - if any system-level errors occur
  - getCurrentNotePaths
```
java.lang.String[] getCurrentNotePaths()
```
    Retrieve the paths where notes are stored on Execution engine 0.
    
    Returns:
    
    The paths where notes are stored.
    
    Throws:
    
    ServiceException - if any system-level errors occur
  - setCurrentNotePaths
```
void setCurrentNotePaths(java.lang.String[] notePaths)
                  throws PrivilegeException,
                         java.lang.IllegalArgumentException
```
    Sets the paths where notes are stored on Execution engine 0.
    
    Parameters:
    
    notePaths -
    
    Throws:
    
    PrivilegeException - if the current user does not have privileges to change the paths. Normally this only includes system admins.
    
    ServiceException - if any system-level errors occur
    
    java.lang.IllegalArgumentException - if the length of the array passed does not match the number of existing notes
  - getExceptionNoteMetadataForTask
```
NoteMetadata getExceptionNoteMetadataForTask(java.lang.Long taskId_)
                                      throws InvalidActivityException
```
    Gets the last exception note (that is, the note attached to the exception) for the specified task; null if no exceptions have been raised on the task
    
    Parameters:
    
    taskId_ - the id of the task for which to get the note
    
    Returns:
    
    NoteMetadata the note metadata for the requested note.
    
    Throws:
    
    InvalidActivityException - if no task with the passed id exists.
    
    ServiceException - if any system-level errors occur
  - getExceptionNoteMetadatasForProcess
```
ResultPage getExceptionNoteMetadatasForProcess(java.lang.Long processId_,
                                               int startIndex_,
                                               int batchSize_,
                                               java.lang.Integer sortProperty_,
                                               java.lang.Integer sortOrder_)
                                        throws InvalidProcessException,
                                               PrivilegeException
```
    Gets a page out of the note metadatas for process exceptions for a specified process. The results array will be empty if no exceptions have been raised on the process.
    
    Parameters:
    
    processId_ - the ID of the process
    
    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. Should be one of the SORT_BY_XXX constants on NoteMetadata.
    
    sortOrder_ - The order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    Returns a ResultPage containing instances of NoteMetadata
    
    Throws:
    
    InvalidProcessException - if no process with the passed id exists.
    
    PrivilegeException - if the user does not have permissions to view the note metadatas for the process.
    
    ServiceException - if any system-level errors occur
  - getAllExceptionNoteMetadatasForProcess
```
ResultPage getAllExceptionNoteMetadatasForProcess(java.lang.Long processId_,
                                                  int startIndex_,
                                                  int batchSize_,
                                                  java.lang.Integer sortProperty_,
                                                  java.lang.Integer sortOrder_)
                                           throws InvalidProcessException,
                                                  PrivilegeException
```
    Gets a page out of the note metadatas for process and task exceptions for a specified process and all its tasks. The results array will be empty if no exceptions have been raised on the process or any of its tasks.
    
    Parameters:
    
    processId_ - the ID of the process
    
    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. Should be one of the SORT_BY_XXX constants on NoteMetadata.
    
    sortOrder_ - The order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    Returns a ResultPage containing instances of NoteMetadata
    
    Throws:
    
    InvalidProcessException - if no process with the passed id exists.
    
    PrivilegeException - if the user does not have permissions to view the note metadatas for the process.
    
    ServiceException - if any system-level errors occur
  - createNoteMetadataForProcess
```
NoteMetadata createNoteMetadataForProcess(java.lang.Long processId_,
                                          NoteMetadata nm_)
                                   throws InvalidProcessException,
                                          PrivilegeException,
                                          InvalidStateException,
                                          InvalidUserException,
                                          java.lang.NullPointerException,
                                          NotesLimitException
```
    Creates a new Note for the specified Process. The minimum required fields to create a note metadata are: type
    
    Parameters:
    
    processId_ - ID of the Process
    
    nm_ - the note metadata to be created
    
    Returns:
    
    the note metadata with location field populated, so that the note can be written to disk using NotesContentService.createNoteContent(NoteMetadata, String)
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    InvalidStateException - if the process is cancelled or paused by exception
    
    PrivilegeException - if ProcessPermissions.isAddAttachment() is false for current user
    
    InvalidUserException - if any of the users referenced by the NoteMetadata does not exist
    
    java.lang.NullPointerException - if nm_ is null
    
    NotesLimitException - if too many notes have already been added to the process
    
    ServiceException - if any system-level errors occur
  - createNoteMetadataForProcesses
```
ResultList createNoteMetadataForProcesses(java.lang.Long[] processIds_,
                                          NoteMetadata nm_)
                                   throws InvalidUserException,
                                          java.lang.NullPointerException
```
    Creates a new Note for the specified Processes. The minimum required fields to create a note metadata are: type
    
    Parameters:
    
    processIds_ - Ids of the Processes
    
    nm_ - the note metadata to be created
    
    Returns:
    
    ResultList of String objects, representing the location of the notes. Each of the result codes returned will be one of the NOTE_CREATION_PROCESS_XXX constants
    
    Throws:
    
    InvalidUserException - if any of the users referenced by the NoteMetadata does not exist
    
    java.lang.NullPointerException - if nm_ is null or processIds_ is null or both processIds_ and nm_are null.
    
    ServiceException - if any system-level errors occur
  - createNoteMetadatasForProcess
```
ResultList createNoteMetadatasForProcess(java.lang.Long processId_,
                                         NoteMetadata[] nms_)
                                  throws InvalidProcessException,
                                         InvalidStateException,
                                         PrivilegeException,
                                         InvalidUserException
```
    Creates multiple notes for a given Process. The minimum required fields to create a note metadata are: type Creating multiple notes for a single process will throw exceptions for process conditions - for example if the process does not exist or if the process is in an invalid state. Otherwise, any errors such as insufficient permissions to create a certain note will be returned in the ResultList's result codes.
    
    Parameters:
    
    processId_ - Id of the Process
    
    nms_ - the note metadatas to be created
    
    Returns:
    
    ResultList of String objects, representing the location of the notes, so that the notes can be written to disk using NotesContentService.createNoteContent(NoteMetadata, String). Each of the returned result codes in the ResultList will be one of NOTE_CREATION_PROCESS_NOTE_LIMIT_EXCEEDED, NOTE_CREATION_PROCESS_INSUFFICIENT_PRIVILEGES, NOTE_CREATION_PROCESS_SUCCESS, or #NOTE_CREATION_PROCESS_INVALID_BEAN)
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    InvalidStateException - if the process is cancelled
    
    PrivilegeException - if ProcessPermissions.isAddAttachment() is false for current user
    
    InvalidUserException - if any of the users referenced by a NoteMetadata does not exist
    
    ServiceException - if any system-level errors occur
  - getNoteMetadatasForProcess
```
ResultPage getNoteMetadatasForProcess(java.lang.Long id_,
                                      boolean recursive_,
                                      int startIndex_,
                                      int batchSize_,
                                      java.lang.Integer sortProperty_,
                                      java.lang.Integer sortOrder_)
                               throws InvalidProcessException,
                                      PrivilegeException
```
    Returns the metadata for the notes for a specified process
    
    Parameters:
    
    id_ - the id of the process
    
    recursive_ - return recursive results if set to true
    
    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. Should be one of the SORT_BY_XXX constants on NoteMetadata.
    
    sortOrder_ - The order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing instances of NoteMetadata. 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 does not exist
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    ServiceException - if any system-level errors occur
  - getNoteMetadatasForProcesses
```
ResultList getNoteMetadatasForProcesses(java.lang.Long[] ids_)
```
    Returns the metadata for the notes for specified processes.
    
    Parameters:
    
    ids_ - the process ids
    
    Returns:
    
    a ResultList containing instances of NoteMetadata
    
    Throws:
    
    ServiceException - if any system-level errors occur
  - getNoteMetadatasForProcess
```
@Deprecated
ResultPage getNoteMetadatasForProcess(java.lang.Long id_,
                                                  int startIndex_,
                                                  int batchSize_,
                                                  java.lang.Integer sortProperty_,
                                                  java.lang.Integer sortOrder_)
                                           throws InvalidProcessException,
                                                  PrivilegeException
```
    Deprecated.
    
    Returns the metadata for the notes for a specified process
    
    Parameters:
    
    id_ - the id of the process
    
    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. Should be one of the SORT_BY_XXX constants on NoteMetadata.
    
    sortOrder_ - The order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing instances of NoteMetadata. 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 does not exist
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    ServiceException - if any system-level errors occur
  - createNoteMetadataForTask
```
NoteMetadata createNoteMetadataForTask(java.lang.Long taskId_,
                                       NoteMetadata nm_)
                                throws InvalidActivityException,
                                       PrivilegeException,
                                       InvalidStateException,
                                       InvalidOperationException,
                                       InvalidUserException,
                                       java.lang.NullPointerException,
                                       NotesLimitException
```
    Creates a new Note for a given Task. The minimum required fields to create a note metadata are: type
    
    Parameters:
    
    taskId_ - ID of the task
    
    nm_ - the note metadata to be created
    
    Returns:
    
    he note metadata with location field populated, so that the note can be written to disk using NotesContentService.createNoteContent(NoteMetadata, String)
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    InvalidStateException - if the task is in states TaskSummary.TASK_STATUS_CANCELLED, TaskSummary.TASK_STATUS_ABORTED, TaskSummary.TASK_STATUS_ERROR, or if the process is in state ProcessSummary.STATE_CANCELLED
    
    PrivilegeException - if NodePermissions.isAddAttachment() is false for current user
    
    InvalidOperationException - if the activity is unattended
    
    InvalidUserException - if any of the users referenced by the NoteMetadata does not exist
    
    java.lang.NullPointerException - if nm_ is null
    
    ServiceException - if any system-level errors occur
    
    NotesLimitException
  - createNoteMetadataForTasks
```
ResultList createNoteMetadataForTasks(java.lang.Long[] taskIds_,
                                      NoteMetadata nm_)
                               throws InvalidUserException,
                                      java.lang.NullPointerException
```
    Creates a new Note for the given Tasks. The minimum required fields to create a note metadata are: type
    
    Parameters:
    
    taskIds_ - IDs of the tasks
    
    nm_ - the note metadata to be created
    
    Returns:
    
    ResultList containing one String, representing the location where the NoteMetadata is stored so that the notes can be written to disk using NotesContentService.createNoteContent(NoteMetadata, String). The result code returned in the ResultList will be one of the NOTE_CREATION_TASK_XXX constants
    
    Throws:
    
    InvalidUserException - if any of the users referenced by a NoteMetadata does not exist
    
    java.lang.NullPointerException - if nm_ is null
    
    ServiceException - if any system-level errors occur
  - createNoteMetadatasForTask
```
ResultList createNoteMetadatasForTask(java.lang.Long taskId_,
                                      NoteMetadata[] nms_)
                               throws InvalidActivityException,
                                      InvalidStateException,
                                      PrivilegeException,
                                      InvalidOperationException,
                                      InvalidUserException
```
    Creates multiple notes for a given task. The minimum required fields to create a note metadata are: type Creating multiple notes for a single task will throw exceptions for task conditions - for example if the task does not exist or if the task is in an invalid state. Otherwise, any errors such as insufficient permissions to create a certain note will be returned in the ResultList's result codes.
    
    Parameters:
    
    taskId_ - ID of Task
    
    nms_ - the note metadatas to be created
    
    Returns:
    
    ResultList of NoteMetadata objects, with the location field populated so that the notes can be written to disk using NotesContentService.createNoteContent(NoteMetadata, String). Each of the returned result codes in the ResultList will be one of NOTE_CREATION_TASK_NOTE_LIMIT_EXCEEDED, NOTE_CREATION_TASK_INSUFFICIENT_PRIVILEGES, NOTE_CREATION_TASK_SUCCESS, or NOTE_CREATION_TASK_INVALID_BEAN
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    InvalidStateException - if the task is in states TaskSummary.TASK_STATUS_CANCELLED, TaskSummary.TASK_STATUS_ABORTED, TaskSummary.TASK_STATUS_ERROR, or if the process is in state ProcessSummary.STATE_CANCELLED
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    InvalidOperationException - if the activity is unattended
    
    InvalidUserException - if any of the users referenced by a NoteMetadata does not exist
    
    ServiceException - if any system-level errors occur
  - getNoteMetadatasForTask
```
ResultPage getNoteMetadatasForTask(java.lang.Long id_,
                                   boolean includeProcess_,
                                   int startIndex_,
                                   int batchSize_,
                                   java.lang.Integer sortProperty_,
                                   java.lang.Integer sortOrder_)
                            throws InvalidActivityException,
                                   PrivilegeException,
                                   InvalidOperationException
```
    Gets the metadata for the notes of a specified task.
    
    Parameters:
    
    id_ - the task id
    
    includeProcess_ - true if the note metadata of the parent process should be returned as well; false otherwise
    
    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. Should be one of the SORT_BY_XXX constants on NoteMetadata.
    
    sortOrder_ - The order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing instances of NoteMetadata
    
    Throws:
    
    InvalidActivityException - if the task specified does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    ServiceException - if any system-level errors occur
    
    InvalidOperationException
  - getNoteMetadatasForTasks
```
ResultList getNoteMetadatasForTasks(java.lang.Long[] ids_,
                                    boolean includeProcess_)
```
    Gets the notes for the specified tasks
    
    Parameters:
    
    ids_ - the task ids
    
    includeProcess_ - if true, includes Process Notes, otherwise does not.
    
    Returns:
    
    ResultList containing String locations for storing the note contents using NotesContentService. 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 task does not exist
    
    Throws:
    
    ServiceException - if any system-level errors occur
  - deleteNoteMetadataForProcess
```
java.lang.String deleteNoteMetadataForProcess(java.lang.Long noteId_,
                                              java.lang.Long processId_)
                                       throws InvalidProcessException,
                                              PrivilegeException,
                                              InvalidStateException,
                                              InvalidNoteException
```
    Deletes the specified Note for the given process.
    
    Parameters:
    
    noteId_ - ID of note to delete
    
    processId_ - ID of the process from which to delete the note
    
    Returns:
    
    location of the note content file on disk.
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    InvalidStateException - if the process is cancelled
    
    InvalidNoteException - if the note specified does not exist
    
    java.lang.NullPointerException - if noteId_ is null
    
    ServiceException - if any system-level error occurs
  - deleteNoteMetadataForTask
```
java.lang.String deleteNoteMetadataForTask(java.lang.Long noteId_,
                                           java.lang.Long taskId_)
                                    throws InvalidActivityException,
                                           PrivilegeException,
                                           InvalidStateException,
                                           InvalidOperationException,
                                           InvalidNoteException
```
    Deletes the specified Note from a given task.
    
    Parameters:
    
    noteId_ - ID of Note to delete
    
    taskId_ - ID of the task from which the note is to be deleted
    
    Returns:
    
    location of the note content file on disk.
    
    Throws:
    
    InvalidActivityException - if the task specified does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    InvalidStateException - if the task is cancelled
    
    InvalidOperationException - if the activity is unattended
    
    InvalidNoteException - if the note specified does not exist
    
    ServiceException - if any system-level error occurs
  - deleteNoteMetadatasForProcess
```
ResultList deleteNoteMetadatasForProcess(java.lang.Long[] noteIds_,
                                         java.lang.Long processId_)
                                  throws InvalidProcessException,
                                         InvalidStateException
```
    Deletes the specified notes from the given process
    
    Parameters:
    
    noteIds_ - IDs of notes to delete
    
    processId_ - ID of the process from which to delete the notes
    
    Returns:
    
    ResultList of String objects, representing the location of the deleted notes. Each of the returned result codes in the ResultList will be one of NOTE_DELETION_INVALID, NOTE_DELETION_INSUFFICIENT_PRIVILEGES or NOTE_DELETION_SUCCESS
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    InvalidStateException - if the process is cancelled
    
    java.lang.NullPointerException - if noteIds_ is null
    
    ServiceException - if any system-level error occurs
  - deleteNoteMetadatasForTask
```
ResultList deleteNoteMetadatasForTask(java.lang.Long[] noteIds_,
                                      java.lang.Long taskId_)
                               throws InvalidActivityException,
                                      InvalidStateException,
                                      InvalidOperationException
```
    Deletes the specified notes for the given task
    
    Parameters:
    
    noteIds_ - IDs of notes to delete
    
    taskId_ - ID of the task from which to delete the notes
    
    Returns:
    
    ResultList of String objects, representing the location of the deleted notes. Each of the returned result codes in the ResultList will be one of NOTE_DELETION_INVALID, NOTE_DELETION_INSUFFICIENT_PRIVILEGES or NOTE_DELETION_SUCCESS
    
    Throws:
    
    InvalidActivityException - if the task specified does not exist
    
    InvalidStateException - if the task is cancelled
    
    InvalidOperationException - if the activity is unattended
    
    ServiceException - if any system-level error occurs
  - updateNoteMetadataForProcess
```
NoteMetadata updateNoteMetadataForProcess(NoteMetadata nm_,
                                          java.lang.Long processId_)
                                   throws InvalidProcessException,
                                          InvalidStateException,
                                          PrivilegeException,
                                          InvalidNoteException,
                                          InvalidUserException
```
    Updates the specified Note for given process
    The following field must be populated in the NoteMetadata object: id
    
    Parameters:
    
    nm_ - updated NoteMetadata Object
    
    Returns:
    
    NoteMetadata with updated info
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    InvalidStateException - if the process is cancelled
    
    PrivilegeException - if the current user does not have privileges to update the note
    
    InvalidNoteException - if the note specified does not exist
    
    InvalidUserException - if any of the users referenced by the NoteMetadata does not exist
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    Note
  - updateNoteMetadataForTask
```
NoteMetadata updateNoteMetadataForTask(NoteMetadata nm_,
                                       java.lang.Long taskId_)
                                throws InvalidActivityException,
                                       InvalidStateException,
                                       PrivilegeException,
                                       InvalidOperationException,
                                       InvalidNoteException,
                                       InvalidUserException
```
    Updates the specified Note for given task
    The following field must be populated in the NoteMetadata object: id
    
    Parameters:
    
    nm_ - updated NoteMetadata Object
    
    Returns:
    
    the updated NoteMetadata
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    InvalidStateException - if the task is in states TaskSummary.TASK_STATUS_CANCELLED, TaskSummary.TASK_STATUS_ABORTED, TaskSummary.TASK_STATUS_ERROR, or if the process is in state ProcessSummary.STATE_CANCELLED
    
    InvalidOperationException - if the activity is unattended
    
    InvalidNoteException - if the note specified does not exist
    
    PrivilegeException - if the current user does not have privileges to update the note
    
    InvalidUserException - if any of the users referenced by the NoteMetadata does not exist
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    Note
  - updateNoteMetadatasForProcess
```
ResultList updateNoteMetadatasForProcess(NoteMetadata[] nms_,
                                         java.lang.Long processId_)
                                  throws InvalidStateException,
                                         InvalidProcessException,
                                         InvalidUserException
```
    Updates all the specified notes for the given process. Updating multiple notes for a single process will throw exceptions for process conditions - for example if the process does not exist or if the process is in an invalid state. Otherwise, any errors such as insufficient permissions to update a certain note will be returned in the ResultList's result codes: NOTES_RETURN_SUCCESS if the note was added successfully, NOTES_RETURN_PERMISSIONS if the user does not have permission to remove the note, or NOTES_RETURN_INVALID if the note does not exist
    The following field must be populated in each NoteMetadata object: id
    
    Parameters:
    
    nms_ - Array of updated NoteMetadata Objects.
    
    Returns:
    
    ResultList containing updated NoteMetadatas and result codes, which compared with the constants in Note tells the user if the Note was successfully updated or not
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    InvalidStateException - if the process is cancelled
    
    InvalidUserException - if any of the users referenced by a NoteMetadata does not exist
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    Note
  - updateNoteMetadatasForTask
```
ResultList updateNoteMetadatasForTask(NoteMetadata[] nms_,
                                      java.lang.Long taskId_)
                               throws InvalidActivityException,
                                      InvalidStateException,
                                      InvalidOperationException,
                                      InvalidNoteException,
                                      InvalidUserException
```
    Updates all the specified notes for a given task. Creating multiple notes for a single task will throw exceptions for task conditions for example if the task does not exist or if the task is in an invalid state. Otherwise, any errors such as insufficient permissions to create a certain note will be returned in the ResultList's result codes.
    The following field must be populated in each NoteMetadata object: id
    
    Parameters:
    
    nms_ - Array of updated NoteMetadata Objects.
    
    Returns:
    
    ResultList containing updated NoteMetadatas and result codes: NOTES_RETURN_SUCCESS if the note was added successfully, NOTES_RETURN_PERMISSIONS if the user does not have permission to remove the note, or NOTES_RETURN_INVALID if the note does not exist
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    InvalidStateException - if the task is in states TaskSummary.TASK_STATUS_CANCELLED, TaskSummary.TASK_STATUS_ABORTED, TaskSummary.TASK_STATUS_ERROR, or if the process is in state ProcessSummary.STATE_CANCELLED
    
    InvalidOperationException - if the activity is unattended
    
    InvalidUserException - if any of the users referenced by a NoteMetadata does not exist
    
    ServiceException - if any system-level error occurs
    
    InvalidNoteException
    
    See Also:
    
    Note
  - getNoteMetadataForTask
```
NoteMetadata getNoteMetadataForTask(java.lang.Long noteId_,
                                    java.lang.Long taskId_)
                             throws InvalidActivityException,
                                    PrivilegeException,
                                    InvalidNoteException,
                                    InvalidNoteException
```
    Returns a specified note for given task
    
    Parameters:
    
    noteId_ - Note Id
    
    taskId_ - Task Id
    
    Returns:
    
    NoteMetadata for requested note.
    
    Throws:
    
    InvalidActivityException - if the task specified does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    InvalidNoteException - if the note specified does not exist
    
    ServiceException - if any system-level errors occur
  - getNoteMetadataForProcess
```
NoteMetadata getNoteMetadataForProcess(java.lang.Long noteId_,
                                       java.lang.Long processId_)
                                throws InvalidProcessException,
                                       InvalidNoteException,
                                       PrivilegeException
```
    Returns a specified note for given process
    
    Parameters:
    
    noteId_ - Note Id
    
    processId_ - Process Id
    
    Returns:
    
    NoteMetadata for requested note.
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    PrivilegeException - if the current user does not have privileges to perform this action
    
    InvalidNoteException - if the note specified does not exist
    
    ServiceException - if any system-level errors occur
  - getTasksForProcess
```
ResultPage getTasksForProcess(java.lang.Long processId_,
                              boolean recursive_,
                              int startIndex_,
                              int batchSize_,
                              java.lang.Integer sortProperty_,
                              java.lang.Integer sortOrder_)
                       throws InvalidProcessException,
                              PrivilegeException
```
    Gets the summaries of the tasks in the process. Even summaries for tasks that have not yet been assigned will be returned, though the metadata for such tasks will be null.
    
    Parameters:
    
    processId_ - The id of the process.
    
    recursive_ - return recursive results if set to true
    
    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 in TaskSummary
    
    sortOrder_ - The order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    A ResultPage containing TaskSummary objects representing tasks of the process. If a task is completed then its assignees field will be an empty array.
    
    Throws:
    
    InvalidProcessException - If the process does not exist or has been deleted.
    
    PrivilegeException - If the user does not have permissions view the task summaries for the process.
    
    ServiceException - if any system-level errors occur
  - getTasksForProcess
```
@Deprecated
ResultPage getTasksForProcess(java.lang.Long processId_,
                                          int startIndex_,
                                          int batchSize_,
                                          java.lang.Integer sortProperty_,
                                          java.lang.Integer sortOrder_)
                                   throws InvalidProcessException,
                                          PrivilegeException
```
    Deprecated.
    
    Gets the summaries of the tasks in the process. Even summaries for tasks that have not yet been assigned will be returned, though the metadata for such tasks will be null.
    
    Parameters:
    
    processId_ - The id of the process.
    
    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 in TaskSummary
    
    sortOrder_ - The order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    A ResultPage containing TaskSummary objects representing tasks of the process. If a task is completed then its assignees field will be an empty array.
    
    Throws:
    
    InvalidProcessException - If the process does not exist or has been deleted.
    
    PrivilegeException - If the user does not have permissions view the task summaries for the process.
    
    ServiceException - if any system-level errors occur
  - pauseProcess
```
void pauseProcess(java.lang.Long processId_)
           throws InvalidProcessException,
                  InvalidStateException,
                  PrivilegeException,
                  LockException
```
    Pauses the process, and all of its nodes. However, the nodes' states remain as they were before. This allows the user to START (Activate), RESUME, PAUSE, or CANCEL specific nodes, the effects of which will play out when the Process is RESUMED.
    
    Parameters:
    
    processId_ - ID of the process
    
    Throws:
    
    InvalidProcessException - if the process does not exist or has been deleted
    
    InvalidStateException - if the process is cancelled or paused
    
    PrivilegeException - if the user does not have permission to pause the process - if ProcessPermissions.isStopAndPause() returns false
    
    LockException - if the process is locked (see lockProcessModelForProcess(Long,boolean))
    
    ServiceException - if any system-level errors occur
  - pauseProcesses
```
java.lang.Integer[] pauseProcesses(java.lang.Long[] processIds_)
```
    Pauses the processes, and all of their nodes. However, the nodes' states remain as they were before. This allows the user to START (Activate), RESUME, PAUSE, or CANCEL specific nodes, the effects of which will play out when the Processes are RESUMED. The result codes can be: RESULT_CODE_SUCCESS if the action succeeded, RESULT_CODE_INVALID_PROCESS if the process does not exist, RESULT_CODE_INSUFFICIENT_PRIVILEGES if the user does not have permission, RESULT_CODE_INVALID_STATE if the process is not active, or RESULT_CODE_LOCK_EXCEPTION if the specified process is locked
    
    Parameters:
    
    processIds_ - IDs of the processes
    
    Returns:
    
    array of result codes. No exceptions will be thrown, and the developer will compare the returned codes to the constants to determine what happened.
    
    Throws:
    
    ServiceException - if any system-level errors occur
  - resumeProcess
```
void resumeProcess(java.lang.Long processId_)
            throws InvalidProcessException,
                   InvalidStateException,
                   PrivilegeException,
                   LockException
```
    Resumes the process. Note: One can only resume a PAUSED process. CANCELLED processes cannot be resumed - however, new instances of processes can be started.
    
    Parameters:
    
    processId_ - id of the process
    
    Throws:
    
    InvalidProcessException - if the process does not exist or has been deleted
    
    InvalidStateException - if the process is not paused
    
    PrivilegeException - if the user does not have permission to resume the process
    
    LockException - if the process is locked (see lockProcessModelForProcess(Long,boolean))
    
    ServiceException - if any system-level errors occur
  - resumeProcesses
```
java.lang.Integer[] resumeProcesses(java.lang.Long[] processIds_)
```
    Tries to resume the processes, and returns an array of result codes on whether the operation was successful or an error had occurred. The result codes can be: RESULT_CODE_SUCCESS if the action succeeded, RESULT_CODE_INVALID_PROCESS if the process does not exist, RESULT_CODE_INSUFFICIENT_PRIVILEGES if the user does not have permission, RESULT_CODE_INVALID_STATE if the process is not active, or RESULT_CODE_LOCK_EXCEPTION if the specified process is locked
    
    Parameters:
    
    processIds_ - ids of the processes
    
    Returns:
    
    array of result codes. No exceptions will be thrown, and the developer will compare the returned codes to the constants to determine what happened.
    
    Throws:
    
    ServiceException - if any system-level errors occur
  - cancelProcesses
```
java.lang.Integer[] cancelProcesses(java.lang.Long[] processIds_,
                                    boolean cancelLinkedProcesses_)
```
    Cancel a list of processes. This methods will try to cancel the processes, and return an array of result codes on whether the operation was successful or an error has occurred.
    
    Parameters:
    
    processIds_ - the Ids of the processes
    
    cancelLinkedProcesses_ - specifies whether or not to cancel all linked processes when cancelling the processes
    
    Returns:
    
    array of result codes. Each of these is one of the PROCESS_CANCELLATION_XXX constants
    
    Throws:
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    getPermissionsForProcess(Long)
  - startQuickTask
```
java.lang.Long startQuickTask(java.lang.Long processId_,
                              java.lang.Long nodeId_)
                       throws PrivilegeException,
                              InvalidNodeException,
                              InvalidProcessException,
                              InvalidNodeTypeLogicException,
                              InvalidStateException,
                              InvalidNodeTypeRecurringException,
                              InvalidNodeMultiplicityException
```
    Starts a new task from the node If the process to which the node belongs is cancelled or completed, then the process is reactivated. For a paused process, a new task is started but will not be kicked off until the process is resumed. N.B. Logic nodes cannot be started.
    
    Parameters:
    
    processId_ - The id of the process.
    
    nodeId_ - The id of the task's template node, which can be obtained from the templateId property of a TaskSummary object.
    
    Returns:
    
    Long the task id, if the task started correctly, null if the node has spawning or recurrence configured.
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    InvalidNodeException - the node used does not exist or if the node exists (it has a valid template) but does not belong to the given process
    
    InvalidNodeTypeLogicException - if the node is a logic node.
    
    InvalidStateException - if the process is paused by exception
    
    PrivilegeException - if NodePermissions.isModifyInFlight() is false for the current user
    
    InvalidNodeTypeRecurringException - if the node is set to recur
    
    InvalidNodeMultiplicityException - if the node cannot be started because its activity chaining settings prohibit multiple instances
    
    ServiceException - if any system-level error occurs
  - startTask
```
boolean startTask(java.lang.Long processId_,
                  java.lang.Long nodeId_)
           throws PrivilegeException,
                  InvalidNodeException,
                  InvalidProcessException,
                  InvalidNodeTypeLogicException,
                  InvalidStateException,
                  InvalidNodeTypeRecurringException,
                  InvalidNodeMultiplicityException
```
    Starts a new task from the node If the process to which the node belongs is cancelled or completed, then the process is reactivated. For a paused process, a new task is started but will not be kicked off until the process is resumed. N.B. Logic nodes cannot be started.
    
    Parameters:
    
    processId_ - The id of the process.
    
    nodeId_ - The id of the task's template node, which can be obtained from the templateId property of a TaskSummary object.
    
    Returns:
    
    true if the task started correctly, otherwise false
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    InvalidNodeException - the node used does not exist or if the node exists (it has a valid template) but does not belong to the given process
    
    InvalidNodeTypeLogicException - if the node is a logic node.
    
    InvalidStateException - if the process is paused by exception
    
    PrivilegeException - if NodePermissions.isModifyInFlight() is false for the current user
    
    InvalidNodeTypeRecurringException - if the node is set to recur
    
    InvalidNodeMultiplicityException - if the node cannot be started because its activity chaining settings prohibit multiple instances
    
    ServiceException - if any system-level error occurs
  - startTasks
```
java.lang.Integer[] startTasks(java.lang.Long processId_,
                               java.lang.Long[] nodeIds_)
                        throws InvalidProcessException
```
    Tries to start the tasks, and returns an array of result codes on whether the operation was successful or an error had occurred. Will cancel and resolve existing instances of the node that were paused by exception. N.B. Logic nodes cannot be started. The result codes can be: RESULT_CODE_SUCCESS if the action succeeded, RESULT_CODE_INVALID_TASK if the node does not exist, RESULT_CODE_INSUFFICIENT_PRIVILEGES if the user does not have permission, or RESULT_CODE_INVALID_STATE if it is a logic node RESULT_CODE_NODE_MULTIPLICITY if the node cannot be started RESULT_CODE_INVALID_NODE if the node is invalid because its activity chaining settings prohibit multiple instances
    
    Parameters:
    
    processId_ - The id of the process.
    
    nodeIds_ - The ids of the tasks' template nodes, each of which can be obtained from the templateId property of the corresponding TaskSummary object.
    
    Returns:
    
    array of result codes. No exceptions will be thrown, and the developer will compare the returned codes to the constants to determine what happened.
    
    Throws:
    
    InvalidProcessException - if no process exists for the given ID
    
    ServiceException - if any system-level error occurs
  - resumeTask
```
void resumeTask(java.lang.Long activityId_)
         throws InvalidActivityException,
                InvalidStateException,
                PrivilegeException
```
    Resumes the task
    
    Parameters:
    
    activityId_ - the ID of the task
    
    Throws:
    
    InvalidActivityException - if the task does not exist or has been deleted
    
    InvalidStateException - if the task is not PAUSED
    
    PrivilegeException - if the user does not have permissions to resume the task
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    NodePermissions.isModifyInFlight()
  - resumeTasks
```
java.lang.Integer[] resumeTasks(java.lang.Long[] activityIds_)
```
    Tries to resume the tasks, and returns an array of result codes on whether the operation was successful or an error had occurred. The result codes can be: RESULT_CODE_SUCCESS if the action succeeded, RESULT_CODE_INVALID_TASK if the node does not exist, RESULT_CODE_INSUFFICIENT_PRIVILEGES if the user does not have permission, or RESULT_CODE_INVALID_STATE if its state is not paused or paused-by-exception
    
    Parameters:
    
    activityIds_ - the IDs of the tasks
    
    Returns:
    
    array of result codes. No exceptions will be thrown, and the developer will compare the returned codes to the constants to determine what happened.
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - pauseTask
```
void pauseTask(java.lang.Long activityId_)
        throws InvalidActivityException,
               InvalidStateException,
               PrivilegeException
```
    Pauses the task
    
    Parameters:
    
    activityId_ - the ID of the task
    
    Throws:
    
    InvalidActivityException - if the task does not exist or has been deleted
    
    InvalidStateException - if the task has been CANCELLED
    
    PrivilegeException - if the user does not have permissions to pause the task
    
    ServiceException - if any system-level error occurs
  - pauseTasks
```
java.lang.Integer[] pauseTasks(java.lang.Long[] activityIds_)
```
    Tries to pause the tasks, and returns an array of result codes on whether the operation was successful or an error had occurred. The result codes can be: RESULT_CODE_SUCCESS if the action succeeded, RESULT_CODE_INVALID_TASK if the node does not exist, RESULT_CODE_INSUFFICIENT_PRIVILEGES if the user does not have permission, or RESULT_CODE_INVALID_STATE if its state is not started, paused, paused-by-exception, completed, or cancelled
    
    Parameters:
    
    activityIds_ - the IDs of the tasks
    
    Returns:
    
    array of result codes. No exceptions will be thrown, and the developer will compare the returned codes to the constants to determine what happened.
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - cancelTask
```
void cancelTask(java.lang.Long activityId_)
         throws InvalidActivityException,
                InvalidStateException,
                PrivilegeException
```
    Cancels a given task
    
    Parameters:
    
    activityId_ - the ID of the task
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    InvalidStateException - if the task is cancelled
    
    PrivilegeException - if the user does not have sufficent privileges to cancel this task - that is, if ProcessPermissions.isStopAndPause() returns false for the process containing this task
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    getPermissionsForProcess(Long)
  - cancelTasks
```
java.lang.Integer[] cancelTasks(java.lang.Long[] activityIds_)
```
    Cancels a list of tasks. This methos tries to cancel the tasks, and returns an array of result codes on whether the operation was successful or an error has occurred.
    
    Parameters:
    
    activityIds_ - the IDs of the tasks
    
    Returns:
    
    array of result codes. Each of these is one of the TASK_CANCELLATION_XXX constants
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - startAllNodes
```
NodeActionResult startAllNodes(java.lang.String[] nodeUuids,
                               java.lang.Long[] withinProcessIds,
                               BulkNodeOption... bulkNodeOption)
                        throws InvalidProcessException
```
    Start a task for each of the given nodeUuids in every applicable process. If not null, then withinProcessIds limits the processes in which these nodes will be started. Starting a large number of tasks from nodes simultaneously may affect system performance, so it's recommended that withinProcessIds be specified as fewer than 1000 processes at a time, and not to use null for withinProcessIds on other than small or test systems.
    
    Parameters:
    
    nodeUuids - The uuids of the tasks' template nodes, each of which can be obtained from the uuid property of the corresponding TaskSummary object.
    
    withinProcessIds - list of process ids; a null list means all processes containing these nodes.
    
    Returns:
    
    NodeActionResult indicating the actions taken for the nodes.
    
    Throws:
    
    InvalidProcessException - if no process exists for the given ID. If an invalid process id is passed in withinProcessIds, it's thrown immediately before any actions.
    
    ServiceException - if any system-level error occurs
  - restartAllNodes
```
NodeActionResult restartAllNodes(java.lang.String[] nodeUuids,
                                 java.lang.Long[] withinProcessIds,
                                 BulkNodeOption... bulkNodeOption)
                          throws InvalidProcessException
```
    Restart a task for each of the given nodeUuids in every applicable process. This consists of a cancel, and if the cancel is successful, a start. If not null, then withinProcessIds limits the processes in which these nodes will be started. Starting a large number of tasks from nodes simultaneously may affect system performance, so it's recommended that withinProcessIds be specified as fewer than 1000 processes at a time, and not to use null for withinProcessIds on other than small or test systems.
    
    Parameters:
    
    nodeUuids - The uuids of the tasks' template nodes, each of which can be obtained from the uuid property of the corresponding TaskSummary object.
    
    withinProcessIds - list of process ids; a null list means all processes containing these nodes.
    
    Returns:
    
    NodeActionResult indicating the actions taken for the nodes.
    
    Throws:
    
    InvalidProcessException - if no process exists for the given ID. If an invalid process id is passed in withinProcessIds, it's thrown immediately before any actions.
    
    ServiceException - if any system-level error occurs
  - pauseAllNodes
```
NodeActionResult pauseAllNodes(java.lang.String[] nodeUuids,
                               java.lang.Long[] withinProcessIds)
                        throws InvalidProcessException
```
    Pause each given node in every applicable process. If not null, then withinProcessIds limits the processes in which these nodes will be started.
    
    Parameters:
    
    nodeUuids - The uuids of the tasks' template nodes, each of which can be obtained from the uuid property of the corresponding TaskSummary object.
    
    withinProcessIds - list of process ids; a null list means all processes containing these nodes.
    
    Returns:
    
    NodeActionResult indicating the actions taken for the nodes.
    
    Throws:
    
    InvalidProcessException - if no process exists for the given ID. If an invalid process id is passed in withinProcessIds, it's thrown immediately before any actions.
    
    ServiceException - if any system-level error occurs
  - resumeAllNodes
```
NodeActionResult resumeAllNodes(java.lang.String[] nodeUuids,
                                java.lang.Long[] withinProcessIds)
                         throws InvalidProcessException
```
    Resume each given node in every applicable process. If not null, then withinProcessIds limits the processes in which these nodes will be started.
    
    Parameters:
    
    nodeUuids - The uuids of the tasks' template nodes, each of which can be obtained from the uuid property of the corresponding TaskSummary object.
    
    withinProcessIds - list of process ids; a null list means all processes containing these nodes.
    
    Returns:
    
    NodeActionResult indicating the actions taken for the nodes.
    
    Throws:
    
    InvalidProcessException - if no process exists for the given ID. If an invalid process id is passed in withinProcessIds, it's thrown immediately before any actions.
    
    ServiceException - if any system-level error occurs
  - cancelAllNodes
```
NodeActionResult cancelAllNodes(java.lang.String[] nodeUuids,
                                java.lang.Long[] withinProcessIds)
                         throws InvalidProcessException
```
    Cancel each given node in every applicable process. If not null, then withinProcessIds limits the processes in which these nodes will be started.
    
    Parameters:
    
    nodeUuids - The uuids of the tasks' template nodes, each of which can be obtained from the uuid property of the corresponding TaskSummary object.
    
    withinProcessIds - list of process ids; a null list means all processes containing these nodes.
    
    Returns:
    
    NodeActionResult indicating the actions taken for the nodes.
    
    Throws:
    
    InvalidProcessException - if no process exists for the given ID. If an invalid process id is passed in withinProcessIds, it's thrown immediately before any actions.
    
    ServiceException - if any system-level error occurs
  - reassignTaskToSameAssigneePool
```
void reassignTaskToSameAssigneePool(java.lang.Long activityId_)
                             throws InvalidActivityException,
                                    InvalidStateException,
                                    PrivilegeException
```
    Reassigns the task to the assignee pool.
    
    Parameters:
    
    activityId_ - the ID of the task
    
    Throws:
    
    InvalidActivityException - if the task does not exist or has been deleted
    
    InvalidStateException - if the task is not assigned or accepted
    
    PrivilegeException - if the user does not have permissions to reassign the task
    
    ServiceException - if any system-level error occurs
  - reassignTasksToAssigneePool
```
@Deprecated
java.lang.Integer[] reassignTasksToAssigneePool(java.lang.Long[] activityIds_,
                                                            Assignment.Assignee[] assignees_)
                                                     throws InvalidUserException
```
    Deprecated. Use reassignTask(java.lang.Long, com.appiancorp.suiteapi.process.Assignment.Assignee[]) instead
    
    Tries to reassign the tasks to the designated assignees, and returns an array of result codes on whether the operation was successful or an error had occurred. The result codes can be: RESULT_CODE_SUCCESS if the action succeeded, RESULT_CODE_INVALID_TASK if the node does not exist, RESULT_CODE_INSUFFICIENT_PRIVILEGES if the user does not have permission, or RESULT_CODE_INVALID_STATE if the task is not assigned or accepted
    
    Parameters:
    
    activityIds_ - the IDs of the tasks
    
    assignees_ - the assignees to whom the task will be reassigned All the tasks will be assigned to the same assignee array
    
    Returns:
    
    array of result codes. No exceptions will be thrown, and the developer will compare the returned codes to the constants to determine what happened.
    
    Throws:
    
    InvalidUserException - if any of the users referenced by an Assignment.Assignee does not exist
    
    ServiceException - if any system-level error occurs
  - reassignTasksToSameAssigneePool
```
java.lang.Integer[] reassignTasksToSameAssigneePool(java.lang.Long[] activityIds_)
```
    Tries to reassign the tasks, and returns an array of result codes on whether the operation was successful or an error had occurred. The result codes can be: RESULT_CODE_SUCCESS if the action succeeded, RESULT_CODE_INVALID_TASK if the node does not exist, RESULT_CODE_INSUFFICIENT_PRIVILEGES if the user does not have permission, or RESULT_CODE_INVALID_STATE if the task is not assigned or accepted
    
    Parameters:
    
    activityIds_ - the IDs of the tasks
    
    Returns:
    
    array of result codes. No exceptions will be thrown, and the developer will compare the returned codes to the constants to determine what happened.
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - getProcessDiagram
```
ProcessDiagram getProcessDiagram(java.lang.Long processId_,
                                 int typeOfNotesToRetrieve_)
                          throws InvalidProcessException,
                                 PrivilegeException,
                                 java.lang.IllegalArgumentException
```
    Allows users to retrieve the instance of the process model that the process is run off. The diagram will have the process states, and other instance-specific information. The following fields in the process model will be not be populated: folderId, latestVersion, uuid.
    
    Parameters:
    
    processId_ - The id of the process.
    
    typeOfNotesToRetrieve_ - This is one of RETRIEVE_PROCESS_MODEL_NOTES or RETRIEVE_PROCESS_NOTES
    
    Returns:
    
    A diagram of the process with the states.
    
    Throws:
    
    InvalidProcessException - If the process does not exist.
    
    PrivilegeException - If the user does not have permissions to retrieve the process or the process diagram of the process.
    
    java.lang.IllegalArgumentException - if typeOfNotesToRetrieve_ is invalid
    
    ServiceException - if any system-level error occurs
  - updateProcessModelForProcess
```
@Deprecated
ProcessDiagram updateProcessModelForProcess(java.lang.Long processId_,
                                                        ProcessDiagram pd_,
                                                        ProcessModel[] childProcessModels_)
                                                 throws InvalidProcessException,
                                                        LockException,
                                                        PrivilegeException
```
    Deprecated. Use upgradeProcesses(java.lang.Long, java.lang.String, java.lang.Long[]) instead
    
    Only updates the process model instance associated with this process the process model template of which this process is an instance will not be changed. The particular process model instance can also be saved as a version with ProcessDesignService.versionProcessModel(ProcessModel). The following fields are not updated on the process model: creatorUsername, latestVersion, version, variables
    
    Parameters:
    
    processId_ - the id of the process, which is an instance of the process model.
    
    pd_ - the process diagram of the process to be updated. This should be retrieved by a call to getProcessDiagram(java.lang.Long, int).
    
    childProcessModels_ - the sub and linked process models for this updating process model
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    LockException - if the process is currently locked
    
    PrivilegeException - if the user does not have permission to update the process (if ProcessPermissions#isModifyInFlight returns false)
    
    java.lang.IllegalArgumentException - if the ProcessModel bean passed in has any nodes with non-null IDs that are not in the current version of the process model.
    
    ServiceException - if any system-level error occurs
  - upgradeProcesses
```
UpgradeResult upgradeProcesses(java.lang.Long toProcessModelId,
                               java.lang.String toVersion,
                               java.lang.Long[] processIds)
                        throws InvalidProcessModelException,
                               InvalidVersionException,
                               PrivilegeException,
                               InvalidStateException,
                               UpgradeException
```
    Attempts to upgrade the given processes to the specified process model id and version.
    
    Parameters:
    
    toProcessModelId - the id of the process model to upgrade to
    
    toVersion - the version of the process model to upgrade to, exactly as it appears in the user interface. For instance, "2.0" or "3.7"
    
    processIds -
    
    Returns:
    
    An UpgradeResult whose contained ProcessUpgrade objects will be in the same order as the processIds parameter.
    
    Throws:
    
    InvalidProcessModelException - if the specified process model id does not exist
    
    InvalidVersionException - if the specified process model version does not exist
    
    PrivilegeException - if the user performing the action does not have sufficient privileges to view or initiate the specified process model
    
    InvalidStateException
    
    UpgradeException
  - upgradeProcesses
```
UpgradeResult upgradeProcesses(java.lang.Long toProcessModelId,
                               java.lang.String toVersion,
                               java.lang.Long fromProcessModelId,
                               java.lang.String[] fromVersions)
                        throws InvalidProcessModelException,
                               InvalidVersionException,
                               PrivilegeException,
                               InvalidStateException,
                               UpgradeException
```
    Attempts to upgrade the processes of the 'from' process model id and version to the 'to' process model id and version.
    
    Parameters:
    
    toProcessModelId - the id of the process model to upgrade to
    
    toVersion - the version of the process model to upgrade to, exactly as it appears in the user interface. For instance, "2.0" or "3.7"
    
    fromProcessModelId - the id of the process model to upgrade from
    
    fromVersions - the version of the process model to upgrade from
    
    Returns:
    
    An UpgradeResult whose contained ProcessUpgrade objects will be in no particular order.
    
    Throws:
    
    InvalidProcessModelException - if the process model id specified by 'toProcessModelId' does not exist
    
    InvalidVersionException - if the process model version specified by 'toVersion' does not exist
    
    PrivilegeException - if the user performing the action does not have sufficient privileges to view or initiate the specified process model
    
    InvalidStateException
    
    UpgradeException
  - triggerSchedule
```
void triggerSchedule(java.lang.Integer scheduleType_,
                     java.lang.Long scheduleId_)
              throws InvalidScheduleTypeException,
                     InvalidActivityException,
                     InvalidNodeException,
                     PrivilegeException,
                     InvalidStateException
```
    Triggers the schedule instance for the task or node
    
    Parameters:
    
    scheduleType_ - the schedule type. This should be one of ScheduleSummary.SCHEDULE_TYPE_PENDING_SINGLE , used for a delayed individual task, or ScheduleSummary.SCHEDULE_TYPE_PENDING_MULTIPLE, used for recurring tasks.
    
    scheduleId_ - the schedule ID. This is the ID of a ScheduleSummary retrieved from getScheduleSummariesForNode(Long, Long, int, int, Integer, Integer)
    
    Throws:
    
    InvalidScheduleTypeException - if the schedule type is invalid
    
    InvalidActivityException - if the schedule type is SCHEDULE_TYPE_PENDING_SINGLE, and the schedule ID does not correspond to a valid task
    
    InvalidNodeException - if the schedule type is SCHEDULE_TYPE_PENDING_MULTIPLE, and the schedule ID does not correspond to a valid node
    
    PrivilegeException - if the the user does not have sufficient permissions to perform this operation - that is, if ProcessPermissions.isModifyInFlight() would return false for the process in question.
    
    InvalidStateException - if the task delay has already passed, or if the task's status is TaskSummary.TASK_STATUS_CANCELLED
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    ScheduleSummary
  - triggerTaskEscalation
```
void triggerTaskEscalation(java.lang.Long activityId_,
                           java.lang.Long escalationId_)
                    throws InvalidActivityException,
                           InvalidStateException,
                           InvalidEscalationException,
                           PrivilegeException
```
    Triggers the desired escalation instance for the task.Users must obtain escalation id from TaskDetails object.
    
    Parameters:
    
    activityId_ - the id of the task
    
    escalationId_ - the id of the escalation
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    InvalidStateException - if the task has been completed, or cancelled, or if the escalation has already lapsed or the task has not yet been started
    
    InvalidEscalationException - if the escalation does not exist
    
    PrivilegeException - if the the user does not have sufficient - permissions to perform this operation
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    EscalationInstance
  - skipTaskEscalation
```
void skipTaskEscalation(java.lang.Long activityId_,
                        java.lang.Long escalationId_)
                 throws InvalidActivityException,
                        InvalidStateException,
                        InvalidEscalationException,
                        PrivilegeException
```
    Skips the desired escalation instance for the task
    
    Parameters:
    
    activityId_ - the id of the task
    
    escalationId_ - the id of the escalation
    
    Throws:
    
    InvalidActivityException - if the task does not exist
    
    InvalidStateException - if the task has been completed, or cancelled, or if the escalation has already lapsed
    
    InvalidEscalationException - if the escalation does not exist
    
    PrivilegeException - if NodePermissions.isModifyInFlight() is false for the current user
    
    See Also:
    
    EscalationInstance
  - getScheduleSummariesForNode
```
ResultPage getScheduleSummariesForNode(java.lang.Long processId_,
                                       java.lang.Long nodeId_,
                                       int startIndex_,
                                       int batchSize_,
                                       java.lang.Integer sortProperty_,
                                       java.lang.Integer sortOrder_)
                                throws InvalidNodeException,
                                       PrivilegeException,
                                       InvalidProcessException
```
    Gets Summaries of schedules that are attached to the node. This will include the schedules that once triggered will start one node, and schedules on nodes that have recurrence or spawning that once triggered will start multiple nodes.
    
    Parameters:
    
    processId_ - the ID of the process
    
    nodeId_ - the ID of the RuntimeProcessNode in the process
    
    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 ScheduleSummary
    
    sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
    
    Returns:
    
    ResultPage of ScheduleSummary objects; ResultPage contains an empty list of results if the node is not scheduled to spawn or recur, or if no spawns have occurred.
    
    Throws:
    
    InvalidNodeException - if the node does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    InvalidProcessException - if the process does not exist
    
    ServiceException - if any system-level error occurs
  - lockProcessModelForProcess
```
void lockProcessModelForProcess(java.lang.Long processId_,
                                boolean override_)
                         throws InvalidProcessException,
                                PrivilegeException,
                                LockException,
                                ArchivedProcessException,
                                InvalidStateException
```
    Locks the underlying process model of the specified process.
    
    Parameters:
    
    processId_ - the ID of the process
    
    override_ - true to override lock status, if the process model is already locked by another user
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    LockException - if the user cannot override the lock, if the process model is already currently locked
    
    ArchivedProcessException - if the process is archived
    
    InvalidStateException
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    unlockProcessModelForProcess(java.lang.Long, boolean)
  - lockProcesses
```
int[] lockProcesses(java.lang.Long[] processIds,
                    boolean override)
```
    Attempts to lock the specified processes.
    
    Parameters:
    
    processIds - the ids of the processes to be locked
    
    override - true to override lock status, if the process is already locked by another user
  - unlockProcesses
```
int[] unlockProcesses(java.lang.Long[] processIds,
                      boolean override)
```
    Attempts to unlock the specified processes.
    
    Parameters:
    
    processIds - the ids of the processes to be unlocked
    
    override - true to override lock status, if the process is locked by another user
  - unlockProcessModelForProcess
```
void unlockProcessModelForProcess(java.lang.Long processId_,
                                  boolean override_)
                           throws InvalidProcessException,
                                  PrivilegeException,
                                  LockException
```
    Unlocks the underlying process model for the process
    
    Parameters:
    
    processId_ - the id of the process
    
    override_ - true to override lock status, if the process model is locked by another user
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    ServiceException - if any system-level error occurs
    
    LockException - if the user cannot override the lock, if the process model is already currently locked
    
    See Also:
    
    lockProcessModelForProcess(java.lang.Long, boolean)
  - unlockProcessModels
```
void unlockProcessModels()
```
    Unlocks all process models locked by the current user.
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - getMaximumNumberOfNotes
```
int getMaximumNumberOfNotes()
```
    Returns the Maximum number of notes that can be added to Process or Task
    
    Returns:
    
    Maximum number of notes.
  - getMaximumNumberOfAttachments
```
int getMaximumNumberOfAttachments()
```
    Returns the Maximum number of attachmnets that can be added to Process or Task
    
    Returns:
    
    Maximum number of attachments.
  - skipRecurrence
```
RecurrenceInstance skipRecurrence(java.lang.Long processId_,
                                  java.lang.Long nodeId_,
                                  java.lang.Long recurrenceNumber_)
                           throws InvalidProcessException,
                                  InvalidStateException,
                                  PrivilegeException,
                                  InvalidNodeException
```
    Skips the recurrence instance of the given node
    
    Parameters:
    
    processId_ - process which the node resides in
    
    nodeId_ - id of the node to skip the next recurrence of
    
    recurrenceNumber_ - which recurrence to skip. For each node, the recurrences are numbered starting at 0. The next recurrence number can be obtained by calling getNextRecurrence(Long,Long)
    
    Returns:
    
    RecurrenceInstance with id and scheduledTime populated
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    InvalidNodeException - if the node template does not exist
    
    InvalidStateException - if the node does not have an recurrence instance, the recurrence has passed or the node has not been reached, or if the recurrence being skipped is not the next recurrence.
    
    PrivilegeException - if the user does not have privileges
    
    See Also:
    
    Recurrence
  - triggerRecurrence
```
RecurrenceInstance triggerRecurrence(java.lang.Long processId_,
                                     java.lang.Long nodeId_,
                                     java.lang.Long recurrenceNumber_)
                              throws InvalidProcessException,
                                     InvalidStateException,
                                     PrivilegeException,
                                     InvalidNodeException
```
    Triggers the recurrence instance of the given node
    
    Parameters:
    
    processId_ - process which the node resides in
    
    nodeId_ - ID of the RuntimeProcessNode to skip the next recurrence of
    
    recurrenceNumber_ - the recurrence of the node to skip. For each node, the recurrences are numbered starting at 0. The next recurrence number is the ID of the RecurrenceInstance obtained by calling getNextRecurrence(Long,Long), with parameters processId_ and nodeId_
    
    Returns:
    
    recurrence instance with id and scheduledTime populated
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    InvalidStateException - if the node does not have recurrences, the recurrence being skipped is not the next recurrence, the recurrence has already passed or has not been reached.
    
    InvalidNodeException - if the node template does not exist
    
    PrivilegeException - if the user does not have privileges. That is if NodePermissions.isModifyInFlight() is false
    
    See Also:
    
    Recurrence
  - setTaskStateSubmitted
```
void setTaskStateSubmitted(java.lang.Long taskId_)
                    throws PrivilegeException,
                           InvalidActivityException
```
    Sets the Task in the 'Submitted' state. This means that the activity is sent to run asynchronously. The user must accept the task in order to use this method succesfully.
    
    Parameters:
    
    taskId_ - Id of the Task that is sumitted.
    
    Throws:
    
    PrivilegeException - if the user cannot complete the task or is not the task owner of attended task.
    
    InvalidActivityException - if the task does not exist.
  - keepSubmittedTasksAlive
```
void keepSubmittedTasksAlive(java.lang.Long[] activities_)
                      throws PrivilegeException,
                             InvalidActivityException
```
    This method informs the Process Engine that the specified tasks are still in the queue, waiting to be executed asynchronously.
    
    Parameters:
    
    activities_ - ID's of the tasks that are in the queue
    
    Throws:
    
    PrivilegeException - if the user cannot complete the task or is not the task owner of any attended tasks in the list.
    
    InvalidActivityException - if any task does not exist
    
    ServiceException - if any system-level error occurs
  - setTaskStateRunning
```
void setTaskStateRunning(java.lang.Long taskId_)
                  throws PrivilegeException,
                         InvalidActivityException
```
    Sets the Task in the Running state. This informs the process engine that the Task is removed from the queue and is currently being executed. The user must accept the task in order to use this method succesfully.
    
    Parameters:
    
    taskId_ - Id of the task that Running
    
    Throws:
    
    PrivilegeException - if the user cannot complete the task or is not the task owner of attended task.
    
    InvalidActivityException - if the task does not exist.
  - getCurrentTasksForProcess
```
ResultPage getCurrentTasksForProcess(java.lang.Long processId_,
                                     int type_,
                                     int startIndex_,
                                     int batchSize_,
                                     java.lang.Integer sortProperty_,
                                     java.lang.Integer sortOrder_)
                              throws InvalidProcessException,
                                     PrivilegeException
```
    Gets the current tasks for a process
    Parameters:
    
    processId_ - the ID of the process
    type_ - type of tasks to return. This is one of:
    
    Unattended Tasks - UNATTENDED_TASKS
    
    Attended Tasks - ATTENDED_TASKS
    
    Unattended and Attended Tasks - UNATTENDED_AND_ATTENDED_TASKS
    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 TaskSummary
    
    sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
    
    Returns:
    
    ResultPage of TaskSummary objects.
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    ServiceException - if any system-level error occurs
  - getCompletedTasksForProcess
```
ResultPage getCompletedTasksForProcess(java.lang.Long processId_,
                                       int type_,
                                       int startIndex_,
                                       int batchSize_,
                                       java.lang.Integer sortProperty_,
                                       java.lang.Integer sortOrder_)
                                throws InvalidProcessException,
                                       PrivilegeException
```
    Gets the completed tasks for a process
    Parameters:
    
    processId_ - the ID of the process
    type_ - type of tasks to returnThis is one of:
    
    Unattended Tasks - UNATTENDED_TASKS
    
    Attended Tasks - ATTENDED_TASKS
    
    Unattended and Attended Tasks - UNATTENDED_AND_ATTENDED_TASKS
    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 TaskSummary
    
    sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
    
    Returns:
    
    ResultPage of TaskSummary objects. If a task is completed then its assignees field will be an empty array.
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    ServiceException - if any system-level error occurs
  - getCancelledTasksForProcess
```
ResultPage getCancelledTasksForProcess(java.lang.Long processId_,
                                       int type_,
                                       int startIndex_,
                                       int batchSize_,
                                       java.lang.Integer sortProperty_,
                                       java.lang.Integer sortOrder_)
                                throws InvalidProcessException,
                                       PrivilegeException
```
    Gets the cancelled tasks for a process
    Parameters:
    
    processId_ - the ID of the process
    type_ - type of tasks to returnThis is one of:
    
    Unattended Tasks - UNATTENDED_TASKS
    
    Attended Tasks - ATTENDED_TASKS
    
    Unattended and Attended Tasks - UNATTENDED_AND_ATTENDED_TASKS
    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 TaskSummary
    
    sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
    
    Returns:
    
    ResultPage of TaskSummary objects.
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    ServiceException - if any system-level error occurs
  - getPausedTasksForProcess
```
ResultPage getPausedTasksForProcess(java.lang.Long processId_,
                                    int type_,
                                    int startIndex_,
                                    int batchSize_,
                                    java.lang.Integer sortProperty_,
                                    java.lang.Integer sortOrder_)
                             throws InvalidProcessException,
                                    PrivilegeException
```
    Gets the paused tasks for a process
    Parameters:
    
    processId_ - the ID of the process
    type_ - type of tasks to returnThis is one of:
    
    Unattended Tasks - UNATTENDED_TASKS
    
    Attended Tasks - ATTENDED_TASKS
    
    Unattended and Attended Tasks - UNATTENDED_AND_ATTENDED_TASKS
    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 TaskSummary
    
    sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
    
    Returns:
    
    ResultPage of TaskSummary objects.
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this action
    
    ServiceException - if any system-level error occurs
  - getTasksWithExceptionsForProcess
```
ResultPage getTasksWithExceptionsForProcess(java.lang.Long processId_,
                                            int startIndex_,
                                            int batchSize_,
                                            java.lang.Integer sortProperty_,
                                            java.lang.Integer sortOrder_)
                                     throws InvalidProcessException,
                                            PrivilegeException
```
    Gets the tasks that are paused by exception for a specified process.
    
    Parameters:
    
    processId_ - the ID of the process
    
    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 TaskSummary defined in this file.
    
    sortOrder_ - The order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    Returns a ResultPage containing instances of TaskSummary. If a task is completed then its assignees field will be an empty array.
    
    Throws:
    
    InvalidProcessException - if no process with the specified id exists.
    
    PrivilegeException - if the user does not have permissions to view the task summaries for the process.
    
    ServiceException - if any system-level error occurs
  - unarchiveProcess
```
void unarchiveProcess(java.lang.Long processId_)
               throws InvalidProcessException,
                      InvalidStateException,
                      IncompatibleArchivedVersionException,
                      PrivilegeException,
                      com.appiancorp.process.engine.ArchiveReadException
```
    Bring all process data back to memory. An archived process (whether it has been archived automatically or manually) needs to be unarchived before any action can be performed on it.
    
    Parameters:
    
    processId_ - the id of the process to unarchive
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    InvalidStateException - if the process has not been archived
    
    IncompatibleArchivedVersionException - if an archived process file is from an incompatible release version
    
    PrivilegeException - if the current User does not have permission to unarchive the process. Use ProcessDesignService.getPermissionsForProcessApplication() to determine if the User has permission to unarchive processes.
    
    ServiceException - if any system-level error occurs
    
    com.appiancorp.process.engine.ArchiveReadException
  - unarchiveProcesses
```
java.lang.Integer[] unarchiveProcesses(java.lang.Long[] processIds_)
                                throws PrivilegeException
```
    Bring all process data back to memory. An archived process (whether it has been archived automatically or manually) needs to be unarchived before any action can be performed on it.
    
    Parameters:
    
    processIds_ - the ids of the processes to archive
    
    Returns:
    
    result codes, which can be: ResultList.CODE_VALID if the action succeeded, or ResultList.CODE_INVALID if the specified process does not exist
    
    Throws:
    
    PrivilegeException - if the user does not have permissions to unarchive processes
    
    ServiceException - if any system-level error occurs
  - archiveProcess
```
void archiveProcess(java.lang.Long processId_)
             throws InvalidProcessException,
                    PrivilegeException,
                    InvalidStateException,
                    ArchivedProcessException
```
    Archive the process with the given id. This will be performed synchronously if possible, or queue the archive request along with automatically achived processes otherwise (e.g., if out of disk space).
    
    Parameters:
    
    processId_ - the id of a process to archive
    
    Throws:
    
    InvalidProcessException - if the process does not exist
    
    ArchivedProcessException - if the process is already archived
    
    PrivilegeException - if the user does not have the privileges.
    
    InvalidStateException - if process is not completed or canceled (only completed or canceled process can be archived)
    
    ServiceException - if any system-level error occurs
  - archiveProcesses
```
java.lang.Integer[] archiveProcesses(java.lang.Long[] processIds_)
```
    Manually archive the processes with the given ids.
    
    Parameters:
    
    processIds_ - the ids of a processes to archive
    
    Returns:
    
    result codes, which 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 does not exist (only completed or canceled process can be archived)
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - getArchivePaths
```
java.lang.String[] getArchivePaths()
```
    Retrieve the paths where archived processes are stored. Note: This method only retrieves the paths to which processes are currently archived. It does not retrieve paths to old archived processes.
    
    Returns:
    
    The paths where processes are currently archived.
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - setArchivePaths
```
void setArchivePaths(java.lang.String[] archivePaths)
              throws PrivilegeException
```
    Set the paths where archived processes will be stored.
    
    Parameters:
    
    archivePaths - The paths where archived processes will be stored.
    
    Throws:
    
    PrivilegeException - if the current user does not have privileges to change the paths. Normally this only includes system admins.
    
    ServiceException - if any system-level error occurs
    
    See Also:
    
    getArchivePaths()
  - getNextRecurrence
```
RecurrenceInstance getNextRecurrence(java.lang.Long processId_,
                                     java.lang.Long nodeId_)
                              throws InvalidProcessException,
                                     InvalidNodeException,
                                     PrivilegeException
```
    Gets the next recurrence for a node within a process
    
    Parameters:
    
    processId_ - the id of the process to get the recurrence for
    
    nodeId_ - the node to get the recurrence for
    
    Returns:
    
    a RecurrenceInstance of the given node for the given proecss id
    
    Throws:
    
    InvalidProcessException - If the process does not exist
    
    InvalidNodeException - if the node is invalid
    
    PrivilegeException - If the user does not have permissions to the process - if ProcessPermissions.isModifyInFlight() returns false
    
    ServiceException - if any system-level error occurs
  - getAttachmentsInProcess
```
ResultList getAttachmentsInProcess(java.lang.Long processId_,
                                   java.lang.Long[] attachmentIds_)
                            throws InvalidProcessException
```
    Gets the specified attachments associated with a given process, or tasks in this process
    
    Parameters:
    
    processId_ - the id of the process
    
    attachmentIds_ - the unique Ids of the attachments to be retrieved
    
    Returns:
    
    a ResultList containing an array of Attachment objects
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    ServiceException - if any system-level error occurs
  - getNoteMetadatasInProcess
```
ResultList getNoteMetadatasInProcess(java.lang.Long processId_,
                                     java.lang.Long[] noteIds_)
                              throws InvalidProcessException
```
    Gets the specified notes associated with a given process, or tasks in this process
    
    Parameters:
    
    processId_ - the id of the process
    
    noteIds_ - the unique Ids of the notes to be retrieved
    
    Returns:
    
    a ResultList containing an array of NoteMetadata objects
    
    Throws:
    
    InvalidProcessException - if the process specified does not exist
    
    ServiceException - if any system-level error occurs
  - updateUsernames
```
@Deprecated
void updateUsernames(java.lang.String[] oldUsernames_,
                                 java.lang.String[] newUsernames_,
                                 long maxExpirationTimeInSeconds_)
                          throws java.lang.IllegalArgumentException,
                                 DuplicateNameException,
                                 PrivilegeException
```
    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:
    
    java.lang.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
    
    PrivilegeException - if the current User does not have permission to update usernames, as determined by ProcessDesignService.getSecurityForProcessApplication().
    
    ServiceException - if any system-level error occurs
  - commitUpdateUsernames
```
@Deprecated
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.
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - rollbackUpdateUsernames
```
@Deprecated
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.
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - uncompleteActivity
```
ActivityExecutionMetadata uncompleteActivity(java.lang.Long activityId_)
                                      throws InvalidStateException,
                                             PrivilegeException,
                                             InvalidActivityException
```
    Changes the status of an activity to ACCEPTED or ASSIGNED. If the activity is in ACCEPTED or ASSIGNED state, then the status is unchanged. If the activity is in COMPLETED state, then status becomes ACCEPTED.
    
    Parameters:
    
    activityId_ - the id of the activity to uncomplete.
    
    Throws:
    
    InvalidStateException - if the activity in question is in a state other than ACCEPTED, ASSIGNED OR COMPLETED. Also if the process that this task is part off, is paused by exception and the API is invoked.
    
    PrivilegeException - if the current user does not have permission to perform this action
    
    java.lang.NullPointerException - if activityId_ is null
    
    InvalidActivityException - if activityId_ is invalid (i.e. refers to an activity that does not exist)
    
    java.lang.IllegalArgumentException - if the activity is unattended (such activities are not allowed to be uncompleted, since they would automatically recomplete with the same behavior).
  - setApplicationAdministratorGroup
```
void setApplicationAdministratorGroup(java.lang.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
    
    ServiceException - if any system-level error occurs
  - reloadProperties
```
@Deprecated
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
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - validate
```
java.lang.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
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - setSiteLocaleSettings
```
void setSiteLocaleSettings(SiteLocaleSettings settings_)
```
    Registers the site locale settings on the process execution server.
    
    Parameters:
    
    settings_ - The site locale settings.
  - handleMessages
```
int[] handleMessages(InternalMessage[] messages_)
```
    Sends messages to the execution server, to be handled by the events framework. Returns result codes. The result codes can be:
    - Message.SUCCESS_CODE if there are no problems
    - Message.JMS_TYPE_NOT_PROVIDED_CODE
    - Message.INVALID_USERNAME_CODE if the username is invalid. A null username is valid; the system will assume an anonymous user.
    - Message.DESTINATION_NOT_PROVIDED_CODE
    - Message.DUPLICATE_MESSAGE_CODE
    Parameters:
    
    messages_ - The messages to send to the execution server
    
    Returns:
    
    the result codes
    
    Throws:
    
    java.lang.NullPointerException - if any element in messages_ is null or if messages_ itself is null
    
    ServiceException - if any system-level error occurs
  - acknowledgeMessages
```
@Deprecated
void acknowledgeMessages(java.lang.Long[] messageIds_)
```
    Deprecated. replaced by work queue, no longer requires separate acknowledgement: call does nothing now
    
    Certain events spawn messages (which are beans that contain a message body for the user to read, among other properties). The recipient server can send this call back to the sending server on receipt of a set of messages. It is up to the sending server what to do with the callback.
    
    Parameters:
    
    messageIds_ - The IDs of a set of messages
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - getPmIdForProcess
```
java.lang.Long getPmIdForProcess(java.lang.Long processId_)
                          throws InvalidProcessException
```
    Get the specified Process's Process Model's ID
    
    Parameters:
    
    processId_ - the ID of the process
    
    Throws:
    
    InvalidProcessException - if the process ID refers to a process that does not exist
    
    ServiceException - if any system-level error occurs
  - addProcessToFavorites
```
void addProcessToFavorites(java.lang.Long processId_)
                    throws InvalidProcessException,
                           PrivilegeException
```
    Adds a Process to the user's favorites list.
    
    Parameters:
    
    processId_ - Id of the Process to be added.
    
    Throws:
    
    InvalidProcessException - if the Process specified does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action on the specified Process
    
    java.lang.NullPointerException - if processId_ is null
    
    ServiceException - if any system-level error occurs
  - removeProcessFromFavorites
```
void removeProcessFromFavorites(java.lang.Long processId_)
                         throws InvalidProcessException
```
    Removes a process from the user's Favorite's list
    
    Parameters:
    
    processId_ - The ID of the process to remove from favorites.
    
    Throws:
    
    InvalidProcessException - if the process does not exist.
  - addTaskToFavorites
```
void addTaskToFavorites(java.lang.Long taskId_)
                 throws InvalidActivityException,
                        PrivilegeException
```
    Adds a Task to the user's favorites list.
    
    Parameters:
    
    taskId_ - Id of the task to be added.
    
    Throws:
    
    InvalidActivityException - if the activity specified does not exist
    
    PrivilegeException - if the current user does not have permission to perform this action on the specified activity
    
    java.lang.NullPointerException - if taskId_ is null
    
    ServiceException - if any system-level error occurs
  - removeTaskFromFavorites
```
void removeTaskFromFavorites(java.lang.Long taskId_)
                      throws InvalidActivityException
```
    Removes a task from the user's Favorite's list
    
    Parameters:
    
    processId_ - The ID of the task to remove from favorites.
    
    Throws:
    
    InvalidActivityException - if the task does not exist.
  - setDashboardPageForProcesses
```
@Deprecated
void setDashboardPageForProcesses(java.lang.Long processModelId,
                                              java.lang.Long pageId)
                                       throws InvalidProcessException,
                                              PrivilegeException
```
    Deprecated. Use ProcessDesignService.setProcessDashboardPageForProcessModel(Long, Long) instead.
    
    Sets a particular page as the dashboard for every instance of a given process model.
    
    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:
    
    InvalidProcessException - if the process model does not exist.
    
    PrivilegeException - if the user does not have access to perform this operation.
  - removeDashboardPageForProcesses
```
@Deprecated
void removeDashboardPageForProcesses(java.lang.Long processModelId)
                                          throws InvalidProcessException,
                                                 PrivilegeException
```
    Deprecated. Use ProcessDesignService.removeProcessDashboardPageForProcessModel(Long) instead.
    
    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:
    
    InvalidProcessException - if the Process Model does not exist
    
    PrivilegeException - if the current user does not have access to perform this operation
    
    ServiceException - if any system-level error occurs
  - getAutoArchiveProperties
```
java.util.Map getAutoArchiveProperties()
```
    Retrieves auto archive properties from the backend
    
    Returns:
    
    a map containing "autoArchive" and "autoArchiveDelay"
  - getMemoryUsageForExecEngine
```
SizingReport getMemoryUsageForExecEngine()
                                  throws PrivilegeException
```
    Returns the SizingReport which contains top-level summary of memory usage by various objects in all Execution Engines.
    
    Returns:
    
    SizingReport
    
    Throws:
    
    PrivilegeException - if the current user does not have access to perform this operation
    
    See Also:
    
    SizingReport
  - getMemoryUsageForProcessModels
```
SizingReport getMemoryUsageForProcessModels(java.lang.Long[] processModelIds_)
                                     throws PrivilegeException
```
    Returns the SizingReport which contains a breakdown of memory usage by all process instances based off of specific Process Models given by the Process Model IDs.
    
    Parameters:
    
    processModelIDs - the ids of the process models
    
    Returns:
    
    SizingReport
    
    Throws:
    
    PrivilegeException - if the current user does not have access to perform this operation
    
    See Also:
    
    SizingReport
  - getMemoryUsageForProcessModelsByUUID
```
SizingReport getMemoryUsageForProcessModelsByUUID(java.lang.String[] processModelUUIDs_)
                                           throws PrivilegeException
```
    Returns the SizingReport which contains a breakdown of memory usage by all process instances based off of specific Process Models given by Process Model UUIDs.
    
    Parameters:
    
    processModelUUIDs - the process podel UUIDs
    
    Returns:
    
    SizingReport
    
    Throws:
    
    PrivilegeException - if the current user does not have access to perform this operation
    
    See Also:
    
    SizingReport
  - getMemoryUsageForProcesses
```
SizingReport getMemoryUsageForProcesses(java.lang.Long[] processIds_)
                                 throws PrivilegeException,
                                        InvalidProcessException
```
    Returns the SizingReport which contains a breakdown of memory usage by individual process instances
    
    Parameters:
    
    processIDs - ID's of process instances.
    
    Returns:
    
    SizingReport
    
    Throws:
    
    PrivilegeException - if the current user does not have access to perform this operation
    
    InvalidProcessException - If any of the processes do not exist
    
    See Also:
    
    SizingReport
  - getMemoryUsageForProcessesByModelUUID
```
SizingReport getMemoryUsageForProcessesByModelUUID(java.lang.String[] processModelUUIDs_)
                                            throws PrivilegeException
```
    Returns the SizingReport which contains a breakdown of memory usage by individual process instances based of of specific Process Models given by Process Model UUIDs.
    
    Parameters:
    
    processModelUUIDs - UUID's of process models
    
    Returns:
    
    SizingReport
    
    Throws:
    
    PrivilegeException - if the current user does not have access to perform this operation
    
    See Also:
    
    SizingReport
  - getMemoryUsageForNodesInProcesses
```
SizingReport getMemoryUsageForNodesInProcesses(java.lang.Long[] processIds_)
                                        throws PrivilegeException,
                                               InvalidProcessException
```
    Returns the SizingReport which contains a breakdown of memory usage by individual nodes/activities in specific Process instances.
    
    Parameters:
    
    processIDs - ID's of process instances
    
    Returns:
    
    SizingReport
    
    Throws:
    
    PrivilegeException - if the current user does not have access to perform this operation
    
    InvalidProcessException - If any of the processes do not exist
    
    See Also:
    
    SizingReport
  - setTimeZone
```
void setTimeZone(BackendTimeZoneSimple tz)
```
    Set the time zone information using the format used by the engines to encapsulate time zone information. This method sets the time zone for the process execution engines only. NOTE: Using this method could lead to data inconsistency, use GlobalizationService.setTimeZone(com.appiancorp.suiteapi.portal.BackendTimeZoneSimple) to set the time zone across all engines (rarely required).
    
    Parameters:
    
    tz - The specially formatted time zone object used by the engines
  - setTimeZoneSameAs
```
@Deprecated
void setTimeZoneSameAs(BackendTimeZoneSimple tz,
                                   java.lang.String sameAsId)
```
    Deprecated. this method will be removed in a future release
    
    Set a backend timezone to have the same rules as another backend timezone the sameAsId.
    
    Parameters:
    
    tz -
    
    sameAsId -
  - getProcessHistoryRecords
```
HistoryRecord[] getProcessHistoryRecords(java.lang.Long processId_)
                                  throws PrivilegeException,
                                         InvalidProcessException
```
    Get the process history record of the given process.
    
    Parameters:
    
    processId_ -
    
    Throws:
    
    InvalidProcessException - If no such process exists.
    
    PrivilegeException - If the user does not have access to retrieve the process history for the specified process.
    
    ServiceException - if any system-level error occurs
  - getProcessHistoryRecordsPaging
```
ResultPage getProcessHistoryRecordsPaging(java.lang.Long processId_,
                                          int startIndex_,
                                          int batchSize_,
                                          java.lang.Integer sortProperty_,
                                          java.lang.Integer sortOrder_)
                                   throws PrivilegeException,
                                          InvalidProcessException
```
    Get the process history record of the given process.
    
    Parameters:
    
    processId_ - The id of the process.
    
    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 HistoryRecord
    
    sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
    
    Returns:
    
    a ResultPage containing the variables for the process.
    
    Throws:
    
    InvalidProcessException - If no such process exists.
    
    PrivilegeException - If the user does not have access to retrieve the process history for the specified process.
    
    ServiceException - if any system-level error occurs
  - getTasksWithStatusForProcessModel
```
ResultPage getTasksWithStatusForProcessModel(java.lang.Long processModelId_,
                                             java.lang.Integer taskStatus_,
                                             boolean recursive_,
                                             int startIndex_,
                                             int batchSize_)
                                      throws PrivilegeException
```
    Get the pages of tasks, within a particular process model, currently in a given state.
    
    Parameters:
    
    processModelId_ - The process model id to scan for tasks within.
    
    taskStatus_ - Retrieve tasks currently with this status number, see TaskSummary.TASK_STATUS_PAUSED_BY_EXCEPTION, etc.
    
    recursive_ - Set to true to retrieve tasks from subprocesses as well.
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The maximum number of results to return in the result page. use of Constants.COUNT_ALL will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    Returns:
    
    A ResultPage containing TaskSummary objects representing tasks that have the given status, from processes of the specified Process Model
    
    Throws:
    
    PrivilegeException
  - getTasksWithStatusForProcessModels
```
ResultPage getTasksWithStatusForProcessModels(java.lang.Long[] processModelIds_,
                                              java.lang.Integer taskStatus_,
                                              boolean recursive_,
                                              int startIndex_,
                                              int batchSize_)
                                       throws PrivilegeException
```
    Get the pages of tasks, within any of particular process models, currently in a given state.
    
    Parameters:
    
    processModelIds_ - The process model ids to scan for. As this is scanning for matches, a lack of matches will simply be indicated by a lack of results;.
    
    taskStatus_ - Retrieve tasks currently with this status number, see TaskSummary.TASK_STATUS_PAUSED_BY_EXCEPTION, etc.
    
    recursive_ - Set to true to retrieve tasks from subprocesses as well.
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The maximum number of results to return in the result page. use of Constants.COUNT_ALL will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    Returns:
    
    A ResultPage containing TaskSummary objects representing tasks that have the given status, from processes of the specified Process Models
    
    Throws:
    
    PrivilegeException
  - getTasksWithStatusForProcess
```
ResultPage getTasksWithStatusForProcess(java.lang.Long processId_,
                                        java.lang.Integer taskStatus_,
                                        boolean recursive_,
                                        int startIndex_,
                                        int batchSize_,
                                        java.lang.Integer sortProperty_,
                                        java.lang.Integer sortOrder_)
                                 throws InvalidProcessException,
                                        PrivilegeException
```
    Get the pages of tasks, within a particular process or its subprocesses, currently in a given state.
    
    Parameters:
    
    processId_ - The process id containing the tasks to be examined.
    
    taskStatus_ - Retrieve tasks currently with this status number, see TaskSummary.TASK_STATUS_PAUSED_BY_EXCEPTION, etc.
    
    recursive_ - Set to true to retrieve tasks from subprocesses as well.
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The maximum number of results to return in the result page. 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 TaskSummary
    
    sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order
    
    Returns:
    
    A ResultPage containing TaskSummary objects representing tasks that have the given status from the specified process
    
    Throws:
    
    InvalidProcessException
    
    PrivilegeException
  - getTasksWithStatusForProcesses
```
ResultPage getTasksWithStatusForProcesses(java.lang.Long[] processIds_,
                                          java.lang.Integer taskStatus_,
                                          boolean recursive_,
                                          int startIndex_,
                                          int batchSize_)
                                   throws InvalidProcessException,
                                          PrivilegeException
```
    Get the pages of tasks, within particular processes or their subprocesses, currently in a given state.
    
    Parameters:
    
    processIds_ - The ids of the processes to be examined.
    
    taskStatus_ - Retrieve tasks currently with this status number, see TaskSummary.TASK_STATUS_PAUSED_BY_EXCEPTION, etc.
    
    recursive_ - Set to true to retrieve tasks from subprocesses as well.
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The maximum number of results to return in the result page. use of Constants.COUNT_ALL will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    Returns:
    
    A ResultPage containing TaskSummary objects representing tasks that have the given status from the specified processes
    
    Throws:
    
    InvalidProcessException
    
    PrivilegeException
  - completeStore
```
void completeStore(java.lang.Long expressionGroupId)
            throws InvalidExpressionGroupException
```
    Complete an external data store. The task must be in the expected state, waiting on external.
    
    Parameters:
    
    expressionGroupId -
    
    Throws:
    
    InvalidExpressionGroupException
  - cancelStore
```
void cancelStore(java.lang.Long expressionGroupId,
                 java.lang.String cancelMessage)
          throws InvalidExpressionGroupException
```
    Cancel an external data store. The task must be in the expected state, waiting on external.
    
    Parameters:
    
    expressionGroupId -
    
    cancelMessage - the text message to give as an error
    
    Throws:
    
    InvalidExpressionGroupException
  - processToNextAttended
```
void processToNextAttended(java.lang.Long activityId,
                           boolean isQuickTask,
                           ActivityClassParameter[] parameters)
                    throws InvalidProcessModelException,
                           InvalidPriorityException,
                           PrivilegeException,
                           InvalidStateException,
                           StorageLimitException,
                           InvalidUserException,
                           java.lang.IllegalArgumentException,
                           InvalidActivityException,
                           InvalidActivityClassParameterException,
                           InvalidExpressionException,
                           TaskNavigationException
```
    This method can be used to programatically execute an attended task and continue flow to the next attended activity. This method will repeatedly advance the process flow and execute unattended activities until an attended activity is reached.
    This method replaces the deprecated method ProcessEngineService.processToNextAttended(com.appiancorp.process.engine.ProcessActionResponse).
    
    Parameters:
    
    activityId - the task activity id of the current activity to execute
    
    isQuickTask - whether or not the current activity is a quick task
    
    parameters - the parameter values to use when executing the current activity
    
    Throws:
    
    InvalidProcessModelException - if the related process model is invalid
    
    InvalidPriorityException - if the related task priority does not exist
    
    PrivilegeException - if the user does not have sufficient privileges to perform this operation
    
    InvalidStateException - if the process or task is cancelled
    
    StorageLimitException - if all execution engines are full
    
    InvalidUserException - if any of the users referenced do not exist
    
    java.lang.IllegalArgumentException - if the given task is not attended
    
    InvalidActivityException - if an activity id is invalid
    
    InvalidActivityClassParameterException - if an ActivityClassParameter provided does not exist
    
    InvalidExpressionException - if a referenced expression does not exist
    
    TaskNavigationException - if the given activityId would illegally send the process flow back to a previous task

Interface ProcessExecutionService

Field Summary

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

Method Summary

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

Field Detail

TASK_ACCEPTANCE_SUCCESS

TASK_ACCEPTANCE_ACCEPTED_BY_ANOTHER

TASK_ACCEPTANCE_INVALID_STATE

TASK_ACCEPTANCE_NOT_ASSIGNEE

TASK_ACCEPTANCE_PROCESS_PAUSED

TASK_ACCEPTANCE_PAUSED

TASK_ACCEPTANCE_NOT_ASSIGNEE_CAN_COMPLETE

TASK_PRIVILEGE_REJECT_ONLY

TASK_PRIVILEGE_REASSIGN_WITHIN_POOL

TASK_PRIVILEGE_REASSIGN_ANY

TASK_REJECTION_RESULT_SUCCESS

TASK_REJECTION_RESULT_INVALID_STATE

TASK_REJECTION_RESULT_NOT_OWNER

PROCESS_CANCELLATION_SUCCESS

PROCESS_CANCELLATION_INVALID_PROCESS

PROCESS_CANCELLATION_INSUFFICIENT_PRIVILEGES

PROCESS_CANCELLATION_INVALID_STATE

PROCESS_CANCELLATION_LOCKED_PROCESS

TASK_CANCELLATION_SUCCESS

TASK_CANCELLATION_INVALID_TASK

TASK_CANCELLATION_INSUFFICIENT_PRIVILEGES

TASK_CANCELLATION_INVALID_STATE

NOTE_CREATION_PROCESS_INVALID_BEAN

NOTE_CREATION_PROCESS_CANCELLED

NOTE_CREATION_PROCESS_NOTE_LIMIT_EXCEEDED

NOTE_CREATION_PROCESS_INVALID

NOTE_CREATION_PROCESS_INSUFFICIENT_PRIVILEGES

NOTE_CREATION_PROCESS_SUCCESS

NOTE_CREATION_TASK_INVALID_BEAN

NOTE_CREATION_TASK_UNATTENDED

NOTE_CREATION_TASK_CANCELLED

NOTE_CREATION_TASK_NOTE_LIMIT_EXCEEDED

NOTE_CREATION_TASK_INVALID

NOTE_CREATION_TASK_INSUFFICIENT_PRIVILEGES

NOTE_CREATION_TASK_SUCCESS

NOTE_DELETION_INVALID

NOTE_DELETION_INSUFFICIENT_PRIVILEGES

NOTE_DELETION_SUCCESS

ACTIVITY_VALID

ACTIVITY_PROCESS_CANCELLED

ACTIVITY_PROCESS_COMPLETED

ACTIVITY_PROCESS_DELETED

ACTIVITY_COMPLETED

ACTIVITY_PROCESS_PAUSED

ACTIVITY_PAUSED

ACTIVITY_CANCELLED

ACTIVITY_INVALID_STATE

ACTIVITY_SKIPPED

ACTIVITY_WAITING

RESULT_CODE_RECURRING_TASK

RESULT_CODE_TOO_MANY_INSTANCES

RESULT_CODE_SUCCESS

RESULT_CODE_INVALID_PROCESS

RESULT_CODE_INSUFFICIENT_PRIVILEGES

RESULT_CODE_INVALID_STATE

RESULT_CODE_INVALID_OPERATION

RESULT_CODE_INVALID_TASK

RESULT_CODE_LOCK_EXCEPTION

RESULT_CODE_LOGIC_NODE

RESULT_CODE_INVALID_NODE

RESULT_CODE_NODE_MULTIPLICITY

RESULT_CODE_NODE_CANNOT_PAUSE

ATTACHMENT_RETURN_TASK_UNATTENDED

ATTACHMENT_RETURN_TASK_CANCELLED

ATTACHMENT_RETURN_PROCESS_CANCELLED

ATTACHMENT_RETURN_TOO_MANY

ATTACHMENT_RETURN_INVALID

ATTACHMENT_RETURN_PERMISSIONS

ATTACHMENT_RETURN_SUCCESS

NOTES_RETURN_INVALID

NOTES_RETURN_PERMISSIONS

NOTES_RETURN_SUCCESS

UNATTENDED_TASKS

ATTENDED_TASKS