IBM BPM API for Web Service Clients v8.0.0

com.lombardisoftware.webapi
Interface WebAPI

All Superinterfaces:
java.rmi.Remote

public interface WebAPI
extends java.rmi.Remote


Method Summary
 void _NotUsedOperation(ProcessInstanceStatus _notUsed1, TaskStatus _notUsed2, SearchableType _notUsed3, SearchableProcessColumn _notUsed4, SearchableProcessInstanceColumn _notUsed5, SearchableTaskColumn _notUsed6, SearchOperator _notUsed7, ExposedItemType _notUsed8)
          This operation should not be used by the client.
 boolean abortProcessInstance(long processInstanceId)
          Abort a process instance
 int abortProcessInstances(long[] processInstanceIds)
          Abort the process instances
 void addComment(long processInstanceId, java.lang.String comment)
          Adds comment to specified instance.
 void addHelpRequest(long processInstanceId, java.lang.String sendTo, java.lang.String description)
          Adds help request to specified instance
 boolean assignTask(long taskId)
          Assign a task to current user from a role to which the user belongs.
 int assignTasks(long[] taskIds)
          Assign multiple tasks to the current user from a role to which the user belongs.
 boolean changeProcessInstanceDueDate(long processInstanceId, java.util.Calendar dueDate)
          Change a process instance's due date
 int changeProcessInstancesDueDate(long[] processInstanceIds, java.util.Calendar dueDate)
          Change the process instances' due dates
 boolean changeTaskDueDate(long taskId, java.util.Calendar dueDate, boolean ignoreCalendarConflicts)
          Change the due date of a task.
 boolean changeTaskPriority(long taskId, long priorityId, boolean changeDueDate)
          Change a task priority, and optionally its due date.
 int changeTasksDueDate(long[] taskIds, java.util.Calendar dueDate, boolean ignoreCalendarConflicts)
          Change the due date of tasks.
 int changeTasksPriority(long[] taskIds, long priorityId, boolean changeDueDate)
          Change the priority of tasks, and optionally their due dates.
 com.lombardisoftware.webapi.CompleteTaskResult completeTask(long taskId, Variable[] outputs)
           Complete a task for an activity in a process instance.
 void createDocument(Document document)
          Creates document.
 void deleteDocument(long parentId)
          Deletes the document with all its revisions and assigned properties.
 boolean dueDateOkForTask(long taskId, java.util.Calendar dueDate)
          Check the availability of the recipients of a task using their calendars.
 SearchResults executeSearch(Search search, java.lang.Integer maxRows, java.lang.Integer beginIndex)
          Execute a search to retrieve task or process instance related information
 ActionPermission[] getActionPermissions(long[] processInstanceIds, long[] taskIds)
          Get a set of action states associated with a list of process instances and/or tasks.
 AdHocStartingPoint[] getAdHocStartingPoints(long processInstanceId)
          Get the list of ad-hoc actions available on the process instance.
 Role[] getAllRoles()
          Get all roles in the system
 User[] getAllUsers()
          Returns all users.
 User getCurrentUser()
          Get the current user
 Document getDocument(long documentId)
          Returns document for specific document ID.
 Document[] getDocumentsForProcessInstance(long processInstanceId)
          Returns the documents for a specific process instance id.
 Document[] getDocumentsForProperties(long processInstanceId, DocumentProperty[] properties, boolean matchAllProperties, java.lang.Boolean matchAllDocuments)
          Returns a collection of documents attached to the process instance with the given processInstanceId, and matched by given properties with given matching mode (AND/OR).
 ExposedItem[] getExposedItems(java.lang.String exposedItemType, java.lang.Boolean startable)
          Get the items exposed to the user
 Favorite[] getFavorites()
          Get the favorites visible to the user
 Priority[] getPriorities()
          Get the priorities in the system
 Process getProcessBySystemId(java.lang.String processAppAcronym, java.lang.String processSystemId)
          Get a process by its system identifier
 ProcessInstance getProcessInstance(long processInstanceId)
          Get a process instance
 BusinessData[] getProcessInstancesBusinessData(long[] processInstanceIds)
          Get the business data for multiple process instances
 ProcessInstance[] getProcessInstancesForSavedSearch(long savedSearchId)
          Get the process instances returned by the execution of a saved search.
 Role getRoleByName(java.lang.String roleName)
          Returns user group information for specific user group name.
 SavedSearch[] getSavedSearches()
          Get the saved searches visible to the user
 ScoreboardData getScoreboardData(java.lang.String scoreboardReference, java.lang.String scoreboardSnapshotId)
          Get the scoreboard data for the scoreboard
 Scoreboard[] getScoreboards()
          Get the scoreboards visible to the user
 SearchMetaData getSearchMetaData()
          Returns the available search columns that can be used in searches
 SearchMetaData getSearchMetaDataForProcess(Process process)
          Returns the available business data search columns for a process
 ServerInfo getServerInfo()
          Get information about the server including its version
 Task getTask(long taskId)
          Get the task.
 Task[] getTasksForSavedSearch(long savedSearchId)
          Get the tasks returned by the execution of a saved search.
 User getUserByName(java.lang.String userName)
          Returns user information for specific user name.
 UserConfiguration getUserConfiguration()
          Get all the user configuration information in one call.
 void ignoreHelpRequest(long helpRequestId, java.lang.String description)
          Ignores help request.
 boolean reassignTask(long taskId)
          Reassign a task back to its original role.
 int reassignTasks(long[] taskIds)
          Reassign the tasks back to their original roles.
 int reassignTasksToRole(long[] taskIds, long roleId)
          Reassign the tasks to a role.
 int reassignTasksToUser(long[] taskIds, long userId)
          Reassign the tasks to a user.
 boolean reassignTaskToRole(long taskId, long roleId)
          Reassign a task to a role.
 boolean reassignTaskToUser(long taskId, long userId)
          Reassign a task to a user
 boolean refreshGroupMembership(int refreshTimeout)
          Refresh the group membership to sync up with the external user directory by invoking this operation.
 void replyHelpRequest(long helpRequestId, java.lang.String description)
          Replies to help request.
 boolean resumeProcessInstance(long processInstanceId)
          Resume a process instance
 int resumeProcessInstances(long[] processInstanceIds)
          Resume the process instances
 Task runFavorite(long favoriteId)
          Run a favorite and return a task if it exists
 Task sendTask(SendTaskInfo sendTaskInfo)
          Send a task
 long[] startAdHocStartingPoint(long processInstanceId, java.lang.String startingPointName)
          Run the ad-hoc action.
 Task startExposedItem(long exposedItemId)
          Start an exposed item and return a task if it exists
 ProcessInstance startProcess(Process process, Variable[] inputs)
          Start a process and create a new process instance
 ProcessInstance startProcessWithInfoPathForm(Process process, long formId, InfoPathFormData formData)
          Start a process and create a new process instance with the output of an InfoPath form.
 boolean startTask(long taskId)
           Start a task for an activity in a process instance.
 boolean submitInfoPathForm(long taskId, InfoPathFormData formData)
          Submit an InfoPath form associated with a task id and a form data.
 boolean submitInfoPathForms(long[] taskIds, InfoPathFormData[] formDatas)
          Submit several InfoPath forms.
 boolean suspendProcessInstance(long processInstanceId)
          Suspend a process instance
 int suspendProcessInstances(long[] processInstanceIds)
          Suspend the process instances
 TaskListSyncOutput[] synchronizeTaskLists(TaskListSyncInput[] taskListSyncInputs)
          Synchronize task lists by passing in information describing the task lists stored on the client and receive back information about task synchronization actions to take on the client to synchronize the client's state with the current state on the server.
 boolean testConnection()
          Test the connection to this web service by invoking this operation.
 void updateDocument(Document document)
          Creates new version of a document.
 

