Package com.appiancorp.suiteapi.process
Interface ProcessExecutionService
- 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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final booleanstatic final booleanstatic final booleanstatic final intA constant indicating that an activity has been cancelledstatic final intA constant indicating that an activity is in an invalid state.static final intA constant indicating that an activity is in an invalid statestatic final intA constant indicating that an activity has been pausedstatic final intA constant indicating that an activity exists in a process that has been cancelledstatic final intA constant indicating that an activity exists in a process that has been completedstatic final intA constant indicating that an activity has been deleted, since its parent process has been deletedstatic final intA constant indicating that the process for an activity is pausedstatic final intA constant indicating that an activity has been skipped by an exception flow.static final intA constant indicating that an activity is valid.static final intA constant indicating that an activity is waiting on an asynchronous workq item in Java.static final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final IntegerResult code indicating that an attachment may not be added/removed because the specified process, task, or attachment does not existstatic final IntegerResult code indicating that an attachment may not be added/removed because the user does not have permission to do sostatic final IntegerResult code indicating that an attachment may not be added to the process because the process was cancelledstatic final IntegerReturn code indicating that adding an attachment was successfulstatic final IntegerResult code indicating that an attachment may not be added to the task because the task was cancelledstatic final IntegerResult code indicating that an attachment may not be added to the task because the task is unattendedstatic final IntegerResult code indicating that an attachment may not be added because too many attachments have been addedstatic final intCode for attended tasks onlystatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final intConstant indicating that unattended activities could not be completed because an exception occurredstatic final intConstant indicating that unattended activities could not be completed because a timeout occurred connecting to Java from the process enginestatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final IntegerDeprecated.since 23.2static final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final IntegerResult code indicating that the cancellation of a process failed because the current user has insufficient privileges to cancel the process - that is, ifProcessPermissions.isStopAndPause()returns falsestatic final IntegerResult code indicating that the cancellation of a process failed because the process is invalidstatic final IntegerResult 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 ofProcessSummary.STATE_ACTIVE,ProcessSummary.STATE_PAUSEDorProcessSummary.STATE_PAUSED_BY_EXCEPTIONstatic final IntegerResult code indicating that the cancellation of a process failed because the process is locked (seelockProcessModelForProcess(Long,boolean))static final IntegerResult code indicating that the cancellation of a process was successfulstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final IntegerResult code indicating that the current user does not have sufficient privileges to perform the actionstatic final IntegerResult code indicating that the node is invalid because its activity chaining settings prohibit multiple instancesstatic final IntegerResult code indicating that the attempted operation was invalid for the current userstatic final IntegerResult code indicating that the specified process is invalidstatic final IntegerResult code indicating that something is in an invalid state for the action to succeedstatic final IntegerResult code indicating that the specified task is invalidstatic final IntegerResult code indicating that an item is lockedstatic final IntegerResult code indicating that an item is a logic node and cannot be startedstatic final IntegerResult code indicating that this is an event and cannot be pausedstatic final IntegerResult code indicating that a node cannot be started because multiple instances of the node are not allowed.static final IntegerResult code indicating that the task is set to recurstatic final IntegerResult code indicating that the action is successfulstatic final IntegerResult code indicating that the maximum number of task instances has been reached and a new one cannot be created.static final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final intDeprecated.since 23.2static final intDeprecated.since 23.2static final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final IntegerResult code indicating that a task could not be accepted because it was already accepted by another user.static final IntegerResult code indicating that a task could not be accepted because it is in an invalid state.static final IntegerResult code indicating that a task could not be accepted because the current user is not an assigneestatic final IntegerResult code indicating that a task could not be accepted because the current user is not an assignee, but the user has complete permissionsstatic final IntegerResult code indicating that a task could not be accepted because the task is pausedstatic final IntegerResult code indicating that a task could not be accepted because the process is pausedstatic final IntegerResult code indicating that a task was accepted successfullystatic final IntegerResult code indicating that the cancellation of a task failed because the current user has insufficient privileges to cancel the task - that is, ifProcessPermissions.isStopAndPause()returns false for the process containing the taskstatic final IntegerResult code indicating that the cancellation of a task failed because the task is in an invalid statestatic final IntegerResult code indicating that the cancellation of a task failed because the task is invalidstatic final IntegerResult code indicating that the cancellation of a task was successfulstatic final IntegerConstant 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 final IntegerConstant indicating that the current user has the privileges to reject a given task, or to reassign the task within the assignment poolstatic final IntegerConstant indicating that the current user only has the privileges to reject a given taskstatic final IntegerResult 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 final IntegerResult code indicating that the rejection of a task was unsuccessful because the current user is not the owner of the taskstatic final IntegerResult code indicating that the rejection of a task was successfulstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final intCode for attended and unattended tasksstatic final intCode for unattended tasks onlystatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final booleanFields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME -
Method Summary
Modifier and TypeMethodDescriptionacceptTask(Long activityId_) Accepts a task for a user.voidacknowledgeActivity(Long activityId_) Deprecated.no longer necessaryvoidacknowledgeActivity(Long[] activityId_) Deprecated.no longer necessaryvoidacknowledgeMessages(Long[] messageIds_) Deprecated.replaced by work queue, no longer requires separate acknowledgement: call does nothing nowLong[]addAttachmentsToProcess(Long processId_, Attachment[] attachments_) Add attachments to a given process.Long[]addAttachmentsToTask(Long taskId_, Attachment[] attachments_) Adds attachments to a given task.addAttachmentToProcess(Long processId_, Attachment attachment_) Add an attachment to a process.Long[]addAttachmentToProcesses(Long[] processIds_, Attachment attachment_) Adds a single attachment to a list of processes.addAttachmentToTask(Long taskId_, Attachment attachment_) Add an attachment to a taskLong[]addAttachmentToTasks(Long[] taskIds_, Attachment attachment_) Add an attachment to the given tasksvoidaddProcessToFavorites(Long processId_) Adds aProcessto the user's favorites list.voidaddProcessVariable(Long processId_, ProcessVariableInstance pv_) Adds a new variable to the specified process.voidaddProcessVariables(Long processId_, ProcessVariableInstance[] pvs_) Adds new variables to the specified process.voidaddTaskToFavorites(Long taskId_) Adds aTaskto the user's favorites list.voidarchiveProcess(Long processId_) Archive the process with the given id.Integer[]archiveProcesses(Long[] processIds_) Manually archive the processes with the given ids.cancelAllNodes(String[] nodeUuids, Long[] withinProcessIds) Cancel each given node in every applicable process.voidcancelProcess(Long processId_, boolean cancelLinkedProcesses_) Cancels the specified process.Integer[]cancelProcesses(Long[] processIds_, boolean cancelLinkedProcesses_) Cancel a list of processes.voidcancelStore(Long expressionGroupId, String cancelMessage) Cancel an external data store.voidcancelTask(Long activityId_) Cancels a given taskInteger[]cancelTasks(Long[] activityIds_) Cancels a list of tasks.booleancanCompleteActivity(Long activityId_) Determines whether the specified activity can be completed by the user.booleancanCompleteClone(Long activityId_) Indicates whether the current user can usecompleteClone(java.lang.Long, com.appiancorp.suiteapi.process.ActivityClassParameter[], com.appiancorp.suiteapi.process.ActivityReturnVariable[])on the given task to complete the activity.intcheckActivityValidity(Long activityId_) Determines whether the specified activity is valid.voidDeprecated.completeActivity(Long activityId_, ActivityReturnVariable[] outputs_) Signals the completion of an activity not implemented within the process engine itself.completeClone(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).voidcompleteStore(Long expressionGroupId) Complete an external data store.booleancontainsAsynchronousSubProcesses(Long processId_) Determines whether or not the given process contains asynchronous subprocesses.Boolean[]containsAsynchronousSubProcesses(Long[] processId_) booleancontainsLinkProcesses(Long processId_) Deprecated.UsecontainsAsynchronousSubProcesses(Long)instead.booleancontainsLinkProcessesInheritingPriority(Long processId_) Deprecated.UsecontainsSubProcessesInheritingPriority(Long)instead.booleancontainsSubProcesses(Long processId_) Deprecated.UsecontainsSynchronousSubProcesses(Long)instead.booleancontainsSubProcessesInheritingPriority(Long processId_) Checks if the specifiedProcesscontains sub-processes that inherit their priority instead of defining their own priority levels.booleancontainsSynchronousSubProcesses(Long processId_) Determines whether or not the given process contains synchronous subprocesses.Boolean[]containsSynchronousSubProcesses(Long[] processId_) Deprecated.since 23.2createNoteMetadataForProcess(Long processId_, NoteMetadata nm_) Deprecated.since 23.2createNoteMetadataForProcesses(Long[] processIds_, NoteMetadata nm_) Deprecated.since 23.2createNoteMetadataForTask(Long taskId_, NoteMetadata nm_) Deprecated.since 23.2createNoteMetadataForTasks(Long[] taskIds_, NoteMetadata nm_) Deprecated.since 23.2createNoteMetadatas(NoteMetadata[] nms_) Deprecated.since 23.2createNoteMetadatasForProcess(Long processId_, NoteMetadata[] nms_) Deprecated.since 23.2createNoteMetadatasForTask(Long taskId_, NoteMetadata[] nms_) Deprecated.since 23.2deleteNoteMetadataForProcess(Long noteId_, Long processId_) Deprecated.since 23.2deleteNoteMetadataForTask(Long noteId_, Long taskId_) Deprecated.since 23.2deleteNoteMetadatasForProcess(Long[] noteIds_, Long processId_) Deprecated.since 23.2deleteNoteMetadatasForTask(Long[] noteIds_, Long taskId_) Deprecated.since 23.2voiddeleteProcess(Long processId_, boolean deleteSubProcesses_) Deletes the specified process.voiddeleteProcesses(Long[] processIds_, boolean deleteSubProcesses_) Deletes all of the specified processes.Requests execution of an activity implemented within the process engine.voidexecutionFailure(int errorType_, Long[] activities_) Deprecated.unattended activities now run from the work queue.voidexecutionFailureMessage(int errorType_, Long[] activities_, String message_) Deprecated.unattended activities now run from the work queue.getActivitiesMetadata(Long[] activityIds_) Gets metadata for the specified activities.getActivityMetadata(Long activityId_) Gets the metadata for a specified activity.getActivityProperties(Long activityId_) Retrieves the activity properties for the given activity.getAllExceptionNoteMetadatasForProcess(Long processId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.since 23.2String[]Retrieve the paths where archived processes are stored.getAssigneePoolForTasks(Long[] taskIds_) Gets the set of unique assignees among all the specified tasks.getAsynchronousSubProcessesForProcess(Long processId_, int asynchronousSubProcessStatus_) Gets the asynchronous subprocesses of the given process.getAttachmentsAndNotesForTask(Long taskId_, boolean recursive_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.since 23.2.getAttachmentsForProcess(Long processId_) Deprecated.getAttachmentsForProcess(Long id_, boolean recursive_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Returns the attachments for a specified processgetAttachmentsForTask(Long taskId_) Gets all the attachments for a given task and its related processgetAttachmentsInProcess(Long processId_, Long[] attachmentIds_) Gets the specified attachments associated with a given process, or tasks in this processRetrieves auto archive properties from the backendgetCancelledTasksForProcess(Long processId_, int type_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the cancelled tasks for a processgetCompletedTasksForProcess(Long processId_, int type_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the completed tasks for a processString[]Deprecated.since 23.2getCurrentTasksForProcess(Long processId_, int type_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the current tasks for a processgetDeadlineForProcess(Long processId_) Retrieve the deadline of a given process.getDeadlineForTask(Long taskId_) Retrieve the deadline for a given task.getExceptionNoteMetadataForTask(Long taskId_) Deprecated.since 23.2getExceptionNoteMetadatasForProcess(Long processId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.since 23.2getLingeringTasksForProcess(Long processId_, boolean recursive, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Returns all instances of lingering nodes currently active in the specified process.getLingeringTasksForProcessAndNode(Long processId_, Long nodeId_) Returns all instances of the specified lingering node currently active in the specified process.getLinkProcessesForProcess(Long processId_, int linkProcessStatus_) Deprecated.UsegetAsynchronousSubProcessesForProcess(Long, int)instead.intReturns the Maximum number of attachmnets that can be added to Process or TaskintDeprecated.since 23.2Returns theSizingReportwhich contains top-level summary of memory usage by various objects in all Execution Engines.getMemoryUsageForNodesInProcesses(Long[] processIds_) Returns theSizingReportwhich contains a breakdown of memory usage by individual nodes/activities in specific Process instances.getMemoryUsageForProcesses(Long[] processIds_) Returns theSizingReportwhich contains a breakdown of memory usage by individual process instancesgetMemoryUsageForProcessesByModelUUID(String[] processModelUUIDs_) Returns theSizingReportwhich contains a breakdown of memory usage by individual process instances based of of specific Process Models given by Process Model UUIDs.getMemoryUsageForProcessModels(Long[] processModelIds_) Returns theSizingReportwhich contains a breakdown of memory usage by all process instances based off of specific Process Models given by the Process Model IDs.getMemoryUsageForProcessModelsByUUID(String[] processModelUUIDs_) Returns theSizingReportwhich contains a breakdown of memory usage by all process instances based off of specific Process Models given by Process Model UUIDs.getNextRecurrence(Long processId_, Long nodeId_) Gets the next recurrence for a node within a processgetNoteMetadataForProcess(Long noteId_, Long processId_) Deprecated.since 23.2getNoteMetadataForTask(Long noteId_, Long taskId_) Deprecated.since 23.2getNoteMetadatasForProcess(Long id_, boolean recursive_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.since 23.2getNoteMetadatasForProcess(Long id_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.getNoteMetadatasForProcesses(Long[] ids_) Deprecated.since 23.2getNoteMetadatasForTask(Long id_, boolean includeProcess_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.since 23.2getNoteMetadatasForTasks(Long[] ids_, boolean includeProcess_) Deprecated.since 23.2getNoteMetadatasInProcess(Long processId_, Long[] noteIds_) Deprecated.since 23.2getNotePath(Long noteId_) Deprecated.since 23.2String[]getNotePaths(Long[] noteIds_) Deprecated.since 23.2getPausedTasksForProcess(Long processId_, int type_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the paused tasks for a processgetPermissionsForNode(Long activityId_) Gets the permissions that the user has by default on tasks of the specified node.getPermissionsForNodes(Long[] activityIds_) Gets the permissions that the user has by default on tasks of the specified nodes.Gets the permissions that the user has on a specified process.getPermissionsForProcessDiagram(Long processId_) Gets aProcessModelPermissionsobject that says which In-Flight Modifications the user can or cannot perform to a given process.getPermissionsForProcesses(Long[] ids_) Gets the permissions that the user has on specified processes.getPmIdForProcess(Long processId_) Get the specified Process's Process Model's IDgetPriorityOfProcess(Long processId_) Gets the priority of a specified Process.Priority[]getPriorityOfProcesses(Long[] processIds_) Gets the priority for a list of processes.getPriorityOfTask(Long taskId_) Get the priority of the specified task.Priority[]getPriorityOfTasks(Long[] taskIds_) Get the priorities of the specified tasks.getProcessDetails(Long processId_) Gets the details for a specified process.getProcessDiagram(Long processId_, int typeOfNotesToRetrieve_) Allows users to retrieve the instance of the process model that the process is run off.getProcessHistoryRecords(Long processId_) Get the process history record of the given process.getProcessHistoryRecordsPaging(Long processId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Get the process history record of the given process.getProcessParameter(Long processId_, String parameterName_) Retrieves the specified process parameter of the specified process.getProcessParameters(Long processId_) Retrieves process parameters for the specified process.getProcessProperties(Long processId_) Retrieves the properties for the given process.getProcessVariable(Long processId_, String pvName_) Retrieves the specified process variable for the specified process.getProcessVariables(Long processId_) Deprecated.UsegetRecursiveProcessVariables(Long, boolean)instead.getProcessVariablesPaging(Long processId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Retrieves the process variables for the specified process.getRecursiveProcessVariables(Long processId_, boolean recursive_) Retrieves the process variables for the specified process.getScheduleSummariesForNode(Long processId_, Long nodeId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets Summaries of schedules that are attached to the node.getSecurityForNode(Long id_) Gets the default security configuration of tasks for a specified node.Gets the security configuration of a process.getSubProcessesForProcess(Long processId_, int subProcessStatus_) Deprecated.UsegetSynchronousSubProcessesForProcess(Long, int)instead.getSynchronousSubProcessesForProcess(Long processId_, int synchronousSubProcessStatus_) Gets the synchronous subprocesses of the given process.getTaskAssignees(Long taskId_) Gets all assignees for a specified task.getTaskDetails(Long taskId_) Gets the details for the specified task.getTaskFormExpression(Long taskId) Gets task form expressions for the specified task.String[]getTaskFormExpressions(Long[] taskIds) Gets task form expressions for the specified tasks.getTaskOpaqueUri(Long taskId_) Gets the opaque URI for the specified task.getTaskPrivileges(Long activityId_) Determines whether the user who is executing an attended activity is permitted to reject or reassign the task.getTaskProperties(Long taskId_) Retrieves the properties for the given task.getTasksAssignees(Long[] taskIds_) Gets all assignees for the specified tasks.getTasksDetails(Long[] taskIds_) Gets the details for the specified tasks.getTasksForProcess(Long processId_, boolean recursive_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the summaries of the tasks in the process.getTasksForProcess(Long processId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.getTasksWithExceptionsForProcess(Long processId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Gets the tasks that are paused by exception for a specified process.getTasksWithStatusForProcess(Long processId_, Integer taskStatus_, boolean recursive_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Get the pages of tasks, within a particular process or its subprocesses, currently in a given state.getTasksWithStatusForProcesses(Long[] processIds_, Integer taskStatus_, boolean recursive_, int startIndex_, int batchSize_) Get the pages of tasks, within particular processes or their subprocesses, currently in a given state.getTasksWithStatusForProcessModel(Long processModelId_, Integer taskStatus_, boolean recursive_, int startIndex_, int batchSize_) Get the pages of tasks, within a particular process model, currently in a given state.getTasksWithStatusForProcessModels(Long[] processModelIds_, Integer taskStatus_, boolean recursive_, int startIndex_, int batchSize_) Get the pages of tasks, within any of particular process models, currently in a given state.getTaskUrl(Long taskId_) Gets the URL for the specified task.getTopLevelProcessForProcess(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.booleanisAsynchronousSubProcess(Long processId_) Determines whether or not the given process is an asynchronous subprocess.booleanisLinkProcess(Long processId_) Deprecated.UseisAsynchronousSubProcess(Long)instead.booleanisSubProcess(Long processId_) Deprecated.Use#isSynchronousSubProcesses(Long)instead.booleanisSynchronousSubProcess(Long processId_) Determines whether or not the given process is a synchronous subprocess.voidkeepSubmittedTasksAlive(Long[] activities_) This method informs the Process Engine that the specified tasks are still in the queue, waiting to be executed asynchronously.int[]lockProcesses(Long[] processIds, boolean override) Attempts to lock the specified processes.voidlockProcessModelForProcess(Long processId_, boolean override_) Locks the underlying process model of the specified process.voidlowerPriorityOfProcess(Long processId_, boolean propagatePriorityChangeToLinkProcesses_) Lowers the priority of a process by one level.voidlowerPriorityOfProcesses(Long[] processIds_, boolean propagatePriorityChangeToLinkProcesses_) Lowers the priority of the specified processes by one level.voidlowerPriorityOfTask(Long taskId_) Lowers the priority of a task by one level.voidlowerPriorityOfTasks(Long[] taskIds_) Lowers the priority of specified tasks by one level.voidnotifyException(Long activityId_, String exceptionClassName_, String message_, String stackTrace_) Notifies the server that an exception has occurred while executing an activity.voidnotifyInvalidParameters(Long activityId_, ActivityClassParameter[] acps_) Notifies the user that the parameters sent as inputs to an unattended activity were invalid.voidnotifyUsersCreationByJava(Long activityId_, String[] usernames_) Deprecated.This call should never be necessary.voidnotifyUsersCreationByJava(String[] usernames_) Deprecated.done automatically by UserService.createUserpauseAllNodes(String[] nodeUuids, Long[] withinProcessIds) Pause each given node in every applicable process.voidpauseProcess(Long processId_) Pauses the process, and all of its nodes.Integer[]pauseProcesses(Long[] processIds_) Pauses the processes, and all of their nodes.voidPauses the taskInteger[]pauseTasks(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.voidprocessToNextAttended(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.voidraisePriorityOfProcess(Long processId_, boolean propagatePriorityChangeToLinkProcesses_) Raises the priority of a specified process by one level.voidraisePriorityOfProcesses(Long[] processIds_, boolean propagatePriorityChangeToLinkProcesses_) Raises the priority of the specified processes by one level.voidraisePriorityOfTask(Long taskId_) Raises the priority of the specified task by one level.voidraisePriorityOfTasks(Long[] taskIds_) Raises the priority of the specified tasks by one level.voidreassignTask(Long taskId_, Assignment.Assignee[] assignees_) Reassigns a task to new assignees.Integer[]reassignTasksToAssigneePool(Long[] activityIds_, Assignment.Assignee[] assignees_) Deprecated.Integer[]reassignTasksToSameAssigneePool(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.voidreassignTaskToSameAssigneePool(Long activityId_) Reassigns the task to the assignee pool.voidrefreshTaskForm(Long activityId_) Deprecated.This method will cause a race condition between ACP refresh and form label refresh.rejectTask(Long taskId_) Rejects a task that has already been accepted.voidDeprecated.reloading properties is now automatic, so this call is now unnecessary and does nothing.voidremoveDashboardPageForProcesses(Long processModelId) Deprecated.Use {@link ProcessDesignService.removeProcessDashboardPageForProcessModel(Long)} instead.removeProcessAttachment(Long attachmentId_, Long processId_) Removes the specified attachment from a process.Long[]removeProcessAttachments(Long[] attachmentIds_, Long processId_) Removes specified attachments from the specified process.voidremoveProcessFromFavorites(Long processId_) Removes a process from the user's Favorite's listremoveTaskAttachment(Long attachmentId_, Long taskId_) Removes a specified attachment from a taskLong[]removeTaskAttachments(Long[] attachmentIds_, Long taskId_) Removes the specified attachments from a taskvoidremoveTaskFromFavorites(Long taskId_) Removes a task from the user's Favorite's listrestartAllNodes(String[] nodeUuids, Long[] withinProcessIds, BulkNodeOption... bulkNodeOption) Restart a task for each of the given nodeUuids in every applicable process.resumeAllNodes(String[] nodeUuids, Long[] withinProcessIds) Resume each given node in every applicable process.voidresumeProcess(Long processId_) Resumes the process.Integer[]resumeProcesses(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.voidresumeTask(Long activityId_) Resumes the taskInteger[]resumeTasks(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.voidDeprecated.voidsaveActivityParameters(Long activityId_, ActivityClassParameter[] acps_) Saves the values for parameters of an activity.voidsetActorsInRolesForNode(Long id_, String[] users_, String[][] userRoles_, Long[] groups_, String[][] groupRoles_) Adds and/or modifies the default roles of users and groups for a node instance (activity).voidsetActorsInRolesForProcess(Long id_, String[] users_, String[][] userRoles_, Long[] groups_, String[][] groupRoles_) Adds and/or modifies the roles of users and groups for a specified process.voidsetApplicationAdministratorGroup(Long groupId_) Determines which group users need to be in to have the application administrator role.voidsetArchivePaths(String[] archivePaths) Set the paths where archived processes will be stored.voidsetCurrentNotePaths(String[] notePaths) Deprecated.since 23.2voidsetDashboardPageForProcesses(Long processModelId, Long pageId) Deprecated.Use {@link ProcessDesignService.setProcessDashboardPageForProcessModel(Long, Long)} instead.voidsetDeadlineForProcess(Long processId_, Timestamp deadline_) Set the deadline for a given process.voidsetDeadlineForTask(Long taskId_, Timestamp deadline_) Set the deadline for a given task.voidsetInheritanceForNode(Long id_, boolean doesInherit_) Sets whether a specified task inherits security from its process.voidsetInheritanceForProcess(Long id_, boolean doesInherit_) Sets whether a specified process inherits security from the process model of which it is an instance.voidsetPriorityOfProcess(Long processId_, Long priorityId_, boolean propagatePriorityChangeToSubProcesses_) Sets the priority of a specified processvoidsetPriorityOfProcesses(Long[] processIds_, Long priorityId_, boolean propagatePriorityChangeToSubProcesses_) Sets the priorityPriorityof the specified processesProcessDetails.voidsetPriorityOfTask(Long taskId_, Long priorityId_) Sets the priority of a specified task.voidsetPriorityOfTasks(Long[] taskIds_, Long priorityId_) Sets the priorities of specified tasks.voidsetProcessProperties(ProcessProperties properties_) Sets the properties of the specified process.voidsetProcessVariable(Long pProcessId_, ProcessVariableInstance pv_) Sets the value of the specified process variable for the specified process.voidsetProcessVariables(Long pProcessId_, ProcessVariableInstance[] pvs_) Sets the values of the specified process variables for the specified process.voidsetSecurityForNode(Long id_, Security s_) Sets the default security configuration of tasks for a specified node.voidsetSecurityForProcess(Long id_, Security s_) Sets the security configuration of a process.voidsetSiteLocaleSettings(SiteLocaleSettings settings_) Registers the site locale settings on the process execution server.voidsetTaskDisplayName(Long taskId, LocaleString displayName) Sets the display name for the specified task to the specified string.voidsetTaskProperties(TaskProperties properties_) Sets the properties of the specified task .voidsetTaskStateRunning(Long taskId_) Sets the Task in the Running state.voidsetTaskStateSubmitted(Long taskId_) Sets the Task in the 'Submitted' state.voidSet the time zone information using the format used by the engines to encapsulate time zone information.voidsetTimeZoneSameAs(BackendTimeZoneSimple tz, String sameAsId) Deprecated.this method will be removed in a future releaseskipRecurrence(Long processId_, Long nodeId_, Long recurrenceNumber_) Skips the recurrence instance of the given nodevoidskipTaskEscalation(Long activityId_, Long escalationId_) Skips the desired escalation instance for the taskstartAllNodes(String[] nodeUuids, Long[] withinProcessIds, BulkNodeOption... bulkNodeOption) Start a task for each of the given nodeUuids in every applicable process.startQuickTask(Long processId_, 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.booleanStarts a new task from the node If the process to which the node belongs is cancelled or completed, then the process is reactivated.Integer[]startTasks(Long processId_, 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.triggerRecurrence(Long processId_, Long nodeId_, Long recurrenceNumber_) Triggers the recurrence instance of the given nodevoidtriggerSchedule(Integer scheduleType_, Long scheduleId_) Triggers the schedule instance for the task or nodevoidtriggerTaskEscalation(Long activityId_, Long escalationId_) Triggers the desired escalation instance for the task.Users must obtain escalation id from TaskDetails object.voidunarchiveProcess(Long processId_) Bring all process data back to memory.Integer[]unarchiveProcesses(Long[] processIds_) Bring all process data back to memory.uncompleteActivity(Long activityId_) Changes the status of an activity to ACCEPTED or ASSIGNED.int[]unlockProcesses(Long[] processIds, boolean override) Attempts to unlock the specified processes.voidunlockProcessModelForProcess(Long processId_, boolean override_) Unlocks the underlying process model for the processvoidUnlocks all process models locked by the current user.updateNoteMetadataForProcess(NoteMetadata nm_, Long processId_) Deprecated.since 23.2updateNoteMetadataForTask(NoteMetadata nm_, Long taskId_) Deprecated.since 23.2updateNoteMetadatasForProcess(NoteMetadata[] nms_, Long processId_) Deprecated.since 23.2updateNoteMetadatasForTask(NoteMetadata[] nms_, Long taskId_) Deprecated.since 23.2updateProcessModelForProcess(Long processId_, ProcessDiagram pd_, ProcessModel[] childProcessModels_) Deprecated.voidupdateUsernames(String[] oldUsernames_, String[] newUsernames_, long maxExpirationTimeInSeconds_) Deprecated.upgradeProcesses(Long toProcessModelId, String toVersion, Long[] processIds) Attempts to upgrade the given processes to the specified process model id and version.upgradeProcesses(Long toProcessModelId, String toVersion, Long fromProcessModelId, String[] fromVersions) Attempts to upgrade the processes of the 'from' process model id and version to the 'to' process model id and version.validate()Runs validation tests against the database to check whether it is corrupt, and returns a line-separated list of validation resultsMethods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
TASK_ACCEPTANCE_SUCCESS
Result code indicating that a task was accepted successfully -
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
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 ofTaskSummary.TASK_STATUS_ASSIGNEDorTaskSummary.TASK_STATUS_ACCEPTED -
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
Result code indicating that a task could not be accepted because the process is paused -
TASK_ACCEPTANCE_PAUSED
Result code indicating that a task could not be accepted because the task is paused -
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
Constant indicating that the current user only has the privileges to reject a given task -
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
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
Result code indicating that the rejection of a task was successful -
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
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
Result code indicating that the cancellation of a process was successful -
PROCESS_CANCELLATION_INVALID_PROCESS
Result code indicating that the cancellation of a process failed because the process is invalid -
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, ifProcessPermissions.isStopAndPause()returns false -
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 ofProcessSummary.STATE_ACTIVE,ProcessSummary.STATE_PAUSEDorProcessSummary.STATE_PAUSED_BY_EXCEPTION -
PROCESS_CANCELLATION_LOCKED_PROCESS
Result code indicating that the cancellation of a process failed because the process is locked (seelockProcessModelForProcess(Long,boolean)) -
TASK_CANCELLATION_SUCCESS
Result code indicating that the cancellation of a task was successful -
TASK_CANCELLATION_INVALID_TASK
Result code indicating that the cancellation of a task failed because the task is invalid -
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, ifProcessPermissions.isStopAndPause()returns false for the process containing the task -
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
Deprecated.since 23.2Result 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
Deprecated.since 23.2Result code indicating that the creation of note metadata for a process failed because the process has been cancelled -
NOTE_CREATION_PROCESS_NOTE_LIMIT_EXCEEDED
Deprecated.since 23.2Result 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
Deprecated.since 23.2Result code indicating that the creation of note metadata for a process failed because the process is invalid -
NOTE_CREATION_PROCESS_INSUFFICIENT_PRIVILEGES
Deprecated.since 23.2Result 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 ifProcessPermissions.isAddAttachment()returns false -
NOTE_CREATION_PROCESS_SUCCESS
Deprecated.since 23.2Result code indicating that the creation of note metadata for a process was successful -
NOTE_CREATION_TASK_INVALID_BEAN
Deprecated.since 23.2Result 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
Deprecated.since 23.2Result code indicating that the creation of note metadata for a task failed because the task is unattended -
NOTE_CREATION_TASK_CANCELLED
Deprecated.since 23.2Result code indicating that the creation of note metadata for a task failed because the task has been cancelled -
NOTE_CREATION_TASK_NOTE_LIMIT_EXCEEDED
Deprecated.since 23.2Result 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
Deprecated.since 23.2Result code indicating that the creation of note metadata for a task failed because the task is invalid -
NOTE_CREATION_TASK_INSUFFICIENT_PRIVILEGES
Deprecated.since 23.2Result 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 ifNodePermissions.isAddAttachment()returns false -
NOTE_CREATION_TASK_SUCCESS
Deprecated.since 23.2Result code indicating that the creation of note metadata for a task was successful -
NOTE_DELETION_INVALID
Deprecated.since 23.2Result code indicating that the deletion of note metadata from a process or task failed because the note does not exist -
NOTE_DELETION_INSUFFICIENT_PRIVILEGES
Deprecated.since 23.2Result 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 whenProcessPermissions.isRemoveAttachment()returns false for the process, or for the process containing the task, respectively. -
NOTE_DELETION_SUCCESS
Deprecated.since 23.2Result code indicating that the deletion of note metadata from a process or task succeeded -
ACTIVITY_VALID
static final int ACTIVITY_VALIDA 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:
-
ACTIVITY_PROCESS_CANCELLED
static final int ACTIVITY_PROCESS_CANCELLEDA constant indicating that an activity exists in a process that has been cancelled- See Also:
-
ACTIVITY_PROCESS_COMPLETED
static final int ACTIVITY_PROCESS_COMPLETEDA constant indicating that an activity exists in a process that has been completed- See Also:
-
ACTIVITY_PROCESS_DELETED
static final int ACTIVITY_PROCESS_DELETEDA constant indicating that an activity has been deleted, since its parent process has been deleted- See Also:
-
ACTIVITY_COMPLETED
static final int ACTIVITY_COMPLETEDA 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:
-
ACTIVITY_PROCESS_PAUSED
static final int ACTIVITY_PROCESS_PAUSEDA constant indicating that the process for an activity is paused- See Also:
-
ACTIVITY_PAUSED
static final int ACTIVITY_PAUSEDA constant indicating that an activity has been paused- See Also:
-
ACTIVITY_CANCELLED
static final int ACTIVITY_CANCELLEDA constant indicating that an activity has been cancelled- See Also:
-
ACTIVITY_INVALID_STATE
static final int ACTIVITY_INVALID_STATEA constant indicating that an activity is in an invalid state- See Also:
-
ACTIVITY_SKIPPED
static final int ACTIVITY_SKIPPEDA constant indicating that an activity has been skipped by an exception flow.- See Also:
-
ACTIVITY_WAITING
static final int ACTIVITY_WAITINGA constant indicating that an activity is waiting on an asynchronous workq item in Java.- See Also:
-
RESULT_CODE_RECURRING_TASK
Result code indicating that the task is set to recur -
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
Result code indicating that the action is successful -
RESULT_CODE_INVALID_PROCESS
Result code indicating that the specified process is invalid -
RESULT_CODE_INSUFFICIENT_PRIVILEGES
Result code indicating that the current user does not have sufficient privileges to perform the action -
RESULT_CODE_INVALID_STATE
Result code indicating that something is in an invalid state for the action to succeed -
RESULT_CODE_INVALID_OPERATION
Result code indicating that the attempted operation was invalid for the current user -
RESULT_CODE_INVALID_TASK
Result code indicating that the specified task is invalid -
RESULT_CODE_LOCK_EXCEPTION
Result code indicating that an item is locked -
RESULT_CODE_LOGIC_NODE
Result code indicating that an item is a logic node and cannot be started -
RESULT_CODE_INVALID_NODE
Result code indicating that the node is invalid because its activity chaining settings prohibit multiple instances -
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
Result code indicating that this is an event and cannot be paused -
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
Result code indicating that an attachment may not be added to the task because the task was cancelled -
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
Result code indicating that an attachment may not be added because too many attachments have been added -
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
Result code indicating that an attachment may not be added/removed because the user does not have permission to do so -
ATTACHMENT_RETURN_SUCCESS
Return code indicating that adding an attachment was successful -
NOTES_RETURN_INVALID
Deprecated.since 23.2Return code indicating that a note may not be added/removed because the specified process, task, or note does not exist -
NOTES_RETURN_PERMISSIONS
Deprecated.since 23.2Return code indicating that a note may not be added/removed because the user does not have permission to do so -
NOTES_RETURN_SUCCESS
Deprecated.since 23.2Return code indicating that adding/removing a Note was successful -
UNATTENDED_TASKS
static final int UNATTENDED_TASKSCode for unattended tasks only- See Also:
-
ATTENDED_TASKS
static final int ATTENDED_TASKSCode for attended tasks only- See Also:
-
UNATTENDED_AND_ATTENDED_TASKS
static final int UNATTENDED_AND_ATTENDED_TASKSCode for attended and unattended tasks- See Also:
-
EXECUTION_FAILURE_EXCEPTION
static final int EXECUTION_FAILURE_EXCEPTIONConstant indicating that unattended activities could not be completed because an exception occurred- See Also:
-
EXECUTION_FAILURE_TIMEOUT
static final int EXECUTION_FAILURE_TIMEOUTConstant indicating that unattended activities could not be completed because a timeout occurred connecting to Java from the process engine- See Also:
-
RETRIEVE_PROCESS_MODEL_NOTES
Deprecated.since 23.2Constant indicating that that the notes and attachments of the underlying process model should be retrieved bygetProcessDiagram(java.lang.Long, int)- See Also:
-
RETRIEVE_PROCESS_NOTES
Deprecated.since 23.2Constant indicating that that the notes and attachments of the process should be retrieved bygetProcessDiagram(java.lang.Long, int)- See Also:
-
saveActivityParameters$UPDATES
static final boolean saveActivityParameters$UPDATES- See Also:
-
completeActivity$UPDATES
static final boolean completeActivity$UPDATES- See Also:
-
acknowledgeActivity$UPDATES
static final boolean acknowledgeActivity$UPDATES- See Also:
-
completeClone$UPDATES
static final boolean completeClone$UPDATES- See Also:
-
getLingeringTasksForProcess$UPDATES
static final boolean getLingeringTasksForProcess$UPDATES- See Also:
-
getLingeringTasksForProcessAndNode$UPDATES
static final boolean getLingeringTasksForProcessAndNode$UPDATES- See Also:
-
refreshTaskForm$UPDATES
static final boolean refreshTaskForm$UPDATES- See Also:
-
execute$UPDATES
static final boolean execute$UPDATES- See Also:
-
getActivityMetadata$UPDATES
static final boolean getActivityMetadata$UPDATES- See Also:
-
getActivitiesMetadata$UPDATES
static final boolean getActivitiesMetadata$UPDATES- See Also:
-
getTaskFormExpression$UPDATES
static final boolean getTaskFormExpression$UPDATES- See Also:
-
getTaskFormExpressions$UPDATES
static final boolean getTaskFormExpressions$UPDATES- See Also:
-
acceptTask$UPDATES
static final boolean acceptTask$UPDATES- See Also:
-
getTaskPrivileges$UPDATES
static final boolean getTaskPrivileges$UPDATES- See Also:
-
getTaskAssignees$UPDATES
static final boolean getTaskAssignees$UPDATES- See Also:
-
getTasksAssignees$UPDATES
static final boolean getTasksAssignees$UPDATES- See Also:
-
getAssigneePoolForTasks$UPDATES
static final boolean getAssigneePoolForTasks$UPDATES- See Also:
-
reassignTask$UPDATES
static final boolean reassignTask$UPDATES- See Also:
-
rejectTask$UPDATES
static final boolean rejectTask$UPDATES- See Also:
-
getTaskDetails$UPDATES
static final boolean getTaskDetails$UPDATES- See Also:
-
getTasksDetails$UPDATES
static final boolean getTasksDetails$UPDATES- See Also:
-
getTaskOpaqueUri$UPDATES
static final boolean getTaskOpaqueUri$UPDATES- See Also:
-
getTaskUrl$UPDATES
static final boolean getTaskUrl$UPDATES- See Also:
-
getProcessDetails$UPDATES
static final boolean getProcessDetails$UPDATES- See Also:
-
notifyException$UPDATES
static final boolean notifyException$UPDATES- See Also:
-
executionFailure$UPDATES
static final boolean executionFailure$UPDATES- See Also:
-
executionFailureMessage$UPDATES
static final boolean executionFailureMessage$UPDATES- See Also:
-
deleteProcess$UPDATES
static final boolean deleteProcess$UPDATES- See Also:
-
deleteProcesses$UPDATES
static final boolean deleteProcesses$UPDATES- See Also:
-
cancelProcess$UPDATES
static final boolean cancelProcess$UPDATES- See Also:
-
notifyInvalidParameters$UPDATES
static final boolean notifyInvalidParameters$UPDATES- See Also:
-
notifyUsersCreationByJava$UPDATES
static final boolean notifyUsersCreationByJava$UPDATES- See Also:
-
checkActivityValidity$UPDATES
static final boolean checkActivityValidity$UPDATES- See Also:
-
canCompleteActivity$UPDATES
static final boolean canCompleteActivity$UPDATES- See Also:
-
canCompleteClone$UPDATES
static final boolean canCompleteClone$UPDATES- See Also:
-
getSubProcessesForProcess$UPDATES
static final boolean getSubProcessesForProcess$UPDATES- See Also:
-
getSynchronousSubProcessesForProcess$UPDATES
static final boolean getSynchronousSubProcessesForProcess$UPDATES- See Also:
-
getTopLevelProcessForProcess$UPDATES
static final boolean getTopLevelProcessForProcess$UPDATES- See Also:
-
isSubProcess$UPDATES
static final boolean isSubProcess$UPDATES- See Also:
-
isSynchronousSubProcess$UPDATES
static final boolean isSynchronousSubProcess$UPDATES- See Also:
-
containsSubProcesses$UPDATES
static final boolean containsSubProcesses$UPDATES- See Also:
-
containsLinkProcesses$UPDATES
static final boolean containsLinkProcesses$UPDATES- See Also:
-
containsSynchronousSubProcesses$UPDATES
static final boolean containsSynchronousSubProcesses$UPDATES- See Also:
-
containsAsynchronousSubProcesses$UPDATES
static final boolean containsAsynchronousSubProcesses$UPDATES- See Also:
-
getLinkProcessesForProcess$UPDATES
static final boolean getLinkProcessesForProcess$UPDATES- See Also:
-
getAsynchronousSubProcessesForProcess$UPDATES
static final boolean getAsynchronousSubProcessesForProcess$UPDATES- See Also:
-
isLinkProcess$UPDATES
static final boolean isLinkProcess$UPDATES- See Also:
-
isAsynchronousSubProcess$UPDATES
static final boolean isAsynchronousSubProcess$UPDATES- See Also:
-
getActivityProperties$UPDATES
static final boolean getActivityProperties$UPDATES- See Also:
-
getTaskProperties$UPDATES
static final boolean getTaskProperties$UPDATES- See Also:
-
setTaskProperties$UPDATES
static final boolean setTaskProperties$UPDATES- See Also:
-
setTaskDisplayName$UPDATES
static final boolean setTaskDisplayName$UPDATES- See Also:
-
getProcessProperties$UPDATES
static final boolean getProcessProperties$UPDATES- See Also:
-
setProcessProperties$UPDATES
static final boolean setProcessProperties$UPDATES- See Also:
-
getProcessParameters$UPDATES
static final boolean getProcessParameters$UPDATES- See Also:
-
getProcessParameter$UPDATES
static final boolean getProcessParameter$UPDATES- See Also:
-
getProcessVariables$UPDATES
static final boolean getProcessVariables$UPDATES- See Also:
-
getRecursiveProcessVariables$UPDATES
static final boolean getRecursiveProcessVariables$UPDATES- See Also:
-
getProcessVariablesPaging$UPDATES
static final boolean getProcessVariablesPaging$UPDATES- See Also:
-
getProcessVariable$UPDATES
static final boolean getProcessVariable$UPDATES- See Also:
-
setProcessVariables$UPDATES
static final boolean setProcessVariables$UPDATES- See Also:
-
setProcessVariable$UPDATES
static final boolean setProcessVariable$UPDATES- See Also:
-
addProcessVariable$UPDATES
static final boolean addProcessVariable$UPDATES- See Also:
-
addProcessVariables$UPDATES
static final boolean addProcessVariables$UPDATES- See Also:
-
getSecurityForProcess$UPDATES
static final boolean getSecurityForProcess$UPDATES- See Also:
-
setSecurityForProcess$UPDATES
static final boolean setSecurityForProcess$UPDATES- See Also:
-
getSecurityForNode$UPDATES
static final boolean getSecurityForNode$UPDATES- See Also:
-
setSecurityForNode$UPDATES
static final boolean setSecurityForNode$UPDATES- See Also:
-
setActorsInRolesForProcess$UPDATES
static final boolean setActorsInRolesForProcess$UPDATES- See Also:
-
setActorsInRolesForNode$UPDATES
static final boolean setActorsInRolesForNode$UPDATES- See Also:
-
setInheritanceForProcess$UPDATES
static final boolean setInheritanceForProcess$UPDATES- See Also:
-
setInheritanceForNode$UPDATES
static final boolean setInheritanceForNode$UPDATES- See Also:
-
getPermissionsForProcess$UPDATES
static final boolean getPermissionsForProcess$UPDATES- See Also:
-
getPermissionsForProcesses$UPDATES
static final boolean getPermissionsForProcesses$UPDATES- See Also:
-
getPermissionsForNode$UPDATES
static final boolean getPermissionsForNode$UPDATES- See Also:
-
getPermissionsForNodes$UPDATES
static final boolean getPermissionsForNodes$UPDATES- See Also:
-
getPermissionsForProcessDiagram$UPDATES
static final boolean getPermissionsForProcessDiagram$UPDATES- See Also:
-
getAttachmentsForProcess$UPDATES
static final boolean getAttachmentsForProcess$UPDATES- See Also:
-
getAttachmentsAndNotesForTask$UPDATES
static final boolean getAttachmentsAndNotesForTask$UPDATES- See Also:
-
getAttachmentsForTask$UPDATES
static final boolean getAttachmentsForTask$UPDATES- See Also:
-
removeProcessAttachments$UPDATES
static final boolean removeProcessAttachments$UPDATES- See Also:
-
removeProcessAttachment$UPDATES
static final boolean removeProcessAttachment$UPDATES- See Also:
-
removeTaskAttachments$UPDATES
static final boolean removeTaskAttachments$UPDATES- See Also:
-
removeTaskAttachment$UPDATES
static final boolean removeTaskAttachment$UPDATES- See Also:
-
addAttachmentToProcess$UPDATES
static final boolean addAttachmentToProcess$UPDATES- See Also:
-
addAttachmentToProcesses$UPDATES
static final boolean addAttachmentToProcesses$UPDATES- See Also:
-
addAttachmentsToProcess$UPDATES
static final boolean addAttachmentsToProcess$UPDATES- See Also:
-
addAttachmentToTask$UPDATES
static final boolean addAttachmentToTask$UPDATES- See Also:
-
addAttachmentToTasks$UPDATES
static final boolean addAttachmentToTasks$UPDATES- See Also:
-
addAttachmentsToTask$UPDATES
static final boolean addAttachmentsToTask$UPDATES- See Also:
-
getDeadlineForProcess$UPDATES
static final boolean getDeadlineForProcess$UPDATES- See Also:
-
setDeadlineForProcess$UPDATES
static final boolean setDeadlineForProcess$UPDATES- See Also:
-
getDeadlineForTask$UPDATES
static final boolean getDeadlineForTask$UPDATES- See Also:
-
setDeadlineForTask$UPDATES
static final boolean setDeadlineForTask$UPDATES- See Also:
-
getPriorityOfTask$UPDATES
static final boolean getPriorityOfTask$UPDATES- See Also:
-
getPriorityOfTasks$UPDATES
static final boolean getPriorityOfTasks$UPDATES- See Also:
-
getPriorityOfProcess$UPDATES
static final boolean getPriorityOfProcess$UPDATES- See Also:
-
getPriorityOfProcesses$UPDATES
static final boolean getPriorityOfProcesses$UPDATES- See Also:
-
setPriorityOfTask$UPDATES
static final boolean setPriorityOfTask$UPDATES- See Also:
-
setPriorityOfTasks$UPDATES
static final boolean setPriorityOfTasks$UPDATES- See Also:
-
setPriorityOfProcess$UPDATES
static final boolean setPriorityOfProcess$UPDATES- See Also:
-
setPriorityOfProcesses$UPDATES
static final boolean setPriorityOfProcesses$UPDATES- See Also:
-
raisePriorityOfTask$UPDATES
static final boolean raisePriorityOfTask$UPDATES- See Also:
-
raisePriorityOfTasks$UPDATES
static final boolean raisePriorityOfTasks$UPDATES- See Also:
-
raisePriorityOfProcess$UPDATES
static final boolean raisePriorityOfProcess$UPDATES- See Also:
-
raisePriorityOfProcesses$UPDATES
static final boolean raisePriorityOfProcesses$UPDATES- See Also:
-
lowerPriorityOfTask$UPDATES
static final boolean lowerPriorityOfTask$UPDATES- See Also:
-
lowerPriorityOfTasks$UPDATES
static final boolean lowerPriorityOfTasks$UPDATES- See Also:
-
lowerPriorityOfProcess$UPDATES
static final boolean lowerPriorityOfProcess$UPDATES- See Also:
-
lowerPriorityOfProcesses$UPDATES
static final boolean lowerPriorityOfProcesses$UPDATES- See Also:
-
containsLinkProcessesInheritingPriority$UPDATES
static final boolean containsLinkProcessesInheritingPriority$UPDATES- See Also:
-
containsSubProcessesInheritingPriority$UPDATES
static final boolean containsSubProcessesInheritingPriority$UPDATES- See Also:
-
createNoteMetadata$UPDATES
static final boolean createNoteMetadata$UPDATES- See Also:
-
createNoteMetadatas$UPDATES
static final boolean createNoteMetadatas$UPDATES- See Also:
-
getNotePath$UPDATES
static final boolean getNotePath$UPDATES- See Also:
-
getNotePaths$UPDATES
static final boolean getNotePaths$UPDATES- See Also:
-
getCurrentNotePaths$UPDATES
static final boolean getCurrentNotePaths$UPDATES- See Also:
-
setCurrentNotePaths$UPDATES
static final boolean setCurrentNotePaths$UPDATES- See Also:
-
getExceptionNoteMetadataForTask$UPDATES
static final boolean getExceptionNoteMetadataForTask$UPDATES- See Also:
-
getExceptionNoteMetadatasForProcess$UPDATES
static final boolean getExceptionNoteMetadatasForProcess$UPDATES- See Also:
-
getAllExceptionNoteMetadatasForProcess$UPDATES
static final boolean getAllExceptionNoteMetadatasForProcess$UPDATES- See Also:
-
createNoteMetadataForProcess$UPDATES
static final boolean createNoteMetadataForProcess$UPDATES- See Also:
-
createNoteMetadataForProcesses$UPDATES
static final boolean createNoteMetadataForProcesses$UPDATES- See Also:
-
createNoteMetadatasForProcess$UPDATES
static final boolean createNoteMetadatasForProcess$UPDATES- See Also:
-
getNoteMetadatasForProcess$UPDATES
static final boolean getNoteMetadatasForProcess$UPDATES- See Also:
-
getNoteMetadatasForProcesses$UPDATES
static final boolean getNoteMetadatasForProcesses$UPDATES- See Also:
-
createNoteMetadataForTask$UPDATES
static final boolean createNoteMetadataForTask$UPDATES- See Also:
-
createNoteMetadataForTasks$UPDATES
static final boolean createNoteMetadataForTasks$UPDATES- See Also:
-
createNoteMetadatasForTask$UPDATES
static final boolean createNoteMetadatasForTask$UPDATES- See Also:
-
getNoteMetadatasForTask$UPDATES
static final boolean getNoteMetadatasForTask$UPDATES- See Also:
-
getNoteMetadatasForTasks$UPDATES
static final boolean getNoteMetadatasForTasks$UPDATES- See Also:
-
deleteNoteMetadataForProcess$UPDATES
static final boolean deleteNoteMetadataForProcess$UPDATES- See Also:
-
deleteNoteMetadataForTask$UPDATES
static final boolean deleteNoteMetadataForTask$UPDATES- See Also:
-
deleteNoteMetadatasForProcess$UPDATES
static final boolean deleteNoteMetadatasForProcess$UPDATES- See Also:
-
deleteNoteMetadatasForTask$UPDATES
static final boolean deleteNoteMetadatasForTask$UPDATES- See Also:
-
updateNoteMetadataForProcess$UPDATES
static final boolean updateNoteMetadataForProcess$UPDATES- See Also:
-
updateNoteMetadataForTask$UPDATES
static final boolean updateNoteMetadataForTask$UPDATES- See Also:
-
updateNoteMetadatasForProcess$UPDATES
static final boolean updateNoteMetadatasForProcess$UPDATES- See Also:
-
updateNoteMetadatasForTask$UPDATES
static final boolean updateNoteMetadatasForTask$UPDATES- See Also:
-
getNoteMetadataForTask$UPDATES
static final boolean getNoteMetadataForTask$UPDATES- See Also:
-
getNoteMetadataForProcess$UPDATES
static final boolean getNoteMetadataForProcess$UPDATES- See Also:
-
getTasksForProcess$UPDATES
static final boolean getTasksForProcess$UPDATES- See Also:
-
pauseProcess$UPDATES
static final boolean pauseProcess$UPDATES- See Also:
-
pauseProcesses$UPDATES
static final boolean pauseProcesses$UPDATES- See Also:
-
resumeProcess$UPDATES
static final boolean resumeProcess$UPDATES- See Also:
-
resumeProcesses$UPDATES
static final boolean resumeProcesses$UPDATES- See Also:
-
cancelProcesses$UPDATES
static final boolean cancelProcesses$UPDATES- See Also:
-
startQuickTask$UPDATES
static final boolean startQuickTask$UPDATES- See Also:
-
startTask$UPDATES
static final boolean startTask$UPDATES- See Also:
-
startTasks$UPDATES
static final boolean startTasks$UPDATES- See Also:
-
resumeTask$UPDATES
static final boolean resumeTask$UPDATES- See Also:
-
resumeTasks$UPDATES
static final boolean resumeTasks$UPDATES- See Also:
-
pauseTask$UPDATES
static final boolean pauseTask$UPDATES- See Also:
-
pauseTasks$UPDATES
static final boolean pauseTasks$UPDATES- See Also:
-
cancelTask$UPDATES
static final boolean cancelTask$UPDATES- See Also:
-
cancelTasks$UPDATES
static final boolean cancelTasks$UPDATES- See Also:
-
startAllNodes$UPDATES
static final boolean startAllNodes$UPDATES- See Also:
-
restartAllNodes$UPDATES
static final boolean restartAllNodes$UPDATES- See Also:
-
pauseAllNodes$UPDATES
static final boolean pauseAllNodes$UPDATES- See Also:
-
resumeAllNodes$UPDATES
static final boolean resumeAllNodes$UPDATES- See Also:
-
cancelAllNodes$UPDATES
static final boolean cancelAllNodes$UPDATES- See Also:
-
reassignTaskToSameAssigneePool$UPDATES
static final boolean reassignTaskToSameAssigneePool$UPDATES- See Also:
-
reassignTasksToAssigneePool$UPDATES
static final boolean reassignTasksToAssigneePool$UPDATES- See Also:
-
reassignTasksToSameAssigneePool$UPDATES
static final boolean reassignTasksToSameAssigneePool$UPDATES- See Also:
-
getProcessDiagram$UPDATES
static final boolean getProcessDiagram$UPDATES- See Also:
-
updateProcessModelForProcess$UPDATES
static final boolean updateProcessModelForProcess$UPDATES- See Also:
-
upgradeProcesses$UPDATES
static final boolean upgradeProcesses$UPDATES- See Also:
-
triggerSchedule$UPDATES
static final boolean triggerSchedule$UPDATES- See Also:
-
triggerTaskEscalation$UPDATES
static final boolean triggerTaskEscalation$UPDATES- See Also:
-
skipTaskEscalation$UPDATES
static final boolean skipTaskEscalation$UPDATES- See Also:
-
getScheduleSummariesForNode$UPDATES
static final boolean getScheduleSummariesForNode$UPDATES- See Also:
-
lockProcessModelForProcess$UPDATES
static final boolean lockProcessModelForProcess$UPDATES- See Also:
-
lockProcesses$UPDATES
static final boolean lockProcesses$UPDATES- See Also:
-
unlockProcesses$UPDATES
static final boolean unlockProcesses$UPDATES- See Also:
-
unlockProcessModelForProcess$UPDATES
static final boolean unlockProcessModelForProcess$UPDATES- See Also:
-
unlockProcessModels$UPDATES
static final boolean unlockProcessModels$UPDATES- See Also:
-
getMaximumNumberOfNotes$UPDATES
static final boolean getMaximumNumberOfNotes$UPDATES- See Also:
-
getMaximumNumberOfAttachments$UPDATES
static final boolean getMaximumNumberOfAttachments$UPDATES- See Also:
-
skipRecurrence$UPDATES
static final boolean skipRecurrence$UPDATES- See Also:
-
triggerRecurrence$UPDATES
static final boolean triggerRecurrence$UPDATES- See Also:
-
setTaskStateSubmitted$UPDATES
static final boolean setTaskStateSubmitted$UPDATES- See Also:
-
keepSubmittedTasksAlive$UPDATES
static final boolean keepSubmittedTasksAlive$UPDATES- See Also:
-
setTaskStateRunning$UPDATES
static final boolean setTaskStateRunning$UPDATES- See Also:
-
getCurrentTasksForProcess$UPDATES
static final boolean getCurrentTasksForProcess$UPDATES- See Also:
-
getCompletedTasksForProcess$UPDATES
static final boolean getCompletedTasksForProcess$UPDATES- See Also:
-
getCancelledTasksForProcess$UPDATES
static final boolean getCancelledTasksForProcess$UPDATES- See Also:
-
getPausedTasksForProcess$UPDATES
static final boolean getPausedTasksForProcess$UPDATES- See Also:
-
getTasksWithExceptionsForProcess$UPDATES
static final boolean getTasksWithExceptionsForProcess$UPDATES- See Also:
-
unarchiveProcess$UPDATES
static final boolean unarchiveProcess$UPDATES- See Also:
-
unarchiveProcesses$UPDATES
static final boolean unarchiveProcesses$UPDATES- See Also:
-
archiveProcess$UPDATES
static final boolean archiveProcess$UPDATES- See Also:
-
archiveProcesses$UPDATES
static final boolean archiveProcesses$UPDATES- See Also:
-
getArchivePaths$UPDATES
static final boolean getArchivePaths$UPDATES- See Also:
-
setArchivePaths$UPDATES
static final boolean setArchivePaths$UPDATES- See Also:
-
getNextRecurrence$UPDATES
static final boolean getNextRecurrence$UPDATES- See Also:
-
getAttachmentsInProcess$UPDATES
static final boolean getAttachmentsInProcess$UPDATES- See Also:
-
getNoteMetadatasInProcess$UPDATES
static final boolean getNoteMetadatasInProcess$UPDATES- See Also:
-
updateUsernames$UPDATES
static final boolean updateUsernames$UPDATES- See Also:
-
commitUpdateUsernames$UPDATES
static final boolean commitUpdateUsernames$UPDATES- See Also:
-
rollbackUpdateUsernames$UPDATES
static final boolean rollbackUpdateUsernames$UPDATES- See Also:
-
uncompleteActivity$UPDATES
static final boolean uncompleteActivity$UPDATES- See Also:
-
setApplicationAdministratorGroup$UPDATES
static final boolean setApplicationAdministratorGroup$UPDATES- See Also:
-
reloadProperties$UPDATES
static final boolean reloadProperties$UPDATES- See Also:
-
validate$UPDATES
static final boolean validate$UPDATES- See Also:
-
setSiteLocaleSettings$UPDATES
static final boolean setSiteLocaleSettings$UPDATES- See Also:
-
handleMessages$UPDATES
static final boolean handleMessages$UPDATES- See Also:
-
acknowledgeMessages$UPDATES
static final boolean acknowledgeMessages$UPDATES- See Also:
-
getPmIdForProcess$UPDATES
static final boolean getPmIdForProcess$UPDATES- See Also:
-
addProcessToFavorites$UPDATES
static final boolean addProcessToFavorites$UPDATES- See Also:
-
removeProcessFromFavorites$UPDATES
static final boolean removeProcessFromFavorites$UPDATES- See Also:
-
addTaskToFavorites$UPDATES
static final boolean addTaskToFavorites$UPDATES- See Also:
-
removeTaskFromFavorites$UPDATES
static final boolean removeTaskFromFavorites$UPDATES- See Also:
-
setDashboardPageForProcesses$UPDATES
static final boolean setDashboardPageForProcesses$UPDATES- See Also:
-
removeDashboardPageForProcesses$UPDATES
static final boolean removeDashboardPageForProcesses$UPDATES- See Also:
-
getAutoArchiveProperties$UPDATES
static final boolean getAutoArchiveProperties$UPDATES- See Also:
-
getMemoryUsageForExecEngine$UPDATES
static final boolean getMemoryUsageForExecEngine$UPDATES- See Also:
-
getMemoryUsageForProcessModels$UPDATES
static final boolean getMemoryUsageForProcessModels$UPDATES- See Also:
-
getMemoryUsageForProcessModelsByUUID$UPDATES
static final boolean getMemoryUsageForProcessModelsByUUID$UPDATES- See Also:
-
getMemoryUsageForProcesses$UPDATES
static final boolean getMemoryUsageForProcesses$UPDATES- See Also:
-
getMemoryUsageForProcessesByModelUUID$UPDATES
static final boolean getMemoryUsageForProcessesByModelUUID$UPDATES- See Also:
-
getMemoryUsageForNodesInProcesses$UPDATES
static final boolean getMemoryUsageForNodesInProcesses$UPDATES- See Also:
-
setTimeZone$UPDATES
static final boolean setTimeZone$UPDATES- See Also:
-
setTimeZoneSameAs$UPDATES
static final boolean setTimeZoneSameAs$UPDATES- See Also:
-
getProcessHistoryRecords$UPDATES
static final boolean getProcessHistoryRecords$UPDATES- See Also:
-
getProcessHistoryRecordsPaging$UPDATES
static final boolean getProcessHistoryRecordsPaging$UPDATES- See Also:
-
getTasksWithStatusForProcessModel$UPDATES
static final boolean getTasksWithStatusForProcessModel$UPDATES- See Also:
-
getTasksWithStatusForProcessModels$UPDATES
static final boolean getTasksWithStatusForProcessModels$UPDATES- See Also:
-
getTasksWithStatusForProcess$UPDATES
static final boolean getTasksWithStatusForProcess$UPDATES- See Also:
-
getTasksWithStatusForProcesses$UPDATES
static final boolean getTasksWithStatusForProcesses$UPDATES- See Also:
-
completeStore$UPDATES
static final boolean completeStore$UPDATES- See Also:
-
cancelStore$UPDATES
static final boolean cancelStore$UPDATES- See Also:
-
processToNextAttended$UPDATES
static final boolean processToNextAttended$UPDATES- See Also:
-
-
Method Details
-
saveActivityParameters
void saveActivityParameters(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 togetActivityMetadata(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 toexecute(Long). The following fields must be populated in theActivityClassParameterobjects:id,value,type, andmultiple- Parameters:
activityId_- the id of the activity whose parameters will be savedacps_- the parameters for the activity class, with desired values filled-in.- Throws:
InvalidActivityException- if the activity specified does not existPrivilegeException- if the current user does not have permission to perform this actionNullPointerException- ifacps_is nullInvalidActivityClassParameterException- if anActivityClassParameterprovided does not existInvalidUserException- if any of the users referenced by aActivityClassParameterdoes not existServiceException- if any system-level error occurs
-
completeActivity
Long completeActivity(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. TheActivityReturnVariables should be the identical to those provided bygetActivityMetadata(java.lang.Long), except for having the values filled-in.- Parameters:
activityId_- the id of the activity that has been completedoutputs_- the return values of the completed activity- Returns:
- the id of the next task for the user to perform, if available;
nullotherwise. - Throws:
InvalidActivityException- if the activity does not existInvalidStateException- if activity is in a state other than in-progress, or if it is not a Java activity (attended or unattended)NullPointerException- ifoutputs_is nullPrivilegeException- (for attended only) if user is not the task owner or does not have permission to complete taskInvalidActivityClassParameterException- if anActivityClassParameterprovided does not existInvalidUserException- if any of the users referenced by aActivityReturnVariabledo not existServiceException- if any system-level error occurs
-
acknowledgeActivity
Deprecated.no longer necessaryAcknowledge 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 existServiceException- if any system-level error occurs
-
acknowledgeActivity
Deprecated.no longer necessaryAcknowledge 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 existServiceException- if any system-level error occurs
-
completeClone
Long completeClone(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 completeinputs_- the parameters for the activity class, with desired values filled inoutputs_- the return values of the completed activity- Returns:
- the id of the next task for the user to perform, if available;
nullotherwise - Throws:
InvalidActivityException- if the activity does not existInvalidStateException- 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 taskInvalidActivityClassParameterException- if anActivityClassParameterprovided does not existInvalidUserException- if any of the users referenced by aActivityReturnVariabledo not exist
-
getLingeringTasksForProcess
ResultPage getLingeringTasksForProcess(Long processId_, boolean recursive, int startIndex_, int batchSize_, Integer sortProperty_, 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 retrievedrecursive- whether to return the lingering tasks of the sub-processes of the given process alsostartIndex_- 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 ofConstants.COUNT_ALLwill 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 theSORT_BY_XXXconstants inTaskSummarysortOrder_-Constants.SORT_ORDER_ASCENDINGfor sorting results in ascending order,Constants.SORT_ORDER_DESCENDINGfor sorting results in descending order- Returns:
- a ResultPage of TaskSummary objects
- Throws:
InvalidProcessException- if the given process id is invalid
-
getLingeringTasksForProcessAndNode
TaskSummary[] getLingeringTasksForProcessAndNode(Long processId_, 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 nodesnodeId_- 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 invalidInvalidNodeException- if the given node id is invalid
-
refreshTaskForm
@Deprecated void refreshTaskForm(Long activityId_) throws InvalidActivityException, 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 invalidIllegalArgumentException- if the given task is not attendedPrivilegeException- if the current user does not have sufficient privileges to complete the given task
-
execute
Long execute(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 throughsaveActivityParameters(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;
nullotherwise. - Throws:
InvalidActivityException- if the task does not existPrivilegeException- if user is not the task owner or does not have permission to complete taskInvalidStateException- 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
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 (seeexecute(java.lang.Long)) or outside of the engine (seecompleteActivity(java.lang.Long, com.appiancorp.suiteapi.process.ActivityReturnVariable[])).- Parameters:
activityId_- the id of the activity for which to get metadata- Returns:
ActivityExecutionMetadatafor the activity- Throws:
InvalidActivityException- if the activity does not existServiceException- if any system-level error occurs
-
getActivitiesMetadata
ActivityExecutionMetadata[] getActivitiesMetadata(Long[] activityIds_) throws InvalidActivityException Gets metadata for the specified activities. This method performs the same asgetActivityMetadata(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 existServiceException- if any system-level error occurs
-
getTaskFormExpression
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 existServiceException- if any system-level error occurs
-
getTaskFormExpressions
Gets task form expressions for the specified tasks. This method performs the same asgetTaskFormExpression(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 existServiceException- if any system-level error occurs
-
acceptTask
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_XXXconstants. - Throws:
InvalidActivityException- if the task does not existPrivilegeException- if the current user does not have permission to perform this actionServiceException- if any system-level error occurs
-
getTaskPrivileges
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_XXXconstants. If the task is completed then this method will always returnTASK_PRIVILEGE_REASSIGN_ANY. - Throws:
InvalidActivityException- if the task does not existPrivilegeException- if the current user does not have permission to perform this actionServiceException- if any system-level error occurs
-
getTaskAssignees
Assignment.Assignee[] getTaskAssignees(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 existPrivilegeException- if the current user does not have permission to perform this actionServiceException- if any system-level error occurs
-
getTasksAssignees
Assignment.Assignee[][] getTasksAssignees(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 existPrivilegeException- if the current user does not have permission to perform this actionServiceException- if any system-level error occurs
-
getAssigneePoolForTasks
Assignment.Assignee[] getAssigneePoolForTasks(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 existInvalidOperationException- if any task is unattendedPrivilegeException- if the current user does not have permission to perform this actionServiceException- if any system-level error occurs
-
reassignTask
void reassignTask(Long taskId_, Assignment.Assignee[] assignees_) throws InvalidActivityException, InvalidStateException, PrivilegeException, InvalidUserException, InvalidOperationException Reassigns a task to new assignees.- Parameters:
taskId_- ID of the task to reassignassignees_- the new assignees for the task. Note that theprivilegefield will be ignored for all assignees that are already in the assignment pool.- Throws:
InvalidActivityException- if the task does not existInvalidStateException- if the task has been cancelledPrivilegeException- if the user does not have sufficient privileges to perform this actionInvalidUserException- if any of the users referenced by anAssignment.Assigneedoes not existServiceException- if any system-level error occursInvalidOperationException
-
rejectTask
Integer rejectTask(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_SUCCESSTASK_REJECTION_RESULT_INVALID_STATETASK_REJECTION_RESULT_NOT_OWNER - Throws:
InvalidActivityException- if the task is invalidPrivilegeException- 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 occursInvalidStateExceptionInvalidOperationException
-
getTaskDetails
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
TaskDetailsbean will be an empty array. - Throws:
InvalidActivityException- if the task does not existPrivilegeException- if the current user does not have permission to perform this actionServiceException- if any system-level error occurs
-
getTasksDetails
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
TaskDetailsbean will be an empty array. - Throws:
InvalidActivityException- if the task does not existPrivilegeException- if the current user does not have permission to perform this actionServiceException- if any system-level error occurs
-
getTaskOpaqueUri
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
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(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 existPrivilegeException- if the user does not have sufficient privileges to perform this actionServiceException- if any system-level error occursArchivedProcessException
-
notifyException
void notifyException(Long activityId_, String exceptionClassName_, String message_, 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 occurredexceptionClassName_- the fully qualified class name of the exceptionmessage_- message of the exceptionstackTrace_- stack trace of the exception- Throws:
InvalidActivityException- if the activity specified does not existInvalidStateException- if the process is in any state other than in-progressServiceException- if any system-level error occurs
-
executionFailure
@Deprecated void executionFailure(int errorType_, Long[] activities_) throws InvalidActivityException, InvalidStateException, 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 theEXECUTION_FAILURE_XXXconstants. ForEXECUTION_FAILURE_EXCEPTION, don't attempt to execute again until configurable delay has passed. ForEXECUTION_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 existInvalidStateException- 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 activityIllegalArgumentException- iferrorType_is invalidServiceException- if any system-level error occurs
-
executionFailureMessage
@Deprecated void executionFailureMessage(int errorType_, Long[] activities_, String message_) throws InvalidActivityException, InvalidStateException, 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 theEXECUTION_FAILURE_XXXconstants. ForEXECUTION_FAILURE_EXCEPTION, don't attempt to execute again until configurable delay has passed. ForEXECUTION_FAILURE_TIMEOUT, attempt to execute again at next usual execution time.activities_- activities that failed to executemessage_- exception message- Throws:
InvalidActivityException- if the activity specified does not existInvalidStateException- 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 activityIllegalArgumentException- iferrorType_is invalidServiceException- if any system-level error occurs
-
deleteProcess
void deleteProcess(Long processId_, boolean deleteSubProcesses_) throws InvalidProcessException, PrivilegeException Deletes the specified process. Purges process history in Kafka.- Parameters:
processId_- the id of the process to deletedeleteSubProcesses_-trueif all the sub processes in this process should also be deleted;falseif not.- Throws:
InvalidProcessException- if the process does not existPrivilegeException- If the user does not have sufficient privileges to perform this actionServiceException- if any system-level error occurs
-
deleteProcesses
void deleteProcesses(Long[] processIds_, boolean deleteSubProcesses_) throws InvalidProcessException, PrivilegeException Deletes all of the specified processes. This method performs the same asdeleteProcess(java.lang.Long, boolean), but in bulk. Purges process history in Kafka.- Parameters:
processIds_- the ids of the processes to deletedeleteSubProcesses_-trueif all the sub processes should be deleted;falseif not.- Throws:
InvalidProcessException- if the process does not existPrivilegeException- If the user does not have sufficient privileges to perform this actionServiceException- if any system-level error occurs
-
cancelProcess
void cancelProcess(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 cancelcancelLinkedProcesses_-trueif all the linked processes should be cancelled;falseif not.- Throws:
InvalidProcessException- if the specified process does not existInvalidStateException- if the specified process is not active or already cancelledPrivilegeException- if the current user does not have privileges to cancel the specified processLockException- if the process is lockedServiceException- if any system-level error occurs- See Also:
-
notifyInvalidParameters
void notifyInvalidParameters(Long activityId_, ActivityClassParameter[] acps_) throws InvalidActivityException, InvalidStateException, IllegalArgumentException, InvalidActivityClassParameterException Notifies the user that the parameters sent as inputs to an unattended activity were invalid. This is only called ifActivityParameterHelper.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 failedacps_- The parameters with validation messages populated.- Throws:
InvalidActivityException- if the activity does not existInvalidStateException- if activity is in a state other than in-progressNullPointerException- ifacps_is nullIllegalArgumentException- if the ACP array is empty, or if no ACPs had validation messagesInvalidActivityClassParameterException- if anActivityClassParameterprovided does not existServiceException- if any system-level error occurs
-
notifyUsersCreationByJava
@Deprecated void notifyUsersCreationByJava(Long activityId_, String[] usernames_) throws InvalidActivityException, 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 failedusernames_- the names of the users that were added- Throws:
InvalidActivityException- if the activity does not existNullPointerException- if any of the usernames arenull
-
notifyUsersCreationByJava
Deprecated.done automatically by UserService.createUserNotifies the server that new users were created on the Personalization server- Parameters:
usernames_- the names of the users that were added- Throws:
NullPointerException- if any of the usernames arenull
-
checkActivityValidity
Determines whether the specified activity is valid.- Parameters:
activityId_- the id of the activity- Returns:
- one of the
ACTIVITY_XXXconstants - Throws:
NullPointerException- if the activityId_ is nullServiceException- if any system-level error occurs
-
canCompleteActivity
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,falsewill be returned.- Parameters:
activityId_- the id of the activity- Returns:
true, if the user can complete the activity;falseotherwise- Throws:
ServiceException- if any system-level error occurs
-
canCompleteClone
Indicates whether the current user can usecompleteClone(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(Long processId_, int subProcessStatus_) throws InvalidProcessException, PrivilegeException Deprecated.UsegetSynchronousSubProcessesForProcess(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 theSTATE_XXXconstants inProcessSummary. UseConstants.COUNT_ALLto retrieve subprocesses in any state.- Returns:
- A
ResultListcontainingProcessSummaryobjects for the subprocesses of the given process. The result codes can beResultList.CODE_NO_PERMISSIONorResultList.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(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 forsynchronousSubProcessStatus_- filters results by returning only those subprocesses with the status given here. Possible statuses are defined inProcessSummaryand look likeSTATE_XXX. UseConstants.COUNT_ALLto return ALL synchronous subprocesses, without filtering by status.- Returns:
- a
ResultListcontainingProcessSummaryobjects that represent the synchronous subprocesses. TheResultList's result codes can be:ResultList.CODE_VALIDif the nth subprocess is accessible, orResultList.CODE_NO_PERMISSIONif the user does not have permission to access the nth subprocess. - Throws:
InvalidProcessException- if the process is invalidPrivilegeException- if the user does not have sufficient privileges to perform this operationServiceException- if any system-level error occurs
-
getTopLevelProcessForProcess
ProcessSummary getTopLevelProcessForProcess(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
ProcessSummaryof 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 processInvalidProcessException- if the process specified does not existServiceException- if any system-level error occurs
-
isSubProcess
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:
trueif the process given is a subprocess, otherwisefalse- Throws:
InvalidProcessException- if the process specified does not existServiceException- if any system-level error occurs
-
isSynchronousSubProcess
Determines whether or not the given process is a synchronous subprocess.- Parameters:
processId_- the ID of the process to check- Returns:
trueif the process given is a synchronous subprocess, otherwisefalse- Throws:
InvalidProcessException- if the process specified does not existServiceException- if any system-level error occurs
-
containsSubProcesses
Deprecated.UsecontainsSynchronousSubProcesses(Long)instead.Determines whether or not the given process contains subprocesses.- Parameters:
processId_- the id of the process to check for subprocesses- Returns:
trueif the process given contains subprocesses, otherwisefalse- Throws:
InvalidProcessException- if the process specified does not existServiceException- if any system-level error occurs
-
containsLinkProcesses
Deprecated.UsecontainsAsynchronousSubProcesses(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:
trueif the process given contains linked processes, otherwisefalse- Throws:
ServiceException- if any system-level error occursInvalidProcessException
-
containsSynchronousSubProcesses
Determines whether or not the given process contains synchronous subprocesses.- Parameters:
processId_- the id of the process to check- Returns:
trueif the process given contains synchronous subprocesses, otherwisefalse- Throws:
InvalidProcessException- if the process specified does not existServiceException- if any system-level error occurs
-
containsSynchronousSubProcesses
- Throws:
InvalidProcessException
-
containsAsynchronousSubProcesses
Determines whether or not the given process contains asynchronous subprocesses.- Parameters:
processId_- the id of the process to check- Returns:
trueif the process given contains asynchronous subprocesses, otherwisefalse- Throws:
InvalidProcessException- if the process specified does not existServiceException- if any system-level error occurs
-
containsAsynchronousSubProcesses
- Throws:
InvalidProcessException
-
getLinkProcessesForProcess
@Deprecated ResultList getLinkProcessesForProcess(Long processId_, int linkProcessStatus_) throws InvalidProcessException, PrivilegeException Deprecated.UsegetAsynchronousSubProcessesForProcess(Long, int)instead.Gets the linked processes of the given process- Parameters:
processId_- the id of the process to get linked processes forlinkProcessStatus_- the status of the linked processes to get; designated by one of theSTATE_XXXconstants inProcessSummary, orConstants.COUNT_ALLto return linked processes of any status- Returns:
- a ResultList containing
ProcessSummaryobjects for the linked processes of the given process. The result codes can be:ResultList.CODE_VALIDif the action succeeded, orResultList.CODE_NO_PERMISSIONif the user does not have permission - Throws:
InvalidProcessException- if the process is invalidPrivilegeException- if the user does not have sufficient privileges to perform this operationServiceException- if any system-level error occurs
-
getAsynchronousSubProcessesForProcess
ResultList getAsynchronousSubProcessesForProcess(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 forasynchronousSubProcessStatus_- filters results by returning only those subprocesses with the status given here. Possible statuses are defined inProcessSummaryand look likeSTATE_XXX. UseConstants.COUNT_ALLto return ALL asynchronous subprocesses, without filtering by status.- Returns:
- a
ResultListcontainingProcessSummaryobjects that represent the asynchronous subprocesses. TheResultList's result codes can be:ResultList.CODE_VALIDif the nth subprocess is accessible, orResultList.CODE_NO_PERMISSIONif the user does not have permission to access the nth subprocess. - Throws:
InvalidProcessException- if the process is invalidPrivilegeException- if the user does not have sufficient privileges to perform this operationServiceException- if any system-level error occurs
-
isLinkProcess
Deprecated.UseisAsynchronousSubProcess(Long)instead.Determines whether or not the given process is a linked process.- Parameters:
processId_- the ID of the process to check- Returns:
trueif the given process is a linked process, otherwisefalse- Throws:
InvalidProcessException- if the process specified does not existServiceException- if any system-level error occurs
-
isAsynchronousSubProcess
Determines whether or not the given process is an asynchronous subprocess.- Parameters:
processId_- the ID of the process to check- Returns:
trueif the given process is an asynchronous subprocess, otherwisefalse- Throws:
InvalidProcessException- if the process specified does not existServiceException- if any system-level error occurs
-
getActivityProperties
ActivityProperties getActivityProperties(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 accessInvalidActivityException- if no activity exists with the given idServiceException- if any system-level error occurs
-
getTaskProperties
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 theidof the given properties object. The following fields must be populated in theTaskPropertiesobject:displayName,priority, andidTheidfield must be populated in theprioritymember of theTaskPropertiesobject OnlydisplayNameandpriority.idmay be updated- Parameters:
properties_- the properties of the task- Throws:
PrivilegeException- if the user does not have accessInvalidActivityException- if no activity exists with the given idInvalidPriorityException- if the call tries to set the priority of the task to an invalid valueServiceException- if any system-level error occurs
-
setTaskDisplayName
void setTaskDisplayName(Long taskId, LocaleString displayName) throws PrivilegeException, 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 updateddisplayName- the string for the new display name- Throws:
InvalidActivityException- if there is no task for the specified taskIdIllegalArgumentException- if the display name is null, empty, or invalidPrivilegeException- if the user lacks permissions to perform the action
-
getProcessProperties
ProcessProperties getProcessProperties(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 theidof the given properties object. Onlynameandpriority.idcan be updated for the process.- Parameters:
properties_- The updated properties of the process. Onlynameandpriority.idcan be updated for the process. The following fields must be populated in the passed object:id,name, andpriority. Theidfield in theprioritymember of the passedProcessPropertiesobject must also be populated.- Throws:
PrivilegeException- if the user does not have privileges to perform the given operationInvalidProcessException- if no process exists with the given idInvalidPriorityException- if the call tries to set the priority of the process to an invalid valueInvalidUserException- if any of the users referenced by theProcessPropertiesdoes not existServiceException- if any system-level error occurs
-
getProcessParameters
ProcessVariableInstance[] getProcessParameters(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(Long processId_, String parameterName_) throws InvalidProcessException, InvalidProcessVariableNameException, PrivilegeException Retrieves the specified process parameter of the specified process.- Parameters:
processId_- The id of the processparameterName_- 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(Long processId_) throws InvalidProcessException, PrivilegeException Deprecated.UsegetRecursiveProcessVariables(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(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(Long processId_, int startIndex_, int batchSize_, Integer sortProperty_, 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 ofConstants.COUNT_ALLwill 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 theSORT_BY_XXXconstants inProcessVariablesortOrder_-Constants.SORT_ORDER_ASCENDINGfor sorting results in ascending order,Constants.SORT_ORDER_DESCENDINGfor 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(Long processId_, 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(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 viagetProcessVariables(java.lang.Long), and their values set appropriately, before calling this method.- Parameters:
pProcessId_- the id of the processpvs_- the variables to set- Throws:
InvalidProcessException- if no such process existsInvalidProcessVariableNameException- if one of the names in pvs_ refers to a variable that does not exist in the given processPrivilegeException- if the user does not have sufficent privielges to perform this operationInvalidUserException- if any of the users referenced by aProcessVariabledoes not existServiceException- if any system-level error occurs
-
setProcessVariable
void setProcessVariable(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 throughProcessExecutionService#addProcessVariable(Long, ProcessVariable)orProcessExecutionService#addProcessVariables(Long, ProcessVariable[]). The process variable should be first retrieved viagetProcessVariable(java.lang.Long, java.lang.String), and its values set appropriately, before calling this method.- Parameters:
pProcessId_- the id of the processpv_- the variable to set- Throws:
InvalidProcessException- if no such process existsInvalidProcessVariableNameException- if thenameof pv_ refers to a variable that does not exist in the given processPrivilegeException- if the user does not have sufficent privielges to perform this operationInvalidUserException- if any of the users referenced by theProcessVariabledoes not existServiceException- if any system-level error occurs
-
addProcessVariable
void addProcessVariable(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
ProcessVariableobject:key,type,multiple, andvalue- Parameters:
processId_- the id of the processpv_- a new variable to add- Throws:
InvalidProcessException- if no such process existsInvalidProcessVariableNameException- if the name of the process variable isnullDuplicateNameException- if a variable with the same name already exists for the processPrivilegeException- if the user does not have sufficent privielges to perform this operationInvalidUserException- if any of the users referenced by theProcessVariabledoes not existServiceException- if any system-level error occurs
-
addProcessVariables
void addProcessVariables(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
ProcessVariableobject:key,type,multiple, andvalue- Parameters:
processId_- the id of the processpvs_- the new variables to add- Throws:
InvalidProcessException- if no such process existsInvalidProcessVariableNameException- if the name of one of the process variables isnullDuplicateNameException- if a variable with the same name as one of the process variables that already exists for the processPrivilegeException- if the user does not have sufficent privileges to perform this operationInvalidUserException- if any of the users referenced by aProcessVariabledoes not existServiceException- if any system-level error occurs
-
getSecurityForProcess
Gets the security configuration of a process.- Parameters:
id_- The id of the process.- Returns:
- a
Securityobject containing aProcessRoleMapwhich encapsulates the security configuration of the process - Throws:
InvalidProcessException- if the process specified does not existPrivilegeException- if the current user does not have changeRole privileges for the processServiceException- if any system-level error occurs
-
setSecurityForProcess
void setSecurityForProcess(Long id_, Security s_) throws InvalidProcessException, PrivilegeException, InvalidUserException Sets the security configuration of a process. This method does NOT setcanInheritandinheritable.- Parameters:
id_- the id of the processs_- aSecurityobject containing aProcessRoleMapwhich encapsulates the security configuration of the process- Throws:
InvalidProcessException- if the process specified does not existPrivilegeException- if the current user does not have changeRole privileges for the processInvalidUserException- if any of the users referenced by theSecuritydoes not existServiceException- if any system-level error occurs
-
getSecurityForNode
Gets the default security configuration of tasks for a specified node.- Parameters:
id_- The id of the primary activity of the node.- Returns:
- a
Securityobject containing aProcessRoleMapwhich encapsulates the security configuration of the process - Throws:
InvalidActivityException- if the task specified does not existPrivilegeException- if the current user does not have changeRole privileges for the taskServiceException- if any system-level error occurs
-
setSecurityForNode
void setSecurityForNode(Long id_, Security s_) throws InvalidActivityException, PrivilegeException, InvalidUserException Sets the default security configuration of tasks for a specified node. This method does NOT setcanInheritandinheritable.- Parameters:
id_- the unique Id of the primary activity of theProcessNodeinstances_- aSecurityobject containing aProcessRoleMapwhich encapsulates the security configuration of the process- Throws:
InvalidActivityException- if the task specified does not existPrivilegeException- if the current user does not have changeRole privileges for the taskInvalidUserException- if any of the users referenced by theSecuritydoes not existServiceException- if any system-level error occurs
-
setActorsInRolesForProcess
void setActorsInRolesForProcess(Long id_, String[] users_, String[][] userRoles_, Long[] groups_, 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 usesetSecurityForProcess(Long, Security)- Parameters:
id_- the id of the processusers_- the list of usernames for users whose roles are to be added/modified. This parameter can be null, as long asuserRoles_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 parallelsusers_. 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 asgroupRoles_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 parallelsgroups_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 existPrivilegeException- if the current user does not have changeRole privileges for the processInvalidUserException- if any of the users referenced does not existServiceException- if any system-level error occurs
-
setActorsInRolesForNode
void setActorsInRolesForNode(Long id_, String[] users_, String[][] userRoles_, Long[] groups_, 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 nodeusers_- the list of usernames for users whose roles are to be added/modified. This parameter can be null, as long asuserRoles_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 parallelsusers_. 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 asgroupRoles_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 parallelsgroups_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 existPrivilegeException- if the current user does not have changeRole privileges for the taskInvalidUserException- if any of the users referenced does not existServiceException- if any system-level error occurs
-
setInheritanceForProcess
void setInheritanceForProcess(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 processdoesInherit_-trueif the process inherits,falseotherwise.- Throws:
InvalidProcessException- if the process specified does not existPrivilegeException- if the current user does not have changeRole privileges for the processServiceException- if any system-level error occurs
-
setInheritanceForNode
void setInheritanceForNode(Long id_, boolean doesInherit_) throws InvalidActivityException, PrivilegeException Sets whether a specified task inherits security from its process.- Parameters:
id_- the id of the taskdoesInherit_-trueif the task inherits,falseotherwise.- Throws:
InvalidActivityException- if the task specified does not existPrivilegeException- if the current user does not have changeRole privileges for the taskServiceException- if any system-level error occurs
-
getPermissionsForProcess
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 existServiceException- if any system-level error occurs
-
getPermissionsForProcesses
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 existServiceException- if any system-level error occurs
-
getPermissionsForNode
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 existServiceException- if any system-level error occurs
-
getPermissionsForNodes
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 existServiceException- if any system-level error occurs
-
getPermissionsForProcessDiagram
ProcessModelPermissions getPermissionsForProcessDiagram(Long processId_) throws InvalidProcessException Gets aProcessModelPermissionsobject 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 existServiceException- if any system-level error occurs
-
getAttachmentsForProcess
ResultPage getAttachmentsForProcess(Long id_, boolean recursive_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidProcessException, PrivilegeException Returns the attachments for a specified process- Parameters:
id_- the id of the processrecursive_- return recursive results if set to truestartIndex_- 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 theSORT_BY_XXXconstants onAttachment.sortOrder_- The order in which to sort the results. This should be eitherConstants.SORT_ORDER_ASCENDINGorConstants.SORT_ORDER_DESCENDING.- Returns:
- a
ResultPagecontaining instances ofAttachment. The result codes can be:ResultList.CODE_VALIDif the action succeeded,ResultList.CODE_NO_PERMISSIONif the user does not have permission, orResultList.CODE_INVALIDif the specified process does not exist - Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the current user does not have permission to perform this actionServiceException- if any system-level errors occur
-
getAttachmentsForProcess
@Deprecated Attachment[] getAttachmentsForProcess(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 existPrivilegeException- if the current user does not have privileges to perform this actionServiceException- if any system-level error occurs
-
getAttachmentsAndNotesForTask
@Deprecated ResultPage getAttachmentsAndNotesForTask(Long taskId_, boolean recursive_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidActivityException, PrivilegeException, InvalidOperationException Deprecated.since 23.2. Retrieving Notes is deprecated, please usegetAttachmentsForTask(java.lang.Long)to retrieve attachmentsReturns the attachments and notes for a specified task- Parameters:
taskId_- the id of the taskrecursive_- 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 theSORT_BY_XXXconstants onAttachment.sortOrder_- The order in which to sort the results. This should be eitherConstants.SORT_ORDER_ASCENDINGorConstants.SORT_ORDER_DESCENDING.- Returns:
- a
ResultPagecontaining instances ofAttachment. The result codes can be:ResultList.CODE_VALIDif the nth attachment/note is accessible,ResultList.CODE_NO_PERMISSIONif the user does not have permission to access the nth attachment/note, orResultList.CODE_INVALIDif the specified attachment/note does not exist - Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the current user does not have permission to perform this actionServiceException- if any system-level errors occurInvalidActivityExceptionInvalidOperationException
-
getAttachmentsForTask
Attachment[] getAttachmentsForTask(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 existPrivilegeException- if the current user does not have privileges to perform this actionInvalidProcessExceptionServiceException- if any system-level error occursInvalidOperationException
-
removeProcessAttachments
Long[] removeProcessAttachments(Long[] attachmentIds_, Long processId_) throws InvalidProcessException, InvalidStateException Removes specified attachments from the specified process.- Parameters:
attachmentIds_- the IDs of the attachments to removeprocessId_- the ID of the process- Returns:
- an
Arraycontaining return codes for each attachment:ATTACHMENT_RETURN_SUCCESSif the attachment was added successfully,ATTACHMENT_RETURN_PERMISSIONSif the user does not have permission to remove the attachment, orATTACHMENT_RETURN_INVALIDif the attachment does not exist - Throws:
InvalidProcessException- if the process specified does not existInvalidStateException- if the process is cancelledServiceException- if any system-level error occurs
-
removeProcessAttachment
Long removeProcessAttachment(Long attachmentId_, Long processId_) throws InvalidProcessException, InvalidStateException Removes the specified attachment from a process.- Parameters:
attachmentId_- the ID of the attachment to removeprocessId_- the ID of the process- Returns:
ATTACHMENT_RETURN_SUCCESSif the attachment was added successfully,ATTACHMENT_RETURN_PERMISSIONSif the user does not have permissions to remove the attachment, orATTACHMENT_RETURN_INVALIDif the attachment does not exist- Throws:
InvalidProcessException- if the process does not existInvalidStateException- if the process is cancelledServiceException- if any system-level error occurs
-
removeTaskAttachments
Long[] removeTaskAttachments(Long[] attachmentIds_, Long taskId_) throws InvalidActivityException, InvalidStateException, InvalidOperationException Removes the specified attachments from a task- Parameters:
attachmentIds_- the ids of the attachments to removetaskId_- the id of the specified task- Returns:
- an
Arraycontaining return codes for each attachment:ATTACHMENT_RETURN_SUCCESSif the attachment was added successfully,ATTACHMENT_RETURN_PERMISSIONSif the user does not have permissions to remove the attachment, orATTACHMENT_RETURN_INVALIDif the attachment does not exist - Throws:
InvalidActivityException- if the task specified does not existInvalidStateException- if the task is cancelledServiceException- if any system-level error occursInvalidOperationException
-
removeTaskAttachment
Long removeTaskAttachment(Long attachmentId_, Long taskId_) throws InvalidActivityException, InvalidStateException Removes a specified attachment from a task- Parameters:
attachmentId_- the id of theAttachmentto removetaskId_- the id of task- Returns:
ATTACHMENT_RETURN_SUCCESSif the attachment was added successfully,ATTACHMENT_RETURN_PERMISSIONSif the user does not have permissions to remove the attachment, orATTACHMENT_RETURN_INVALIDif the attachment does not exist- Throws:
InvalidActivityException- if the task specified does not existInvalidStateException- if the task is cancelledServiceException- if any system-level error occurs
-
addAttachmentToProcess
Long addAttachmentToProcess(Long processId_, Attachment attachment_) throws PrivilegeException, InvalidProcessException, InvalidStateException, ProcessAttachmentsLimitException Add an attachment to a process.The following fields must be populated in the
Attachmentobject:attachedObject(with type and either id or stringId), andattachedUrl- Parameters:
processId_- Id of processattachment_- theAttachmentto 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, ifProcessPermissions.isAddAttachment()returnsfalseInvalidProcessException- if the process specified does not existInvalidStateException- if the process is cancelledProcessAttachmentsLimitException- if no more attachments can be added to the processServiceException- if any system-level error occurs- See Also:
-
addAttachmentToProcesses
Adds a single attachment to a list of processes.The following fields must be populated in the
Attachmentobject:attachedObject(with type and either id or stringId),attachedUrl, andcomment(can be an empty string)- Parameters:
processIds_- IDs of processesattachment_- the attachment to add- Returns:
- an Array of result codes for all specified processes:
ATTACHMENT_RETURN_PROCESS_CANCELLED= Cancelled processATTACHMENT_RETURN_TOO_MANY= Too many attachmentsATTACHMENT_RETURN_INVALID= Process does not existATTACHMENT_RETURN_PERMISSIONS= Insufficient permissionsATTACHMENT_RETURN_SUCCESS= Successful
- Throws:
ServiceException- if any system-level error occurs- See Also:
-
addAttachmentsToProcess
Long[] addAttachmentsToProcess(Long processId_, Attachment[] attachments_) throws PrivilegeException, InvalidProcessException, InvalidStateException, ProcessAttachmentsLimitException Add attachments to a given process.The following fields must be populated in each
Attachmentobject:attachedObject(with type and either id or stringId),attachedUrl, andcomment(can be an empty string)- Parameters:
processId_- ID of the Processattachments_- 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, ifProcessPermissions.isAddAttachment()returnsfalseInvalidProcessException- if the process specified does not exist, or theprocessId_parameter is null.InvalidStateException- if the process is cancelledProcessAttachmentsLimitException- if no more attachments can be added to the processNullPointerException- if theattachments_parameter is null or contains null values.ServiceException- if any system-level error occurs- See Also:
-
addAttachmentToTask
Long addAttachmentToTask(Long taskId_, Attachment attachment_) throws PrivilegeException, InvalidActivityException, InvalidStateException, ProcessAttachmentsLimitException, InvalidOperationException Add an attachment to a task- Parameters:
taskId_- Id of taskattachment_- 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, ifNodePermissions.isAddAttachment()returnsfalseInvalidActivityException- if the task specified does not existInvalidStateException- if the task is cancelledProcessAttachmentsLimitException- if no more attachments can be added to the taskInvalidOperationException- if the node is unattendedServiceException- if any system-level error occurs- See Also:
-
addAttachmentToTasks
Add an attachment to the given tasks- Parameters:
taskIds_- Ids of tasksattachment_- 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:
-
addAttachmentsToTask
Long[] addAttachmentsToTask(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, ifNodePermissions.isAddAttachment()returnsfalseInvalidActivityException- if the task specified does not existInvalidStateException- if the task is cancelledProcessAttachmentsLimitException- if no more attachments can be added to the taskServiceException- if any system-level error occursInvalidOperationException- if the node is unattended- See Also:
-
getDeadlineForProcess
Timestamp getDeadlineForProcess(Long processId_) throws NullPointerException, InvalidProcessException, PrivilegeException Retrieve the deadline of a given process.- Parameters:
processId_- The id of the process.- Returns:
- The deadline of the process, or
nullif no deadline is set. - Throws:
NullPointerException- ifprocessId_isnullInvalidProcessException- if the process does not existPrivilegeException- if the current user does not have privileges to perform this action
-
setDeadlineForProcess
void setDeadlineForProcess(Long processId_, Timestamp deadline_) throws 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, ornullto disable the deadline for the process.- Throws:
NullPointerException- ifprocessId_isnullInvalidProcessException- if the process specified does not existPrivilegeException- if the current user does not have privileges to perform this action
-
getDeadlineForTask
Timestamp getDeadlineForTask(Long taskId_) throws NullPointerException, InvalidActivityException, PrivilegeException Retrieve the deadline for a given task.- Parameters:
taskId_- The id of the task.- Returns:
- The deadline of the task, or
nullif no deadline is set. - Throws:
NullPointerException- iftaskId_isnullInvalidActivityException- if the task specified does not existPrivilegeException- if the current user does not have privileges to perform this action
-
setDeadlineForTask
void setDeadlineForTask(Long taskId_, Timestamp deadline_) throws 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, ornullto disable the deadline for the task.- Throws:
NullPointerException- iftaskId_isnullInvalidActivityException- if the task specifiedPrivilegeException- if the current user does not have privileges to perform this action does not exist
-
getPriorityOfTask
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 actionServiceException- if any system-level error occurs
-
getPriorityOfTasks
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 actionServiceException- if any system-level error occurs
-
getPriorityOfProcess
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(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(Long taskId_, Long priorityId_) throws InvalidActivityException, InvalidPriorityException, PrivilegeException, InvalidStateException Sets the priority of a specified task.- Parameters:
taskId_- the task for which to set the prioritypriorityId_- the id of thepriorityto 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 existInvalidPriorityException- if the priority does not existPrivilegeException- if the current user does not have privileges to perform this actionInvalidStateException- if the process is already CANCELLED OR COMPLETEDServiceException- if any system-level error occurs
-
setPriorityOfTasks
void setPriorityOfTasks(Long[] taskIds_, Long priorityId_) throws InvalidActivityException, InvalidPriorityException, PrivilegeException, InvalidStateException Sets the priorities of specified tasks.- Parameters:
taskIds_- the tasks for which to set the prioritiespriorityId_- 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 existInvalidPriorityException- if the priority does not existPrivilegeException- if the current user does not have privileges to perform this actionInvalidStateException- if the process is already CANCELLED OR PAUSEDServiceException- if any system-level error occurs
-
setPriorityOfProcess
void setPriorityOfProcess(Long processId_, Long priorityId_, boolean propagatePriorityChangeToSubProcesses_) throws InvalidProcessException, InvalidPriorityException, PrivilegeException, InvalidStateException Sets the priority of a specified process- Parameters:
processId_- the id of the processpriorityId_- 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.xmlpropagatePriorityChangeToSubProcesses_-trueif the priority will propagate to sub processes within this process, otherwisefalse- Throws:
InvalidProcessException- if the process does not existInvalidPriorityException- if the priority does not existPrivilegeException- if the current user does not have privileges to perform this actionInvalidStateException- if the process is already CANCELLED OR COMPLETEDServiceException- if any system-level error occurs
-
setPriorityOfProcesses
void setPriorityOfProcesses(Long[] processIds_, Long priorityId_, boolean propagatePriorityChangeToSubProcesses_) throws InvalidProcessException, InvalidPriorityException, PrivilegeException, InvalidStateException Sets the priorityPriorityof the specified processesProcessDetails.- Parameters:
processIds_- the ids of the processes for which to set theprioritypriorityId_- thepriorityto set for the processes; the id is one of the ids from web.war/WEB-INF/conf/process/priority-config-process.xmlpropagatePriorityChangeToSubProcesses_-trueif the priority will propagate to sub processes within the processes, otherwisefalse.- Throws:
InvalidProcessException- if the process does not existInvalidPriorityException- if the priority does not existPrivilegeException- if the current user does not have privileges to perform this actionInvalidStateException- if the process is already CANCELLED OR COMPLETEDServiceException- if any system-level error occurs
-
raisePriorityOfTask
void raisePriorityOfTask(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 existPrivilegeException- if the user does not have sufficient privileges to perform this actionInvalidStateException- if the process is already CANCELLED OR COMPLETEDServiceException- if any system-level error occursInvalidActivityException
-
raisePriorityOfTasks
void raisePriorityOfTasks(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 existPrivilegeException- if the user does not have sufficient privileges to perform this actionInvalidStateException- if the process is already CANCELLED OR COMPLETEDServiceException- if any system-level error occurs
-
raisePriorityOfProcess
void raisePriorityOfProcess(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 prioritypropagatePriorityChangeToLinkProcesses_-trueif the priority will propagate to linked processes within the processes, otherwisefalse- Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the user does not have sufficient privileges to perform this actionInvalidStateException- if the process is already CANCELLED OR COMPLETEDServiceException- if any system-level error occurs
-
raisePriorityOfProcesses
void raisePriorityOfProcesses(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 prioritypropagatePriorityChangeToLinkProcesses_-trueif the priority will propagate to linked processes within the processes, otherwisefalse- Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the user does not have sufficient privileges to perform this actionInvalidStateException- if the process is already CANCELLED OR COMPLETEDServiceException- if any system-level error occurs
-
lowerPriorityOfTask
void lowerPriorityOfTask(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 existPrivilegeException- if the user does not have sufficient privileges to perform this actionInvalidStateException- if the process is already CANCELLED OR COMPLETEDServiceException- if any system-level error occurs
-
lowerPriorityOfTasks
void lowerPriorityOfTasks(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 existPrivilegeException- if the user does not have sufficient privileges to perform this actionInvalidStateException- if the process is already CANCELLED OR COMPLETEDServiceException- if any system-level error occurs
-
lowerPriorityOfProcess
void lowerPriorityOfProcess(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 prioritypropagatePriorityChangeToLinkProcesses_-trueif the priority will propagate to linked processes within the process, otherwisefalse- Throws:
InvalidProcessException- if the specified process does not existPrivilegeException- if the user does not have sufficient privileges to perform this actionInvalidStateException- if the process is already CANCELLED OR COMPLETEDServiceException- if any system-level error occurs
-
lowerPriorityOfProcesses
void lowerPriorityOfProcesses(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 prioritypropagatePriorityChangeToLinkProcesses_-trueif the priority will propagate to linked processes within the processes, otherwisefalse- Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the user does not have sufficient privileges to perform this actionInvalidStateException- if the process is already CANCELLED OR COMPLETEDServiceException- if any system-level error occurs
-
containsLinkProcessesInheritingPriority
@Deprecated boolean containsLinkProcessesInheritingPriority(Long processId_) throws InvalidProcessException Deprecated.UsecontainsSubProcessesInheritingPriority(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:
trueif the given process contains at least one linked process inheriting its priority,falseotherwise- Throws:
InvalidProcessException- if the process does not existServiceException- if any system-level errors occur
-
containsSubProcessesInheritingPriority
Checks if the specifiedProcesscontains sub-processes that inherit their priority instead of defining their own priority levels.- Parameters:
processId_- The ID of the parentProcess.- Returns:
trueif the givenProcesscontains at least one sub-process that inherits its priority andfalseotherwise.- Throws:
InvalidProcessException- If the givenProcessdoes not exist.ServiceException- If an error occurs in the backend.
-
createNoteMetadata
Deprecated.since 23.2Create 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
locationfield populated, so that the note can be written to disk usingNotesContentService.createNoteContent(NoteMetadata, String) - Throws:
InvalidUserException- if any of the users referenced by theNoteMetadatadoes not existServiceException- if any system-level errors occur
-
createNoteMetadatas
Deprecated.since 23.2Bulk create note metadata. This method performs the same action ascreateNoteMetadata(NoteMetadata), except in bulk- Parameters:
nms_- the note metadatas to be created. If any of theNoteMetadataobjects is null the method will throw a NullPointerException.- Returns:
- the note metadata with
locationfield populated, so that the notes can be created usingNotesContentService.createNoteContent(NoteMetadata, String) - Throws:
InvalidUserException- if any of the users referenced by aNoteMetadatadoes not existServiceException- if any system-level errors occur
-
getNotePath
Deprecated.since 23.2Gets 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
Deprecated.since 23.2Gets 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
Deprecated.since 23.2Retrieve 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
@Deprecated void setCurrentNotePaths(String[] notePaths) throws PrivilegeException, IllegalArgumentException Deprecated.since 23.2Sets 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 occurIllegalArgumentException- if the length of the array passed does not match the number of existing notes
-
getExceptionNoteMetadataForTask
@Deprecated NoteMetadata getExceptionNoteMetadataForTask(Long taskId_) throws InvalidActivityException Deprecated.since 23.2Gets the last exception note (that is, the note attached to the exception) for the specified task;nullif 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
@Deprecated ResultPage getExceptionNoteMetadatasForProcess(Long processId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidProcessException, PrivilegeException Deprecated.since 23.2Gets 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 processstartIndex_- 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 theSORT_BY_XXXconstants onNoteMetadata.sortOrder_- The order in which to sort the results. This should be eitherConstants.SORT_ORDER_ASCENDINGorConstants.SORT_ORDER_DESCENDING.- Returns:
- Returns a
ResultPagecontaining instances ofNoteMetadata - 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
@Deprecated ResultPage getAllExceptionNoteMetadatasForProcess(Long processId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidProcessException, PrivilegeException Deprecated.since 23.2Gets 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 processstartIndex_- 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 theSORT_BY_XXXconstants onNoteMetadata.sortOrder_- The order in which to sort the results. This should be eitherConstants.SORT_ORDER_ASCENDINGorConstants.SORT_ORDER_DESCENDING.- Returns:
- Returns a
ResultPagecontaining instances ofNoteMetadata - 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
@Deprecated NoteMetadata createNoteMetadataForProcess(Long processId_, NoteMetadata nm_) throws InvalidProcessException, PrivilegeException, InvalidStateException, InvalidUserException, NullPointerException, NotesLimitException Deprecated.since 23.2Creates a new Note for the specified Process. The minimum required fields to create a note metadata are:type- Parameters:
processId_- ID of the Processnm_- the note metadata to be created- Returns:
- the note metadata with
locationfield populated, so that the note can be written to disk usingNotesContentService.createNoteContent(NoteMetadata, String) - Throws:
InvalidProcessException- if the process does not existInvalidStateException- if the process is cancelled or paused by exceptionPrivilegeException- ifProcessPermissions.isAddAttachment()isfalsefor current userInvalidUserException- if any of the users referenced by theNoteMetadatadoes not existNullPointerException- ifnm_isnullNotesLimitException- if too many notes have already been added to the processServiceException- if any system-level errors occur
-
createNoteMetadataForProcesses
@Deprecated ResultList createNoteMetadataForProcesses(Long[] processIds_, NoteMetadata nm_) throws InvalidUserException, NullPointerException Deprecated.since 23.2Creates a new Note for the specified Processes. The minimum required fields to create a note metadata are:type- Parameters:
processIds_- Ids of the Processesnm_- the note metadata to be created- Returns:
ResultListofStringobjects, representing the location of the notes. Each of the result codes returned will be one of theNOTE_CREATION_PROCESS_XXXconstants- Throws:
InvalidUserException- if any of the users referenced by theNoteMetadatadoes not existNullPointerException- ifnm_isnullorprocessIds_isnullor bothprocessIds_andnm_arenull.ServiceException- if any system-level errors occur
-
createNoteMetadatasForProcess
@Deprecated ResultList createNoteMetadatasForProcess(Long processId_, NoteMetadata[] nms_) throws InvalidProcessException, InvalidStateException, PrivilegeException, InvalidUserException Deprecated.since 23.2Creates multiple notes for a given Process. The minimum required fields to create a note metadata are:typeCreating 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 theResultList's result codes.- Parameters:
processId_- Id of the Processnms_- the note metadatas to be created- Returns:
ResultListofStringobjects, representing the location of the notes, so that the notes can be written to disk usingNotesContentService.createNoteContent(NoteMetadata, String). Each of the returned result codes in theResultListwill be one ofNOTE_CREATION_PROCESS_NOTE_LIMIT_EXCEEDED,NOTE_CREATION_PROCESS_INSUFFICIENT_PRIVILEGES,NOTE_CREATION_PROCESS_SUCCESS, or {@link #NOTE_CREATION_PROCESS_INVALID_BEAN)}- Throws:
InvalidProcessException- if the process does not existInvalidStateException- if the process is cancelledPrivilegeException- ifProcessPermissions.isAddAttachment()isfalsefor current userInvalidUserException- if any of the users referenced by aNoteMetadatadoes not existServiceException- if any system-level errors occur
-
getNoteMetadatasForProcess
@Deprecated ResultPage getNoteMetadatasForProcess(Long id_, boolean recursive_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidProcessException, PrivilegeException Deprecated.since 23.2Returns the metadata for the notes for a specified process- Parameters:
id_- the id of the processrecursive_- return recursive results if set to truestartIndex_- 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 theSORT_BY_XXXconstants onNoteMetadata.sortOrder_- The order in which to sort the results. This should be eitherConstants.SORT_ORDER_ASCENDINGorConstants.SORT_ORDER_DESCENDING.- Returns:
- a
ResultPagecontaining instances ofNoteMetadata. The result codes can be:ResultList.CODE_VALIDif the action succeeded,ResultList.CODE_NO_PERMISSIONif the user does not have permission, orResultList.CODE_INVALIDif the specified process does not exist - Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the current user does not have permission to perform this actionServiceException- if any system-level errors occur
-
getNoteMetadatasForProcesses
Deprecated.since 23.2Returns the metadata for the notes for specified processes.- Parameters:
ids_- the process ids- Returns:
- a
ResultListcontaining instances ofNoteMetadata - Throws:
ServiceException- if any system-level errors occur
-
getNoteMetadatasForProcess
@Deprecated ResultPage getNoteMetadatasForProcess(Long id_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidProcessException, PrivilegeException Deprecated.Returns the metadata for the notes for a specified process- Parameters:
id_- the id of the processstartIndex_- 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 theSORT_BY_XXXconstants onNoteMetadata.sortOrder_- The order in which to sort the results. This should be eitherConstants.SORT_ORDER_ASCENDINGorConstants.SORT_ORDER_DESCENDING.- Returns:
- a
ResultPagecontaining instances ofNoteMetadata. The result codes can be:ResultList.CODE_VALIDif the action succeeded,ResultList.CODE_NO_PERMISSIONif the user does not have permission, orResultList.CODE_INVALIDif the specified process does not exist - Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the current user does not have permission to perform this actionServiceException- if any system-level errors occur
-
createNoteMetadataForTask
@Deprecated NoteMetadata createNoteMetadataForTask(Long taskId_, NoteMetadata nm_) throws InvalidActivityException, PrivilegeException, InvalidStateException, InvalidOperationException, InvalidUserException, NullPointerException, NotesLimitException Deprecated.since 23.2Creates a new Note for a given Task. The minimum required fields to create a note metadata are:type- Parameters:
taskId_- ID of the tasknm_- the note metadata to be created- Returns:
- he note metadata with
locationfield populated, so that the note can be written to disk usingNotesContentService.createNoteContent(NoteMetadata, String) - Throws:
InvalidActivityException- if the task does not existInvalidStateException- if the task is in statesTaskSummary.TASK_STATUS_CANCELLED,TaskSummary.TASK_STATUS_ABORTED,TaskSummary.TASK_STATUS_ERROR, or if the process is in stateProcessSummary.STATE_CANCELLEDPrivilegeException- ifNodePermissions.isAddAttachment()isfalsefor current userInvalidOperationException- if the activity is unattendedInvalidUserException- if any of the users referenced by theNoteMetadatadoes not existNullPointerException- ifnm_isnullServiceException- if any system-level errors occurNotesLimitException
-
createNoteMetadataForTasks
@Deprecated ResultList createNoteMetadataForTasks(Long[] taskIds_, NoteMetadata nm_) throws InvalidUserException, NullPointerException Deprecated.since 23.2Creates a new Note for the given Tasks. The minimum required fields to create a note metadata are:type- Parameters:
taskIds_- IDs of the tasksnm_- the note metadata to be created- Returns:
ResultListcontaining oneString, representing the location where theNoteMetadatais stored so that the notes can be written to disk usingNotesContentService.createNoteContent(NoteMetadata, String). The result code returned in theResultListwill be one of theNOTE_CREATION_TASK_XXXconstants- Throws:
InvalidUserException- if any of the users referenced by aNoteMetadatadoes not existNullPointerException- ifnm_isnullServiceException- if any system-level errors occur
-
createNoteMetadatasForTask
@Deprecated ResultList createNoteMetadatasForTask(Long taskId_, NoteMetadata[] nms_) throws InvalidActivityException, InvalidStateException, PrivilegeException, InvalidOperationException, InvalidUserException Deprecated.since 23.2Creates multiple notes for a given task. The minimum required fields to create a note metadata are:typeCreating 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 theResultList's result codes.- Parameters:
taskId_- ID of Tasknms_- the note metadatas to be created- Returns:
ResultListofNoteMetadataobjects, with the location field populated so that the notes can be written to disk usingNotesContentService.createNoteContent(NoteMetadata, String). Each of the returned result codes in theResultListwill be one ofNOTE_CREATION_TASK_NOTE_LIMIT_EXCEEDED,NOTE_CREATION_TASK_INSUFFICIENT_PRIVILEGES,NOTE_CREATION_TASK_SUCCESS, orNOTE_CREATION_TASK_INVALID_BEAN- Throws:
InvalidActivityException- if the task does not existInvalidStateException- if the task is in statesTaskSummary.TASK_STATUS_CANCELLED,TaskSummary.TASK_STATUS_ABORTED,TaskSummary.TASK_STATUS_ERROR, or if the process is in stateProcessSummary.STATE_CANCELLEDPrivilegeException- if the current user does not have privileges to perform this actionInvalidOperationException- if the activity is unattendedInvalidUserException- if any of the users referenced by aNoteMetadatadoes not existServiceException- if any system-level errors occur
-
getNoteMetadatasForTask
@Deprecated ResultPage getNoteMetadatasForTask(Long id_, boolean includeProcess_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidActivityException, PrivilegeException, InvalidOperationException Deprecated.since 23.2Gets the metadata for the notes of a specified task.- Parameters:
id_- the task idincludeProcess_-trueif the note metadata of the parent process should be returned as well;falseotherwisestartIndex_- 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 theSORT_BY_XXXconstants onNoteMetadata.sortOrder_- The order in which to sort the results. This should be eitherConstants.SORT_ORDER_ASCENDINGorConstants.SORT_ORDER_DESCENDING.- Returns:
- a
ResultPagecontaining instances ofNoteMetadata - Throws:
InvalidActivityException- if the task specified does not existPrivilegeException- if the current user does not have privileges to perform this actionServiceException- if any system-level errors occurInvalidOperationException
-
getNoteMetadatasForTasks
Deprecated.since 23.2Gets the notes for the specified tasks- Parameters:
ids_- the task idsincludeProcess_- iftrue, includes Process Notes, otherwise does not.- Returns:
- ResultList containing
Stringlocations for storing the note contents usingNotesContentService. The result codes can be:ResultList.CODE_VALIDif the action succeeded,ResultList.CODE_NO_PERMISSIONif the user does not have permission, orResultList.CODE_INVALIDif the specified task does not exist - Throws:
ServiceException- if any system-level errors occur
-
deleteNoteMetadataForProcess
@Deprecated String deleteNoteMetadataForProcess(Long noteId_, Long processId_) throws InvalidProcessException, PrivilegeException, InvalidStateException, InvalidNoteException Deprecated.since 23.2Deletes the specified Note for the given process.- Parameters:
noteId_- ID of note to deleteprocessId_- 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 existPrivilegeException- if the current user does not have privileges to perform this actionInvalidStateException- if the process is cancelledInvalidNoteException- if the note specified does not existNullPointerException- ifnoteId_isnullServiceException- if any system-level error occurs
-
deleteNoteMetadataForTask
@Deprecated String deleteNoteMetadataForTask(Long noteId_, Long taskId_) throws InvalidActivityException, PrivilegeException, InvalidStateException, InvalidOperationException, InvalidNoteException Deprecated.since 23.2Deletes the specified Note from a given task.- Parameters:
noteId_- ID of Note to deletetaskId_- 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 existPrivilegeException- if the current user does not have privileges to perform this actionInvalidStateException- if the task is cancelledInvalidOperationException- if the activity is unattendedInvalidNoteException- if the note specified does not existServiceException- if any system-level error occurs
-
deleteNoteMetadatasForProcess
@Deprecated ResultList deleteNoteMetadatasForProcess(Long[] noteIds_, Long processId_) throws InvalidProcessException, InvalidStateException Deprecated.since 23.2Deletes the specified notes from the given process- Parameters:
noteIds_- IDs of notes to deleteprocessId_- ID of the process from which to delete the notes- Returns:
ResultListofStringobjects, representing the location of the deleted notes. Each of the returned result codes in theResultListwill be one ofNOTE_DELETION_INVALID,NOTE_DELETION_INSUFFICIENT_PRIVILEGESorNOTE_DELETION_SUCCESS- Throws:
InvalidProcessException- if the process specified does not existInvalidStateException- if the process is cancelledNullPointerException- ifnoteIds_isnullServiceException- if any system-level error occurs
-
deleteNoteMetadatasForTask
@Deprecated ResultList deleteNoteMetadatasForTask(Long[] noteIds_, Long taskId_) throws InvalidActivityException, InvalidStateException, InvalidOperationException Deprecated.since 23.2Deletes the specified notes for the given task- Parameters:
noteIds_- IDs of notes to deletetaskId_- ID of the task from which to delete the notes- Returns:
ResultListofStringobjects, representing the location of the deleted notes. Each of the returned result codes in theResultListwill be one ofNOTE_DELETION_INVALID,NOTE_DELETION_INSUFFICIENT_PRIVILEGESorNOTE_DELETION_SUCCESS- Throws:
InvalidActivityException- if the task specified does not existInvalidStateException- if the task is cancelledInvalidOperationException- if the activity is unattendedServiceException- if any system-level error occurs
-
updateNoteMetadataForProcess
@Deprecated NoteMetadata updateNoteMetadataForProcess(NoteMetadata nm_, Long processId_) throws InvalidProcessException, InvalidStateException, PrivilegeException, InvalidNoteException, InvalidUserException Deprecated.since 23.2Updates the specified Note for given processThe following field must be populated in the
NoteMetadataobject:id- Parameters:
nm_- updated NoteMetadata Object- Returns:
NoteMetadatawith updated info- Throws:
InvalidProcessException- if the process does not existInvalidStateException- if the process is cancelledPrivilegeException- if the current user does not have privileges to update the noteInvalidNoteException- if the note specified does not existInvalidUserException- if any of the users referenced by theNoteMetadatadoes not existServiceException- if any system-level error occurs- See Also:
-
updateNoteMetadataForTask
@Deprecated NoteMetadata updateNoteMetadataForTask(NoteMetadata nm_, Long taskId_) throws InvalidActivityException, InvalidStateException, PrivilegeException, InvalidOperationException, InvalidNoteException, InvalidUserException Deprecated.since 23.2Updates the specified Note for given taskThe following field must be populated in the
NoteMetadataobject:id- Parameters:
nm_- updatedNoteMetadataObject- Returns:
- the updated
NoteMetadata - Throws:
InvalidActivityException- if the task does not existInvalidStateException- if the task is in statesTaskSummary.TASK_STATUS_CANCELLED,TaskSummary.TASK_STATUS_ABORTED,TaskSummary.TASK_STATUS_ERROR, or if the process is in stateProcessSummary.STATE_CANCELLEDInvalidOperationException- if the activity is unattendedInvalidNoteException- if the note specified does not existPrivilegeException- if the current user does not have privileges to update the noteInvalidUserException- if any of the users referenced by theNoteMetadatadoes not existServiceException- if any system-level error occurs- See Also:
-
updateNoteMetadatasForProcess
@Deprecated ResultList updateNoteMetadatasForProcess(NoteMetadata[] nms_, Long processId_) throws InvalidStateException, InvalidProcessException, InvalidUserException Deprecated.since 23.2Updates 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 theResultList's result codes:NOTES_RETURN_SUCCESSif the note was added successfully,NOTES_RETURN_PERMISSIONSif the user does not have permission to remove the note, orNOTES_RETURN_INVALIDif the note does not existThe following field must be populated in each
NoteMetadataobject:id- Parameters:
nms_- Array of updatedNoteMetadataObjects.- Returns:
- ResultList containing updated
NoteMetadatasand result codes, which compared with the constants inNotetells the user if theNotewas successfully updated or not - Throws:
InvalidProcessException- if the process specified does not existInvalidStateException- if the process is cancelledInvalidUserException- if any of the users referenced by aNoteMetadatadoes not existServiceException- if any system-level error occurs- See Also:
-
updateNoteMetadatasForTask
@Deprecated ResultList updateNoteMetadatasForTask(NoteMetadata[] nms_, Long taskId_) throws InvalidActivityException, InvalidStateException, InvalidOperationException, InvalidNoteException, InvalidUserException Deprecated.since 23.2Updates 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 theResultList's result codes.The following field must be populated in each
NoteMetadataobject:id- Parameters:
nms_- Array of updatedNoteMetadataObjects.- Returns:
- ResultList containing updated
NoteMetadatasand result codes:NOTES_RETURN_SUCCESSif the note was added successfully,NOTES_RETURN_PERMISSIONSif the user does not have permission to remove the note, orNOTES_RETURN_INVALIDif the note does not exist - Throws:
InvalidActivityException- if the task does not existInvalidStateException- if the task is in statesTaskSummary.TASK_STATUS_CANCELLED,TaskSummary.TASK_STATUS_ABORTED,TaskSummary.TASK_STATUS_ERROR, or if the process is in stateProcessSummary.STATE_CANCELLEDInvalidOperationException- if the activity is unattendedInvalidUserException- if any of the users referenced by aNoteMetadatadoes not existServiceException- if any system-level error occursInvalidNoteException- See Also:
-
getNoteMetadataForTask
@Deprecated NoteMetadata getNoteMetadataForTask(Long noteId_, Long taskId_) throws InvalidActivityException, PrivilegeException, InvalidNoteException, InvalidNoteException Deprecated.since 23.2Returns a specified note for given task- Parameters:
noteId_- Note IdtaskId_- Task Id- Returns:
- NoteMetadata for requested note.
- Throws:
InvalidActivityException- if the task specified does not existPrivilegeException- if the current user does not have privileges to perform this actionInvalidNoteException- if the note specified does not existServiceException- if any system-level errors occur
-
getNoteMetadataForProcess
@Deprecated NoteMetadata getNoteMetadataForProcess(Long noteId_, Long processId_) throws InvalidProcessException, InvalidNoteException, PrivilegeException Deprecated.since 23.2Returns a specified note for given process- Parameters:
noteId_- Note IdprocessId_- Process Id- Returns:
- NoteMetadata for requested note.
- Throws:
InvalidProcessException- if the process specified does not existPrivilegeException- if the current user does not have privileges to perform this actionInvalidNoteException- if the note specified does not existServiceException- if any system-level errors occur
-
getTasksForProcess
ResultPage getTasksForProcess(Long processId_, boolean recursive_, int startIndex_, int batchSize_, Integer sortProperty_, 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 benull.- Parameters:
processId_- The id of the process.recursive_- return recursive results if set to truestartIndex_- 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 theSORT_BY_XXXconstants inTaskSummarysortOrder_- The order in which to sort the results. This should be eitherConstants.SORT_ORDER_ASCENDINGorConstants.SORT_ORDER_DESCENDING.- Returns:
- A
ResultPagecontainingTaskSummaryobjects 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(Long processId_, int startIndex_, int batchSize_, Integer sortProperty_, 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 benull.- 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 theSORT_BY_XXXconstants inTaskSummarysortOrder_- The order in which to sort the results. This should be eitherConstants.SORT_ORDER_ASCENDINGorConstants.SORT_ORDER_DESCENDING.- Returns:
- A
ResultPagecontainingTaskSummaryobjects 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(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 deletedInvalidStateException- if the process is cancelled or pausedPrivilegeException- if the user does not have permission to pause the process - ifProcessPermissions.isStopAndPause()returnsfalseLockException- if the process is locked (seelockProcessModelForProcess(Long,boolean))ServiceException- if any system-level errors occur
-
pauseProcesses
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_SUCCESSif the action succeeded,RESULT_CODE_INVALID_PROCESSif the process does not exist,RESULT_CODE_INSUFFICIENT_PRIVILEGESif the user does not have permission,RESULT_CODE_INVALID_STATEif the process is not active, orRESULT_CODE_LOCK_EXCEPTIONif 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(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 deletedInvalidStateException- if the process is not pausedPrivilegeException- if the user does not have permission to resume the processLockException- if the process is locked (seelockProcessModelForProcess(Long,boolean))ServiceException- if any system-level errors occur
-
resumeProcesses
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_SUCCESSif the action succeeded,RESULT_CODE_INVALID_PROCESSif the process does not exist,RESULT_CODE_INSUFFICIENT_PRIVILEGESif the user does not have permission,RESULT_CODE_INVALID_STATEif the process is not active, orRESULT_CODE_LOCK_EXCEPTIONif 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
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 processescancelLinkedProcesses_- 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_XXXconstants - Throws:
ServiceException- if any system-level error occurs- See Also:
-
startQuickTask
Long startQuickTask(Long processId_, 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 thetemplateIdproperty of aTaskSummaryobject.- Returns:
Longthe task id, if the task started correctly, null if the node has spawning or recurrence configured.- Throws:
InvalidProcessException- if the process does not existInvalidNodeException- the node used does not exist or if the node exists (it has a valid template) but does not belong to the given processInvalidNodeTypeLogicException- if the node is a logic node.InvalidStateException- if the process is paused by exceptionPrivilegeException- ifNodePermissions.isModifyInFlight()isfalsefor the current userInvalidNodeTypeRecurringException- if the node is set to recurInvalidNodeMultiplicityException- if the node cannot be started because its activity chaining settings prohibit multiple instancesServiceException- if any system-level error occurs
-
startTask
boolean startTask(Long processId_, 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 thetemplateIdproperty of aTaskSummaryobject.- Returns:
trueif the task started correctly, otherwisefalse- Throws:
InvalidProcessException- if the process does not existInvalidNodeException- the node used does not exist or if the node exists (it has a valid template) but does not belong to the given processInvalidNodeTypeLogicException- if the node is a logic node.InvalidStateException- if the process is paused by exceptionPrivilegeException- ifNodePermissions.isModifyInFlight()isfalsefor the current userInvalidNodeTypeRecurringException- if the node is set to recurInvalidNodeMultiplicityException- if the node cannot be started because its activity chaining settings prohibit multiple instancesServiceException- if any system-level error occurs
-
startTasks
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_SUCCESSif the action succeeded,RESULT_CODE_INVALID_TASKif the node does not exist,RESULT_CODE_INSUFFICIENT_PRIVILEGESif the user does not have permission, orRESULT_CODE_INVALID_STATEif it is a logic nodeRESULT_CODE_NODE_MULTIPLICITYif the node cannot be startedRESULT_CODE_INVALID_NODEif 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 thetemplateIdproperty of the correspondingTaskSummaryobject.- 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 IDServiceException- if any system-level error occurs
-
resumeTask
void resumeTask(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 deletedInvalidStateException- if the task is not PAUSEDPrivilegeException- if the user does not have permissions to resume the taskServiceException- if any system-level error occurs- See Also:
-
resumeTasks
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_SUCCESSif the action succeeded,RESULT_CODE_INVALID_TASKif the node does not exist,RESULT_CODE_INSUFFICIENT_PRIVILEGESif the user does not have permission, orRESULT_CODE_INVALID_STATEif 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(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 deletedInvalidStateException- if the task has been CANCELLEDPrivilegeException- if the user does not have permissions to pause the taskServiceException- if any system-level error occurs
-
pauseTasks
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_SUCCESSif the action succeeded,RESULT_CODE_INVALID_TASKif the node does not exist,RESULT_CODE_INSUFFICIENT_PRIVILEGESif the user does not have permission, orRESULT_CODE_INVALID_STATEif 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(Long activityId_) throws InvalidActivityException, InvalidStateException, PrivilegeException Cancels a given task- Parameters:
activityId_- the ID of the task- Throws:
InvalidActivityException- if the task does not existInvalidStateException- if the task is cancelledPrivilegeException- if the user does not have sufficent privileges to cancel this task - that is, ifProcessPermissions.isStopAndPause()returnsfalsefor the process containing this taskServiceException- if any system-level error occurs- See Also:
-
cancelTasks
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_XXXconstants - Throws:
ServiceException- if any system-level error occurs
-
startAllNodes
NodeActionResult startAllNodes(String[] nodeUuids, 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 theuuidproperty of the correspondingTaskSummaryobject.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(String[] nodeUuids, 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 theuuidproperty of the correspondingTaskSummaryobject.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(String[] nodeUuids, 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 theuuidproperty of the correspondingTaskSummaryobject.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(String[] nodeUuids, 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 theuuidproperty of the correspondingTaskSummaryobject.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(String[] nodeUuids, 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 theuuidproperty of the correspondingTaskSummaryobject.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(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 deletedInvalidStateException- if the task is not assigned or acceptedPrivilegeException- if the user does not have permissions to reassign the taskServiceException- if any system-level error occurs
-
reassignTasksToAssigneePool
@Deprecated Integer[] reassignTasksToAssigneePool(Long[] activityIds_, Assignment.Assignee[] assignees_) throws InvalidUserException Deprecated.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_SUCCESSif the action succeeded,RESULT_CODE_INVALID_TASKif the node does not exist,RESULT_CODE_INSUFFICIENT_PRIVILEGESif the user does not have permission, orRESULT_CODE_INVALID_STATEif the task is not assigned or accepted- Parameters:
activityIds_- the IDs of the tasksassignees_- 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 anAssignment.Assigneedoes not existServiceException- if any system-level error occurs
-
reassignTasksToSameAssigneePool
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_SUCCESSif the action succeeded,RESULT_CODE_INVALID_TASKif the node does not exist,RESULT_CODE_INSUFFICIENT_PRIVILEGESif the user does not have permission, orRESULT_CODE_INVALID_STATEif 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(Long processId_, int typeOfNotesToRetrieve_) throws InvalidProcessException, PrivilegeException, 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 ofRETRIEVE_PROCESS_MODEL_NOTESorRETRIEVE_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.IllegalArgumentException- iftypeOfNotesToRetrieve_is invalidServiceException- if any system-level error occurs
-
updateProcessModelForProcess
@Deprecated ProcessDiagram updateProcessModelForProcess(Long processId_, ProcessDiagram pd_, ProcessModel[] childProcessModels_) throws InvalidProcessException, LockException, PrivilegeException Deprecated.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 withProcessDesignService.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 togetProcessDiagram(java.lang.Long, int).childProcessModels_- the sub and linked process models for this updating process model- Throws:
InvalidProcessException- if the process does not existLockException- if the process is currently lockedPrivilegeException- if the user does not have permission to update the process (ifProcessPermissions#isModifyInFlightreturnsfalse)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(Long toProcessModelId, String toVersion, 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 totoVersion- 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 existInvalidVersionException- if the specified process model version does not existPrivilegeException- if the user performing the action does not have sufficient privileges to view or initiate the specified process modelInvalidStateExceptionUpgradeException
-
upgradeProcesses
UpgradeResult upgradeProcesses(Long toProcessModelId, String toVersion, Long fromProcessModelId, 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 totoVersion- 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 fromfromVersions- 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 existInvalidVersionException- if the process model version specified by 'toVersion' does not existPrivilegeException- if the user performing the action does not have sufficient privileges to view or initiate the specified process modelInvalidStateExceptionUpgradeException
-
triggerSchedule
void triggerSchedule(Integer scheduleType_, 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 ofScheduleSummary.SCHEDULE_TYPE_PENDING_SINGLE, used for a delayed individual task, orScheduleSummary.SCHEDULE_TYPE_PENDING_MULTIPLE, used for recurring tasks.scheduleId_- the schedule ID. This is the ID of aScheduleSummaryretrieved fromgetScheduleSummariesForNode(Long, Long, int, int, Integer, Integer)- Throws:
InvalidScheduleTypeException- if the schedule type is invalidInvalidActivityException- if the schedule type isSCHEDULE_TYPE_PENDING_SINGLE, and the schedule ID does not correspond to a valid taskInvalidNodeException- if the schedule type isSCHEDULE_TYPE_PENDING_MULTIPLE, and the schedule ID does not correspond to a valid nodePrivilegeException- if the the user does not have sufficient permissions to perform this operation - that is, ifProcessPermissions.isModifyInFlight()would return false for the process in question.InvalidStateException- if the task delay has already passed, or if the task's status isTaskSummary.TASK_STATUS_CANCELLEDServiceException- if any system-level error occurs- See Also:
-
triggerTaskEscalation
void triggerTaskEscalation(Long activityId_, 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 taskescalationId_- the id of the escalation- Throws:
InvalidActivityException- if the task does not existInvalidStateException- if the task has been completed, or cancelled, or if the escalation has already lapsed or the task has not yet been startedInvalidEscalationException- if the escalation does not existPrivilegeException- if the the user does not have sufficient - permissions to perform this operationServiceException- if any system-level error occurs- See Also:
-
skipTaskEscalation
void skipTaskEscalation(Long activityId_, Long escalationId_) throws InvalidActivityException, InvalidStateException, InvalidEscalationException, PrivilegeException Skips the desired escalation instance for the task- Parameters:
activityId_- the id of the taskescalationId_- the id of the escalation- Throws:
InvalidActivityException- if the task does not existInvalidStateException- if the task has been completed, or cancelled, or if the escalation has already lapsedInvalidEscalationException- if the escalation does not existPrivilegeException- ifNodePermissions.isModifyInFlight()isfalsefor the current user- See Also:
-
getScheduleSummariesForNode
ResultPage getScheduleSummariesForNode(Long processId_, Long nodeId_, int startIndex_, int batchSize_, Integer sortProperty_, 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 processnodeId_- the ID of theRuntimeProcessNodein the processstartIndex_- 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 ofConstants.COUNT_ALLwill 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 theSORT_BY_XXXconstants inScheduleSummarysortOrder_-Constants.SORT_ORDER_ASCENDINGfor sorting results in ascending order,Constants.SORT_ORDER_DESCENDINGfor sorting results in descending order- Returns:
ResultPageofScheduleSummaryobjects;ResultPagecontains 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 existPrivilegeException- if the user does not have sufficient privileges to perform this actionInvalidProcessException- if the process does not existServiceException- if any system-level error occurs
-
lockProcessModelForProcess
void lockProcessModelForProcess(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 processoverride_-trueto override lock status, if the process model is already locked by another user- Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the user does not have sufficient privileges to perform this actionLockException- if the user cannot override the lock, if the process model is already currently lockedArchivedProcessException- if the process is archivedInvalidStateExceptionServiceException- if any system-level error occurs- See Also:
-
lockProcesses
Attempts to lock the specified processes.- Parameters:
processIds- the ids of the processes to be lockedoverride-trueto override lock status, if the process is already locked by another user
-
unlockProcesses
Attempts to unlock the specified processes.- Parameters:
processIds- the ids of the processes to be unlockedoverride-trueto override lock status, if the process is locked by another user
-
unlockProcessModelForProcess
void unlockProcessModelForProcess(Long processId_, boolean override_) throws InvalidProcessException, PrivilegeException, LockException Unlocks the underlying process model for the process- Parameters:
processId_- the id of the processoverride_-trueto override lock status, if the process model is locked by another user- Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the user does not have sufficient privileges to perform this actionServiceException- if any system-level error occursLockException- if the user cannot override the lock, if the process model is already currently locked- See Also:
-
unlockProcessModels
void unlockProcessModels()Unlocks all process models locked by the current user.- Throws:
ServiceException- if any system-level error occurs
-
getMaximumNumberOfNotes
Deprecated.since 23.2Returns 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(Long processId_, Long nodeId_, Long recurrenceNumber_) throws InvalidProcessException, InvalidStateException, PrivilegeException, InvalidNodeException Skips the recurrence instance of the given node- Parameters:
processId_- process which the node resides innodeId_- id of the node to skip the next recurrence ofrecurrenceNumber_- which recurrence to skip. For each node, the recurrences are numbered starting at 0. The next recurrence number can be obtained by callinggetNextRecurrence(Long,Long)- Returns:
RecurrenceInstancewithidandscheduledTimepopulated- Throws:
InvalidProcessException- if the process does not existInvalidNodeException- if the node template does not existInvalidStateException- 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:
-
triggerRecurrence
RecurrenceInstance triggerRecurrence(Long processId_, Long nodeId_, Long recurrenceNumber_) throws InvalidProcessException, InvalidStateException, PrivilegeException, InvalidNodeException Triggers the recurrence instance of the given node- Parameters:
processId_- process which the node resides innodeId_- ID of theRuntimeProcessNodeto skip the next recurrence ofrecurrenceNumber_- 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 theRecurrenceInstanceobtained by callinggetNextRecurrence(Long,Long), with parametersprocessId_andnodeId_- Returns:
- recurrence instance with
idandscheduledTimepopulated - Throws:
InvalidProcessException- if the process does not existInvalidStateException- 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 existPrivilegeException- if the user does not have privileges. That is ifNodePermissions.isModifyInFlight()isfalse- See Also:
-
setTaskStateSubmitted
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(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 existServiceException- if any system-level error occurs
-
setTaskStateRunning
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(Long processId_, int type_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidProcessException, PrivilegeException Gets the current tasks for a process- Parameters:
processId_- the ID of the processtype_- 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
- Unattended 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 ofConstants.COUNT_ALLwill 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 theSORT_BY_XXXconstants inTaskSummarysortOrder_-Constants.SORT_ORDER_ASCENDINGfor sorting results in ascending order,Constants.SORT_ORDER_DESCENDINGfor sorting results in descending order- Returns:
ResultPageofTaskSummaryobjects.- Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the user does not have sufficient privileges to perform this actionServiceException- if any system-level error occurs
-
getCompletedTasksForProcess
ResultPage getCompletedTasksForProcess(Long processId_, int type_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidProcessException, PrivilegeException Gets the completed tasks for a process- Parameters:
processId_- the ID of the processtype_- type of tasks to returnThis is one of:- Unattended Tasks -
UNATTENDED_TASKS - Attended Tasks -
ATTENDED_TASKS - Unattended and Attended Tasks -
UNATTENDED_AND_ATTENDED_TASKS
- Unattended 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 ofConstants.COUNT_ALLwill 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 theSORT_BY_XXXconstants inTaskSummarysortOrder_-Constants.SORT_ORDER_ASCENDINGfor sorting results in ascending order,Constants.SORT_ORDER_DESCENDINGfor sorting results in descending order- Returns:
ResultPageofTaskSummaryobjects. If a task is completed then its assignees field will be an empty array.- Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the user does not have sufficient privileges to perform this actionServiceException- if any system-level error occurs
-
getCancelledTasksForProcess
ResultPage getCancelledTasksForProcess(Long processId_, int type_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidProcessException, PrivilegeException Gets the cancelled tasks for a process- Parameters:
processId_- the ID of the processtype_- type of tasks to returnThis is one of:- Unattended Tasks -
UNATTENDED_TASKS - Attended Tasks -
ATTENDED_TASKS - Unattended and Attended Tasks -
UNATTENDED_AND_ATTENDED_TASKS
- Unattended 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 ofConstants.COUNT_ALLwill 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 theSORT_BY_XXXconstants inTaskSummarysortOrder_-Constants.SORT_ORDER_ASCENDINGfor sorting results in ascending order,Constants.SORT_ORDER_DESCENDINGfor sorting results in descending order- Returns:
ResultPageofTaskSummaryobjects.- Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the user does not have sufficient privileges to perform this actionServiceException- if any system-level error occurs
-
getPausedTasksForProcess
ResultPage getPausedTasksForProcess(Long processId_, int type_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidProcessException, PrivilegeException Gets the paused tasks for a process- Parameters:
processId_- the ID of the processtype_- type of tasks to returnThis is one of:- Unattended Tasks -
UNATTENDED_TASKS - Attended Tasks -
ATTENDED_TASKS - Unattended and Attended Tasks -
UNATTENDED_AND_ATTENDED_TASKS
- Unattended 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 ofConstants.COUNT_ALLwill 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 theSORT_BY_XXXconstants inTaskSummarysortOrder_-Constants.SORT_ORDER_ASCENDINGfor sorting results in ascending order,Constants.SORT_ORDER_DESCENDINGfor sorting results in descending order- Returns:
ResultPageofTaskSummaryobjects.- Throws:
InvalidProcessException- if the process does not existPrivilegeException- if the user does not have sufficient privileges to perform this actionServiceException- if any system-level error occurs
-
getTasksWithExceptionsForProcess
ResultPage getTasksWithExceptionsForProcess(Long processId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidProcessException, PrivilegeException Gets the tasks that are paused by exception for a specified process.- Parameters:
processId_- the ID of the processstartIndex_- 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 ofConstants.COUNT_ALLwill 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 theSORT_BY_XXXconstants inTaskSummarydefined in this file.sortOrder_- The order in which to sort the results. This should be eitherConstants.SORT_ORDER_ASCENDINGorConstants.SORT_ORDER_DESCENDING.- Returns:
- Returns a
ResultPagecontaining instances ofTaskSummary. 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(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 existInvalidStateException- if the process has not been archivedIncompatibleArchivedVersionException- if an archived process file is from an incompatible release versionPrivilegeException- if the currentUserdoes not have permission to unarchive the process. UseProcessDesignService.getPermissionsForProcessApplication()to determine if theUserhas permission to unarchive processes.ServiceException- if any system-level error occurscom.appiancorp.process.engine.ArchiveReadException
-
unarchiveProcesses
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_VALIDif the action succeeded, orResultList.CODE_INVALIDif the specified process does not exist - Throws:
PrivilegeException- if the user does not have permissions to unarchive processesServiceException- if any system-level error occurs
-
archiveProcess
void archiveProcess(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 existArchivedProcessException- if the process is already archivedPrivilegeException- 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
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_VALIDif the action succeeded,ResultList.CODE_NO_PERMISSIONif the user does not have permission, orResultList.CODE_INVALIDif the specified process does not exist (only completed or canceled process can be archived) - Throws:
ServiceException- if any system-level error occurs
-
getArchivePaths
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. This API is not supported for Appian Cloud environments- Returns:
- The paths where processes are currently archived.
- Throws:
ServiceException- if any system-level error occurs
-
setArchivePaths
Set the paths where archived processes will be stored. This API is not supported for Appian Cloud environments- 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:
-
getNextRecurrence
RecurrenceInstance getNextRecurrence(Long processId_, 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 fornodeId_- 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 existInvalidNodeException- if the node is invalidPrivilegeException- If the user does not have permissions to the process - ifProcessPermissions.isModifyInFlight()returnsfalseServiceException- if any system-level error occurs
-
getAttachmentsInProcess
ResultList getAttachmentsInProcess(Long processId_, Long[] attachmentIds_) throws InvalidProcessException Gets the specified attachments associated with a given process, or tasks in this process- Parameters:
processId_- the id of the processattachmentIds_- the unique Ids of the attachments to be retrieved- Returns:
- a
ResultListcontaining an array ofAttachmentobjects - Throws:
InvalidProcessException- if the process specified does not existServiceException- if any system-level error occurs
-
getNoteMetadatasInProcess
@Deprecated ResultList getNoteMetadatasInProcess(Long processId_, Long[] noteIds_) throws InvalidProcessException Deprecated.since 23.2Gets the specified notes associated with a given process, or tasks in this process- Parameters:
processId_- the id of the processnoteIds_- the unique Ids of the notes to be retrieved- Returns:
- a
ResultListcontaining an array ofNoteMetadataobjects - Throws:
InvalidProcessException- if the process specified does not existServiceException- if any system-level error occurs
-
updateUsernames
@Deprecated void updateUsernames(String[] oldUsernames_, String[] newUsernames_, long maxExpirationTimeInSeconds_) throws IllegalArgumentException, DuplicateNameException, PrivilegeException Deprecated.DEPRECATED: SeeUserService.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(). AftercommitUpdateUsernameshas been called, the old usernames will still be active, but will expire after the interval specified bymaxExpirationTimeInSeconds_; ifupdateUsernamesis successful butcommitUpdateUsernamesis 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 updatednewUsernames_- the usernames to which the old usernames will be updatedmaxExpirationTimeInSeconds_- the interval, in seconds, aftercommitUpdateUsernameshas been called, after which the old usernames will expire. If this parameter is zero or a negative value the old usernames will expire instantly. After expiration, the old usernames will no longer be valid.- Throws:
IllegalArgumentException- if the length ofoldUsernames_is not the same as the length ofnewUsernames_.DuplicateNameException- if anyoldUsernames_ornewUsernames_contain any duplicates, or if an old username is being updated to a username that already existsPrivilegeException- if the currentUserdoes not have permission to update usernames, as determined byProcessDesignService.getSecurityForProcessApplication().ServiceException- if any system-level error occurs
-
commitUpdateUsernames
Deprecated.DEPRECATED: SeeUserService.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 bymaxExpirationTimeInSeconds_; ifcommitUpdateUsernamesis not called, the new usernames will not become active.- Throws:
ServiceException- if any system-level error occurs
-
rollbackUpdateUsernames
Deprecated.DEPRECATED: SeeUserService.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(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 actionNullPointerException- if activityId_ is nullInvalidActivityException- if activityId_ is invalid (i.e. refers to an activity that does not exist)IllegalArgumentException- if the activity is unattended (such activities are not allowed to be uncompleted, since they would automatically recomplete with the same behavior).
-
setApplicationAdministratorGroup
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 actionServiceException- if any system-level error occurs
-
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
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
Registers the site locale settings on the process execution server.- Parameters:
settings_- The site locale settings.
-
handleMessages
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:
NullPointerException- if any element in messages_ is null or if messages_ itself is nullServiceException- if any system-level error occurs
-
acknowledgeMessages
Deprecated.replaced by work queue, no longer requires separate acknowledgement: call does nothing nowCertain 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
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 existServiceException- if any system-level error occurs
-
addProcessToFavorites
Adds aProcessto the user's favorites list.- Parameters:
processId_- Id of theProcessto be added.- Throws:
InvalidProcessException- if theProcessspecified does not existPrivilegeException- if the current user does not have permission to perform this action on the specifiedProcessNullPointerException- ifprocessId_is nullServiceException- if any system-level error occurs
-
removeProcessFromFavorites
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
Adds aTaskto the user's favorites list.- Parameters:
taskId_- Id of the task to be added.- Throws:
InvalidActivityException- if the activity specified does not existPrivilegeException- if the current user does not have permission to perform this action on the specified activityNullPointerException- iftaskId_is nullServiceException- if any system-level error occurs
-
removeTaskFromFavorites
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(Long processModelId, Long pageId) throws InvalidProcessException, PrivilegeException Deprecated.Use {@link 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 nabbedpageId- 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(Long processModelId) throws InvalidProcessException, PrivilegeException Deprecated.Use {@link 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 theProcess Model- Throws:
InvalidProcessException- if the Process Model does not existPrivilegeException- if the current user does not have access to perform this operationServiceException- if any system-level error occurs
-
getAutoArchiveProperties
Map getAutoArchiveProperties()Retrieves auto archive properties from the backend- Returns:
- a map containing "autoArchive" and "autoArchiveDelay"
-
getMemoryUsageForExecEngine
Returns theSizingReportwhich 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:
-
getMemoryUsageForProcessModels
Returns theSizingReportwhich 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:
-
getMemoryUsageForProcessModelsByUUID
SizingReport getMemoryUsageForProcessModelsByUUID(String[] processModelUUIDs_) throws PrivilegeException Returns theSizingReportwhich 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:
-
getMemoryUsageForProcesses
SizingReport getMemoryUsageForProcesses(Long[] processIds_) throws PrivilegeException, InvalidProcessException Returns theSizingReportwhich 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 operationInvalidProcessException- If any of the processes do not exist- See Also:
-
getMemoryUsageForProcessesByModelUUID
SizingReport getMemoryUsageForProcessesByModelUUID(String[] processModelUUIDs_) throws PrivilegeException Returns theSizingReportwhich 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:
-
getMemoryUsageForNodesInProcesses
SizingReport getMemoryUsageForNodesInProcesses(Long[] processIds_) throws PrivilegeException, InvalidProcessException Returns theSizingReportwhich 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 operationInvalidProcessException- If any of the processes do not exist- See Also:
-
setTimeZone
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, useGlobalizationService.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.this method will be removed in a future releaseSet a backend timezone to have the same rules as another backend timezone the sameAsId.- Parameters:
tz-sameAsId-
-
getProcessHistoryRecords
HistoryRecord[] getProcessHistoryRecords(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(Long processId_, int startIndex_, int batchSize_, Integer sortProperty_, 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 ofConstants.COUNT_ALLwill 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 theSORT_BY_XXXconstants inHistoryRecordsortOrder_-Constants.SORT_ORDER_ASCENDINGfor sorting results in ascending order,Constants.SORT_ORDER_DESCENDINGfor 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(Long processModelId_, 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 ofConstants.COUNT_ALLwill result in the entire collection being returned, but this is STRONGLY discouraged.- Returns:
- A
ResultPagecontainingTaskSummaryobjects representing tasks that have the given status, from processes of the specified Process Model - Throws:
PrivilegeException
-
getTasksWithStatusForProcessModels
ResultPage getTasksWithStatusForProcessModels(Long[] processModelIds_, 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 ofConstants.COUNT_ALLwill result in the entire collection being returned, but this is STRONGLY discouraged.- Returns:
- A
ResultPagecontainingTaskSummaryobjects representing tasks that have the given status, from processes of the specified Process Models - Throws:
PrivilegeException
-
getTasksWithStatusForProcess
ResultPage getTasksWithStatusForProcess(Long processId_, Integer taskStatus_, boolean recursive_, int startIndex_, int batchSize_, Integer sortProperty_, 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 ofConstants.COUNT_ALLwill 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 theSORT_BY_XXXconstants inTaskSummarysortOrder_-Constants.SORT_ORDER_ASCENDINGfor sorting results in ascending order,Constants.SORT_ORDER_DESCENDINGfor sorting results in descending order- Returns:
- A
ResultPagecontainingTaskSummaryobjects representing tasks that have the given status from the specified process - Throws:
InvalidProcessExceptionPrivilegeException
-
getTasksWithStatusForProcesses
ResultPage getTasksWithStatusForProcesses(Long[] processIds_, 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 ofConstants.COUNT_ALLwill result in the entire collection being returned, but this is STRONGLY discouraged.- Returns:
- A
ResultPagecontainingTaskSummaryobjects representing tasks that have the given status from the specified processes - Throws:
InvalidProcessExceptionPrivilegeException
-
completeStore
Complete an external data store. The task must be in the expected state, waiting on external.- Parameters:
expressionGroupId-- Throws:
InvalidExpressionGroupException
-
cancelStore
void cancelStore(Long expressionGroupId, 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(Long activityId, boolean isQuickTask, ActivityClassParameter[] parameters) throws InvalidProcessModelException, InvalidPriorityException, PrivilegeException, InvalidStateException, StorageLimitException, InvalidUserException, 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 executeisQuickTask- whether or not the current activity is a quick taskparameters- the parameter values to use when executing the current activity- Throws:
InvalidProcessModelException- if the related process model is invalidInvalidPriorityException- if the related task priority does not existPrivilegeException- if the user does not have sufficient privileges to perform this operationInvalidStateException- if the process or task is cancelledStorageLimitException- if all execution engines are fullInvalidUserException- if any of the users referenced do not existIllegalArgumentException- if the given task is not attendedInvalidActivityException- if an activity id is invalidInvalidActivityClassParameterException- if anActivityClassParameterprovided does not existInvalidExpressionException- if a referenced expression does not existTaskNavigationException- if the given activityId would illegally send the process flow back to a previous task
-