Method Detail

testConnection

boolean testConnection()
                       throws java.rmi.RemoteException
Test the connection to this web service by invoking this operation.

Returns:
true if the connection succeeded; false otherwise
Throws:
java.rmi.RemoteException

refreshGroupMembership

boolean refreshGroupMembership(int refreshTimeout)
                               throws java.rmi.RemoteException
Refresh the group membership to sync up with the external user directory by invoking this operation. Please make sure the refresh timeout is greater than the time needed for the application server to refresh its cache for searching the external user directory.

Parameters:
refreshTimeout - Time in seconds to complete the operation.
Returns:
true if the operation succeeded; false otherwise
Throws:
java.rmi.RemoteException

getActionPermissions

ActionPermission[] getActionPermissions(long[] processInstanceIds,
                                        long[] taskIds)
                                        throws java.rmi.RemoteException
Get a set of action states associated with a list of process instances and/or tasks.

Parameters:
processInstanceIds - the array of process instance ids
taskIds - the array of task ids
Returns:
the action permissions
Throws:
java.rmi.RemoteException

assignTask

boolean assignTask(long taskId)
                   throws java.rmi.RemoteException
Assign a task to current user from a role to which the user belongs. This operation is only valid for tasks that are currently assigned to a role. Invoking this operation on tasks that are already assigned to the current user will result in an exception.

Parameters:
taskId - the id of task that should be assigned to current user
Returns:
true if task is assigned; false otherwise
Throws:
java.rmi.RemoteException

assignTasks

int assignTasks(long[] taskIds)
                throws java.rmi.RemoteException
Assign multiple tasks to the current user from a role to which the user belongs. This operation is only valid for tasks that are currently assigned to a role. Invoking this operation on tasks that are already assigned to the current user will result in an exception.

Parameters:
taskIds - the ids of the tasks that should be assigned to the current user
Returns:
the number of successfully assigned tasks
Throws:
java.rmi.RemoteException

changeTaskDueDate

boolean changeTaskDueDate(long taskId,
                          java.util.Calendar dueDate,
                          boolean ignoreCalendarConflicts)
                          throws java.rmi.RemoteException
Change the due date of a task.

Parameters:
taskId - the id of the task to change
dueDate - the new due date of the task
ignoreCalendarConflicts - true if calendar conflicts with the new due date should be ignored
Returns:
true if the task due date was successfully changed; false otherwise
Throws:
java.rmi.RemoteException

changeTaskPriority

boolean changeTaskPriority(long taskId,
                           long priorityId,
                           boolean changeDueDate)
                           throws java.rmi.RemoteException
Change a task priority, and optionally its due date.

Parameters:
taskId - the id of the task to change
priorityId - the id of the new priority
changeDueDate - if true, then update the due date based the new priority
Returns:
true if the task priority was successfully changed; false otherwise
Throws:
java.rmi.RemoteException

changeTasksDueDate

int changeTasksDueDate(long[] taskIds,
                       java.util.Calendar dueDate,
                       boolean ignoreCalendarConflicts)
                       throws java.rmi.RemoteException
Change the due date of tasks.

Parameters:
taskIds - the ids of the tasks to change
dueDate - the new due date of the tasks
ignoreCalendarConflicts - true if calendar conflicts with the new due date should be ignored
Returns:
the number of successfully changed tasks
Throws:
java.rmi.RemoteException

changeTasksPriority

int changeTasksPriority(long[] taskIds,
                        long priorityId,
                        boolean changeDueDate)
                        throws java.rmi.RemoteException
Change the priority of tasks, and optionally their due dates.

Parameters:
taskIds - the ids of the tasks to change
priorityId - the id of the new priority
changeDueDate - if true, then update the due date based the new priority
Returns:
the number of successfully changed tasks
Throws:
java.rmi.RemoteException

dueDateOkForTask

boolean dueDateOkForTask(long taskId,
                         java.util.Calendar dueDate)
                         throws java.rmi.RemoteException
Check the availability of the recipients of a task using their calendars.

Parameters:
taskId - the id of the task to check
dueDate - the due date to check
Returns:
true if recipients recipient of a task are available for the due date; false otherwise
Throws:
java.rmi.RemoteException

reassignTask

boolean reassignTask(long taskId)
                     throws java.rmi.RemoteException
Reassign a task back to its original role.

Parameters:
taskId - the id of the task to reassign
Returns:
true if the task was successfully reassigned; false otherwise
Throws:
java.rmi.RemoteException

reassignTasks

int reassignTasks(long[] taskIds)
                  throws java.rmi.RemoteException
Reassign the tasks back to their original roles.

Parameters:
taskIds - the ids of the tasks to reassign
Returns:
the number of successfully reassigned tasks
Throws:
java.rmi.RemoteException

reassignTasksToRole

int reassignTasksToRole(long[] taskIds,
                        long roleId)
                        throws java.rmi.RemoteException
Reassign the tasks to a role.

Parameters:
taskIds - the ids of the tasks to reassign
roleId - the id of the role
Returns:
the number of successfully reassigned tasks
Throws:
java.rmi.RemoteException

reassignTasksToUser

int reassignTasksToUser(long[] taskIds,
                        long userId)
                        throws java.rmi.RemoteException
Reassign the tasks to a user.

Parameters:
taskIds - the ids of the tasks to reassign
userId - the id of the user
Returns:
the number of successfully reassigned tasks
Throws:
java.rmi.RemoteException

reassignTaskToRole

boolean reassignTaskToRole(long taskId,
                           long roleId)
                           throws java.rmi.RemoteException
Reassign a task to a role.

Parameters:
taskId - the id of the task to reassign
roleId - the id of the role
Returns:
true if the task was successfully reassigned; false otherwise
Throws:
java.rmi.RemoteException

reassignTaskToUser

boolean reassignTaskToUser(long taskId,
                           long userId)
                           throws java.rmi.RemoteException
Reassign a task to a user

Parameters:
taskId - The task id of the task to reassign
userId - The user id of the user
Returns:
True if the task was successfully reassigned
Throws:
java.rmi.RemoteException

abortProcessInstance

boolean abortProcessInstance(long processInstanceId)
                             throws java.rmi.RemoteException
Abort a process instance

Parameters:
processInstanceId - The process instance id of the process instance to abort
Returns:
True if the process instance was successfully aborted
Throws:
java.rmi.RemoteException

abortProcessInstances

int abortProcessInstances(long[] processInstanceIds)
                          throws java.rmi.RemoteException
Abort the process instances

Parameters:
processInstanceIds - The process instance ids of the process instances to abort
Returns:
The number of successfully aborted process instances
Throws:
java.rmi.RemoteException

changeProcessInstanceDueDate

boolean changeProcessInstanceDueDate(long processInstanceId,
                                     java.util.Calendar dueDate)
                                     throws java.rmi.RemoteException
Change a process instance's due date

Parameters:
processInstanceId - The process instance id of the process instance to change
dueDate - New due date of the process instance
Returns:
True if the due date was successfully changed
Throws:
java.rmi.RemoteException

changeProcessInstancesDueDate

int changeProcessInstancesDueDate(long[] processInstanceIds,
                                  java.util.Calendar dueDate)
                                  throws java.rmi.RemoteException
Change the process instances' due dates

Parameters:
processInstanceIds - The process instance ids of the process instances to change
dueDate - New due date of the process instances
Returns:
The number of successfully changed process instances
Throws:
java.rmi.RemoteException

getProcessInstancesBusinessData

BusinessData[] getProcessInstancesBusinessData(long[] processInstanceIds)
                                               throws java.rmi.RemoteException
Get the business data for multiple process instances

Parameters:
processInstanceIds - The process instance ids of the process instances
Returns:
The business data for each of the process instances
Throws:
java.rmi.RemoteException

resumeProcessInstance

boolean resumeProcessInstance(long processInstanceId)
                              throws java.rmi.RemoteException
Resume a process instance

Parameters:
processInstanceId - The process instance id of the process instance to resume
Returns:
True if the process instance was successfully resumed
Throws:
java.rmi.RemoteException

resumeProcessInstances

int resumeProcessInstances(long[] processInstanceIds)
                           throws java.rmi.RemoteException
Resume the process instances

Parameters:
processInstanceIds - The process instance ids of the process instances to resume
Returns:
The number of successfully resumed process instances
Throws:
java.rmi.RemoteException

suspendProcessInstance

boolean suspendProcessInstance(long processInstanceId)
                               throws java.rmi.RemoteException
Suspend a process instance

Parameters:
processInstanceId - The process instance id of the process instance to suspend
Returns:
True if the process instance was successfully suspended
Throws:
java.rmi.RemoteException

suspendProcessInstances

int suspendProcessInstances(long[] processInstanceIds)
                            throws java.rmi.RemoteException
Suspend the process instances

Parameters:
processInstanceIds - The process instance ids of the process instances to suspend
Returns:
The number of successfully suspended process instances
Throws:
java.rmi.RemoteException

startProcess

ProcessInstance startProcess(Process process,
                             Variable[] inputs)
                             throws java.rmi.RemoteException
Start a process and create a new process instance

Parameters:
process - The process to start
inputs - The input variables to use when starting the process
Returns:
The started process instance
Throws:
java.rmi.RemoteException

startProcessWithInfoPathForm

ProcessInstance startProcessWithInfoPathForm(Process process,
                                             long formId,
                                             InfoPathFormData formData)
                                             throws java.rmi.RemoteException
Start a process and create a new process instance with the output of an InfoPath form. The process must have an InfoPath Form Start Event with an attached form that matches the submitted form data.

Parameters:
process - The process to start
formId - The form id of the InfoPath form to create the form data
formData - The InfoPath form data to use to start the process
Returns:
The started process instance
Throws:
java.rmi.RemoteException

sendTask

Task sendTask(SendTaskInfo sendTaskInfo)
              throws java.rmi.RemoteException
Send a task

Parameters:
sendTaskInfo - The information describing the task to send
Returns:
The sent task
Throws:
java.rmi.RemoteException

startTask

boolean startTask(long taskId)
                  throws java.rmi.RemoteException

Start a task for an activity in a process instance. This requires that the task is not closed and is assigned to the current user or to a role to which the current user belongs. The activity implementation for this task must be an External Activity or a Service.

An external application should invoke this operation when it actually starts execution of a task. A successful invocation of this operation will record the task's start time using the current user's identity.

Parameters:
taskId - The task id of the task to be started
Returns:
True if the task was successfully started
Throws:
java.rmi.RemoteException

completeTask

com.lombardisoftware.webapi.CompleteTaskResult completeTask(long taskId,
                                                            Variable[] outputs)
                                                            throws java.rmi.RemoteException

Complete a task for an activity in a process instance. This requires that the task is not closed and is assigned to the current user or to a role to which the current user belongs. The activity implementation for this task must be an External Activity or a Service. For InfoPath activity implementations, use one of the SubmitInfoPathForm(s) operations instead.

A successful invocation of this operation will close the task using the current user's identity and will send an asynchronous notification of the task's completion to the process engine for the process instance associated with the task. This operation then returns.

Some time later, the process engine will receive the notification of the task's completion and will resume execution of the process instance. It will map the outputs according to the data mappings defined in the process for the task's activity. It will then continue execution of the steps that follow the completed task's activity in the process.

If the task implementation is External Activity, then the outputs are saved in the ExternalActivityData when the task is closed. If the task is subsequently accessed (for example using a History search or via GetProcessInstance), these output values will be visible. If the output variable has the same name as an input, then its value will overwrite the input variable's value. Thus if it desirable to view both the input and output values for a completed External Activity task, then the parameters should be uniquely named (perhaps using "In" and "Out" postfixes).

Parameters:
taskId - The task id of the task to complete
outputs - The output variables to pass as the outputs of the completed task. The values may be simple or complex types. See the documentation of the Variable type for details.
Returns:
True if the task was successfully completed
Throws:
java.rmi.RemoteException

submitInfoPathForms

boolean submitInfoPathForms(long[] taskIds,
                            InfoPathFormData[] formDatas)
                            throws java.rmi.RemoteException
Submit several InfoPath forms. Takes two equal length arrays of task ids and corresponding form datas.

Parameters:
taskIds - the array of task ids
formDatas - the array of InfoPath form datas
Returns:
true if the InfoPath forms were successfully submitted; false otherwise
Throws:
java.rmi.RemoteException

submitInfoPathForm

boolean submitInfoPathForm(long taskId,
                           InfoPathFormData formData)
                           throws java.rmi.RemoteException
Submit an InfoPath form associated with a task id and a form data.

Parameters:
taskId - the task id
formData - the form data
Returns:
true if the InfoPath form was successfully submitted; false otherwise
Throws:
java.rmi.RemoteException

getProcessInstance

ProcessInstance getProcessInstance(long processInstanceId)
                                   throws java.rmi.RemoteException
Get a process instance

Parameters:
processInstanceId - The process instance id of the process to get
Returns:
The process instance
Throws:
java.rmi.RemoteException

getProcessInstancesForSavedSearch

ProcessInstance[] getProcessInstancesForSavedSearch(long savedSearchId)
                                                    throws java.rmi.RemoteException
Get the process instances returned by the execution of a saved search. This will temporarily alter the definition of the saved search (in memory) to organize its results by process instance and to include all of the process and process instance fields.

Parameters:
savedSearchId - The saved search id of the saved search to execute
Returns:
The process instances
Throws:
java.rmi.RemoteException

getTasksForSavedSearch

Task[] getTasksForSavedSearch(long savedSearchId)
                              throws java.rmi.RemoteException
Get the tasks returned by the execution of a saved search. This will temporarily alter the definition of the saved search (in memory) to organize its results by task and to include all of the process, process instance, and task fields.

Parameters:
savedSearchId - The saved search id of the saved search to execute
Returns:
The tasks
Throws:
java.rmi.RemoteException

getCurrentUser

User getCurrentUser()
                    throws java.rmi.RemoteException
Get the current user

Returns:
The current user
Throws:
java.rmi.RemoteException

getFavorites

Favorite[] getFavorites()
                        throws java.rmi.RemoteException
Get the favorites visible to the user

Returns:
The favorites
Throws:
java.rmi.RemoteException

getExposedItems

ExposedItem[] getExposedItems(java.lang.String exposedItemType,
                              java.lang.Boolean startable)
                              throws java.rmi.RemoteException
Get the items exposed to the user

Returns:
The favorites
Throws:
java.rmi.RemoteException

startExposedItem

Task startExposedItem(long exposedItemId)
                      throws java.rmi.RemoteException
Start an exposed item and return a task if it exists

Parameters:
exposedItemId -
Returns:
The task to run. It can be null if there is no task for the current user.
Throws:
java.rmi.RemoteException

getSavedSearches

SavedSearch[] getSavedSearches()
                               throws java.rmi.RemoteException
Get the saved searches visible to the user

Returns:
The saved searches
Throws:
java.rmi.RemoteException

getScoreboards

Scoreboard[] getScoreboards()
                            throws java.rmi.RemoteException
Get the scoreboards visible to the user

Returns:
The scoreboards
Throws:
java.rmi.RemoteException

getScoreboardData

ScoreboardData getScoreboardData(java.lang.String scoreboardReference,
                                 java.lang.String scoreboardSnapshotId)
                                 throws java.rmi.RemoteException
Get the scoreboard data for the scoreboard

Parameters:
scoreboardId - id of the scoreboard
Returns:
The scoreboard data
Throws:
java.rmi.RemoteException

getAllRoles

Role[] getAllRoles()
                   throws java.rmi.RemoteException
Get all roles in the system

Returns:
The roles
Throws:
java.rmi.RemoteException

getPriorities

Priority[] getPriorities()
                         throws java.rmi.RemoteException
Get the priorities in the system

Returns:
The priorities
Throws:
java.rmi.RemoteException

synchronizeTaskLists

TaskListSyncOutput[] synchronizeTaskLists(TaskListSyncInput[] taskListSyncInputs)
                                          throws java.rmi.RemoteException
Synchronize task lists by passing in information describing the task lists stored on the client and receive back information about task synchronization actions to take on the client to synchronize the client's state with the current state on the server. The client should create a task list synchronization input for each saved search being synchronized with the server. This contains the saved search id, last synchronization date, and a comma separated string listing the task ids present (active) on the client. The implementation should create an output for each input. The task list synchronization output object will contain the saved search id, the synchronization date, and a list of task synchronization actions. The task synchronization action specifies one of three actions: - add - update - remove Add and update actions will contain the task details. Remove actions will only contain the task id. The client can iterate over these actions applying them to the client side storage to bring it into sync with the server.

Parameters:
taskListSyncInputs - a list of task list synchronization inputs
Returns:
The task list synchronization outputs
Throws:
java.rmi.RemoteException

getUserConfiguration

UserConfiguration getUserConfiguration()
                                       throws java.rmi.RemoteException
Get all the user configuration information in one call.

Returns:
The user configuration information
Throws:
java.rmi.RemoteException

runFavorite

Task runFavorite(long favoriteId)
                 throws java.rmi.RemoteException
Run a favorite and return a task if it exists

Parameters:
favoriteId -
Returns:
The task to run. It can be null if there is no task for the current user.
Throws:
java.rmi.RemoteException

getServerInfo

ServerInfo getServerInfo()
                         throws java.rmi.RemoteException
Get information about the server including its version

Returns:
The server information
Throws:
java.rmi.RemoteException

executeSearch

SearchResults executeSearch(Search search,
                            java.lang.Integer maxRows,
                            java.lang.Integer beginIndex)
                            throws java.rmi.RemoteException
Execute a search to retrieve task or process instance related information

Returns:
The search results
Throws:
java.rmi.RemoteException

getProcessBySystemId

Process getProcessBySystemId(java.lang.String processAppAcronym,
                             java.lang.String processSystemId)
                             throws java.rmi.RemoteException
Get a process by its system identifier

Parameters:
processAppAcronym - The Acronym of the Process Application
processSystemId - The System Id of the Process to find
Returns:
The process
Throws:
java.rmi.RemoteException

addHelpRequest

void addHelpRequest(long processInstanceId,
                    java.lang.String sendTo,
                    java.lang.String description)
                    throws java.rmi.RemoteException
Adds help request to specified instance

Parameters:
processInstanceId - id of instance
sendTo - who receives the request
description - description of help request
Throws:
java.rmi.RemoteException

replyHelpRequest

void replyHelpRequest(long helpRequestId,
                      java.lang.String description)
                      throws java.rmi.RemoteException
Replies to help request.

Parameters:
helpRequestId - id of help request to reply
description - description of reply to help request
Throws:
java.rmi.RemoteException

ignoreHelpRequest

void ignoreHelpRequest(long helpRequestId,
                       java.lang.String description)
                       throws java.rmi.RemoteException
Ignores help request.

Parameters:
helpRequestId - id of comment
description - description of why request is ignored
Throws:
java.rmi.RemoteException

addComment

void addComment(long processInstanceId,
                java.lang.String comment)
                throws java.rmi.RemoteException
Adds comment to specified instance.

Parameters:
processInstanceId - id of instance
comment - comment for add
Throws:
java.rmi.RemoteException

createDocument

void createDocument(Document document)
                    throws java.rmi.RemoteException
Creates document.

Parameters:
document - document for adding
Throws:
java.rmi.RemoteException

updateDocument

void updateDocument(Document document)
                    throws java.rmi.RemoteException
Creates new version of a document.

Parameters:
document - document for updating
Throws:
java.rmi.RemoteException

getDocument

Document getDocument(long documentId)
                     throws java.rmi.RemoteException
Returns document for specific document ID.

Parameters:
documentId - document ID
Throws:
java.rmi.RemoteException

getDocumentsForProcessInstance

Document[] getDocumentsForProcessInstance(long processInstanceId)
                                          throws java.rmi.RemoteException
Returns the documents for a specific process instance id.

Parameters:
processInstanceId - the instance id. This parameter can take following values:
  • -1
  • - to find documents which are not assigned with any process instance;
  • 0
  • - to find all documents;
  • >0
  • - to find documents which are assigned with given process instance.
Returns:
the Documents
Throws:
java.rmi.RemoteException

getDocumentsForProperties

Document[] getDocumentsForProperties(long processInstanceId,
                                     DocumentProperty[] properties,
                                     boolean matchAllProperties,
                                     java.lang.Boolean matchAllDocuments)
                                     throws java.rmi.RemoteException
Returns a collection of documents attached to the process instance with the given processInstanceId, and matched by given properties with given matching mode (AND/OR).

Parameters:
processInstanceId - the instance id. This parameter can take following values:
  • -1
  • - to find documents which are not assigned with any process instance;
  • 0
  • - to find all documents;
  • >0
  • - to find documents which are assigned with given process instance.
properties - the properties Map [Property Name -> Property Value], these properties will be used for documents matching.
matchAllProperties - the flag specifying property matching mode. This points to which boolean operator will be used for property matching. If true is passed, it means that AND operator will be used. So all returned documents have all passed properties with all corresponding passed values. If false is passed it means that OR operator will be used. So all returned documents can have only one (or more but not the less) property with corresponding value.
matchAllDocuments - the flag specifying document matching mode. If then documents not attached to any process instance are also used for matching. If parameter is <0> then document matching mode is not applicable.
Returns:
the Documents that satisfied given matching parameters
Throws:
java.rmi.RemoteException

deleteDocument

void deleteDocument(long parentId)
                    throws java.rmi.RemoteException
Deletes the document with all its revisions and assigned properties.

Parameters:
parentId - the id of document which has to be deleted.
Throws:
java.rmi.RemoteException

getUserByName

User getUserByName(java.lang.String userName)
                   throws java.rmi.RemoteException
Returns user information for specific user name.

Parameters:
userName - user name
Returns:
user information
Throws:
java.rmi.RemoteException

getRoleByName

Role getRoleByName(java.lang.String roleName)
                   throws java.rmi.RemoteException
Returns user group information for specific user group name.

Parameters:
roleName - the user group name
Returns:
the user group information
Throws:
java.rmi.RemoteException

getAllUsers

User[] getAllUsers()
                   throws java.rmi.RemoteException
Returns all users.

Returns:
collection of User objects
Throws:
java.rmi.RemoteException

getSearchMetaData

SearchMetaData getSearchMetaData()
                                 throws java.rmi.RemoteException
Returns the available search columns that can be used in searches

Returns:
collection of SearchColumn objects
Throws:
java.rmi.RemoteException

getSearchMetaDataForProcess

SearchMetaData getSearchMetaDataForProcess(Process process)
                                           throws java.rmi.RemoteException
Returns the available business data search columns for a process

Parameters:
process - The process to get search meta data for
Returns:
collection of SearchColumn objects
Throws:
java.rmi.RemoteException

getTask

Task getTask(long taskId)
             throws java.rmi.RemoteException
Get the task. Return the task object fully populated (including the ProcessInstance element).

Parameters:
taskId - id of task
Returns:
The task object
Throws:
java.rmi.RemoteException

_NotUsedOperation

void _NotUsedOperation(ProcessInstanceStatus _notUsed1,
                       TaskStatus _notUsed2,
                       SearchableType _notUsed3,
                       SearchableProcessColumn _notUsed4,
                       SearchableProcessInstanceColumn _notUsed5,
                       SearchableTaskColumn _notUsed6,
                       SearchOperator _notUsed7,
                       ExposedItemType _notUsed8)
                       throws java.rmi.RemoteException
This operation should not be used by the client. It is included types that are in the schema but are not directly referenced in any other operation interface to ensure that the client web service stack will generate code for these types.

Throws:
java.rmi.RemoteException

getAdHocStartingPoints

AdHocStartingPoint[] getAdHocStartingPoints(long processInstanceId)
                                            throws java.rmi.RemoteException
Get the list of ad-hoc actions available on the process instance.

Parameters:
processInstanceId - process instance to get ad-hoc starting points for
Returns:
The list of available starting points
Throws:
java.rmi.RemoteException

startAdHocStartingPoint

long[] startAdHocStartingPoint(long processInstanceId,
                               java.lang.String startingPointName)
                               throws java.rmi.RemoteException
Run the ad-hoc action.

Parameters:
processInstanceId - process instance for which to start ad-hoc starting point
startingPointName - ad-hoc starting point name
Returns:
The list of new task IDs
Throws:
java.rmi.RemoteException

IBM BPM API for Web Service Clients v8.0.0

(C) Copyright IBM Corporation 2011. All Rights Reserved.