|
IBM BPM API for Web Service Clients v8.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WebAPI
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 |
---|
boolean testConnection() throws java.rmi.RemoteException
java.rmi.RemoteException
boolean refreshGroupMembership(int refreshTimeout) throws java.rmi.RemoteException
refreshTimeout
- Time in seconds to complete the operation.
java.rmi.RemoteException
ActionPermission[] getActionPermissions(long[] processInstanceIds, long[] taskIds) throws java.rmi.RemoteException
processInstanceIds
- the array of process instance idstaskIds
- the array of task ids
java.rmi.RemoteException
boolean assignTask(long taskId) throws java.rmi.RemoteException
taskId
- the id of task that should be assigned to current user
java.rmi.RemoteException
int assignTasks(long[] taskIds) throws java.rmi.RemoteException
taskIds
- the ids of the tasks that should be assigned to the
current user
java.rmi.RemoteException
boolean changeTaskDueDate(long taskId, java.util.Calendar dueDate, boolean ignoreCalendarConflicts) throws java.rmi.RemoteException
taskId
- the id of the task to changedueDate
- the new due date of the taskignoreCalendarConflicts
- true if calendar conflicts with the
new due date should
be ignored
java.rmi.RemoteException
boolean changeTaskPriority(long taskId, long priorityId, boolean changeDueDate) throws java.rmi.RemoteException
taskId
- the id of the task to changepriorityId
- the id of the new prioritychangeDueDate
- if true, then update the due date based the new
priority
java.rmi.RemoteException
int changeTasksDueDate(long[] taskIds, java.util.Calendar dueDate, boolean ignoreCalendarConflicts) throws java.rmi.RemoteException
taskIds
- the ids of the tasks to changedueDate
- the new due date of the tasksignoreCalendarConflicts
- true if calendar conflicts with the
new due date should
be ignored
java.rmi.RemoteException
int changeTasksPriority(long[] taskIds, long priorityId, boolean changeDueDate) throws java.rmi.RemoteException
taskIds
- the ids of the tasks to changepriorityId
- the id of the new prioritychangeDueDate
- if true, then update the due date based the new
priority
java.rmi.RemoteException
boolean dueDateOkForTask(long taskId, java.util.Calendar dueDate) throws java.rmi.RemoteException
taskId
- the id of the task to checkdueDate
- the due date to check
java.rmi.RemoteException
boolean reassignTask(long taskId) throws java.rmi.RemoteException
taskId
- the id of the task to reassign
java.rmi.RemoteException
int reassignTasks(long[] taskIds) throws java.rmi.RemoteException
taskIds
- the ids of the tasks to reassign
java.rmi.RemoteException
int reassignTasksToRole(long[] taskIds, long roleId) throws java.rmi.RemoteException
taskIds
- the ids of the tasks to reassignroleId
- the id of the role
java.rmi.RemoteException
int reassignTasksToUser(long[] taskIds, long userId) throws java.rmi.RemoteException
taskIds
- the ids of the tasks to reassignuserId
- the id of the user
java.rmi.RemoteException
boolean reassignTaskToRole(long taskId, long roleId) throws java.rmi.RemoteException
taskId
- the id of the task to reassignroleId
- the id of the role
java.rmi.RemoteException
boolean reassignTaskToUser(long taskId, long userId) throws java.rmi.RemoteException
taskId
- The task id of the task to reassignuserId
- The user id of the user
java.rmi.RemoteException
boolean abortProcessInstance(long processInstanceId) throws java.rmi.RemoteException
processInstanceId
- The process instance id of the process instance
to abort
java.rmi.RemoteException
int abortProcessInstances(long[] processInstanceIds) throws java.rmi.RemoteException
processInstanceIds
- The process instance ids of the process
instances to abort
java.rmi.RemoteException
boolean changeProcessInstanceDueDate(long processInstanceId, java.util.Calendar dueDate) throws java.rmi.RemoteException
processInstanceId
- The process instance id of the process instance
to changedueDate
- New due date of the process instance
java.rmi.RemoteException
int changeProcessInstancesDueDate(long[] processInstanceIds, java.util.Calendar dueDate) throws java.rmi.RemoteException
processInstanceIds
- The process instance ids of the process
instances to changedueDate
- New due date of the process instances
java.rmi.RemoteException
BusinessData[] getProcessInstancesBusinessData(long[] processInstanceIds) throws java.rmi.RemoteException
processInstanceIds
- The process instance ids of the process
instances
java.rmi.RemoteException
boolean resumeProcessInstance(long processInstanceId) throws java.rmi.RemoteException
processInstanceId
- The process instance id of the process instance
to resume
java.rmi.RemoteException
int resumeProcessInstances(long[] processInstanceIds) throws java.rmi.RemoteException
processInstanceIds
- The process instance ids of the process
instances to resume
java.rmi.RemoteException
boolean suspendProcessInstance(long processInstanceId) throws java.rmi.RemoteException
processInstanceId
- The process instance id of the process instance
to suspend
java.rmi.RemoteException
int suspendProcessInstances(long[] processInstanceIds) throws java.rmi.RemoteException
processInstanceIds
- The process instance ids of the process
instances to suspend
java.rmi.RemoteException
ProcessInstance startProcess(Process process, Variable[] inputs) throws java.rmi.RemoteException
process
- The process to startinputs
- The input variables to use when starting the process
java.rmi.RemoteException
ProcessInstance startProcessWithInfoPathForm(Process process, long formId, InfoPathFormData formData) throws java.rmi.RemoteException
process
- The process to startformId
- The form id of the InfoPath form to create the form
dataformData
- The InfoPath form data to use to start the process
java.rmi.RemoteException
Task sendTask(SendTaskInfo sendTaskInfo) throws java.rmi.RemoteException
sendTaskInfo
- The information describing the task to send
java.rmi.RemoteException
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.
taskId
- The task id of the task to be started
java.rmi.RemoteException
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).
taskId
- The task id of the task to completeoutputs
- 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.
java.rmi.RemoteException
boolean submitInfoPathForms(long[] taskIds, InfoPathFormData[] formDatas) throws java.rmi.RemoteException
taskIds
- the array of task idsformDatas
- the array of InfoPath form datas
java.rmi.RemoteException
boolean submitInfoPathForm(long taskId, InfoPathFormData formData) throws java.rmi.RemoteException
taskId
- the task idformData
- the form data
java.rmi.RemoteException
ProcessInstance getProcessInstance(long processInstanceId) throws java.rmi.RemoteException
processInstanceId
- The process instance id of the process to
get
java.rmi.RemoteException
ProcessInstance[] getProcessInstancesForSavedSearch(long savedSearchId) throws java.rmi.RemoteException
savedSearchId
- The saved search id of the saved search to execute
java.rmi.RemoteException
Task[] getTasksForSavedSearch(long savedSearchId) throws java.rmi.RemoteException
savedSearchId
- The saved search id of the saved search to execute
java.rmi.RemoteException
User getCurrentUser() throws java.rmi.RemoteException
java.rmi.RemoteException
Favorite[] getFavorites() throws java.rmi.RemoteException
java.rmi.RemoteException
ExposedItem[] getExposedItems(java.lang.String exposedItemType, java.lang.Boolean startable) throws java.rmi.RemoteException
java.rmi.RemoteException
Task startExposedItem(long exposedItemId) throws java.rmi.RemoteException
exposedItemId
-
java.rmi.RemoteException
SavedSearch[] getSavedSearches() throws java.rmi.RemoteException
java.rmi.RemoteException
Scoreboard[] getScoreboards() throws java.rmi.RemoteException
java.rmi.RemoteException
ScoreboardData getScoreboardData(java.lang.String scoreboardReference, java.lang.String scoreboardSnapshotId) throws java.rmi.RemoteException
scoreboardId
- id of the scoreboard
java.rmi.RemoteException
Role[] getAllRoles() throws java.rmi.RemoteException
java.rmi.RemoteException
Priority[] getPriorities() throws java.rmi.RemoteException
java.rmi.RemoteException
TaskListSyncOutput[] synchronizeTaskLists(TaskListSyncInput[] taskListSyncInputs) throws java.rmi.RemoteException
taskListSyncInputs
- a list of task list synchronization inputs
java.rmi.RemoteException
UserConfiguration getUserConfiguration() throws java.rmi.RemoteException
java.rmi.RemoteException
Task runFavorite(long favoriteId) throws java.rmi.RemoteException
favoriteId
-
java.rmi.RemoteException
ServerInfo getServerInfo() throws java.rmi.RemoteException
java.rmi.RemoteException
SearchResults executeSearch(Search search, java.lang.Integer maxRows, java.lang.Integer beginIndex) throws java.rmi.RemoteException
java.rmi.RemoteException
Process getProcessBySystemId(java.lang.String processAppAcronym, java.lang.String processSystemId) throws java.rmi.RemoteException
processAppAcronym
- The Acronym of the Process ApplicationprocessSystemId
- The System Id of the Process to find
java.rmi.RemoteException
void addHelpRequest(long processInstanceId, java.lang.String sendTo, java.lang.String description) throws java.rmi.RemoteException
processInstanceId
- id of instancesendTo
- who receives the requestdescription
- description of help request
java.rmi.RemoteException
void replyHelpRequest(long helpRequestId, java.lang.String description) throws java.rmi.RemoteException
helpRequestId
- id of help request to replydescription
- description of reply to help request
java.rmi.RemoteException
void ignoreHelpRequest(long helpRequestId, java.lang.String description) throws java.rmi.RemoteException
helpRequestId
- id of commentdescription
- description of why request is ignored
java.rmi.RemoteException
void addComment(long processInstanceId, java.lang.String comment) throws java.rmi.RemoteException
processInstanceId
- id of instancecomment
- comment for add
java.rmi.RemoteException
void createDocument(Document document) throws java.rmi.RemoteException
document
- document for adding
java.rmi.RemoteException
void updateDocument(Document document) throws java.rmi.RemoteException
document
- document for updating
java.rmi.RemoteException
Document getDocument(long documentId) throws java.rmi.RemoteException
documentId
- document ID
java.rmi.RemoteException
Document[] getDocumentsForProcessInstance(long processInstanceId) throws java.rmi.RemoteException
processInstanceId
- the instance id. This parameter can take
following values:java.rmi.RemoteException
Document[] getDocumentsForProperties(long processInstanceId, DocumentProperty[] properties, boolean matchAllProperties, java.lang.Boolean matchAllDocuments) throws java.rmi.RemoteException
processInstanceId
- the instance id. This parameter can take
following values: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 java.rmi.RemoteException
void deleteDocument(long parentId) throws java.rmi.RemoteException
parentId
- the id of document which has to be deleted.
java.rmi.RemoteException
User getUserByName(java.lang.String userName) throws java.rmi.RemoteException
userName
- user name
java.rmi.RemoteException
Role getRoleByName(java.lang.String roleName) throws java.rmi.RemoteException
roleName
- the user group name
java.rmi.RemoteException
User[] getAllUsers() throws java.rmi.RemoteException
java.rmi.RemoteException
SearchMetaData getSearchMetaData() throws java.rmi.RemoteException
java.rmi.RemoteException
SearchMetaData getSearchMetaDataForProcess(Process process) throws java.rmi.RemoteException
process
- The process to get search meta data for
java.rmi.RemoteException
Task getTask(long taskId) throws java.rmi.RemoteException
taskId
- id of task
java.rmi.RemoteException
void _NotUsedOperation(ProcessInstanceStatus _notUsed1, TaskStatus _notUsed2, SearchableType _notUsed3, SearchableProcessColumn _notUsed4, SearchableProcessInstanceColumn _notUsed5, SearchableTaskColumn _notUsed6, SearchOperator _notUsed7, ExposedItemType _notUsed8) throws java.rmi.RemoteException
java.rmi.RemoteException
AdHocStartingPoint[] getAdHocStartingPoints(long processInstanceId) throws java.rmi.RemoteException
processInstanceId
- process instance to get ad-hoc starting points
for
java.rmi.RemoteException
long[] startAdHocStartingPoint(long processInstanceId, java.lang.String startingPointName) throws java.rmi.RemoteException
processInstanceId
- process instance for which to start ad-hoc
starting pointstartingPointName
- ad-hoc starting point name
java.rmi.RemoteException
|
IBM BPM API for Web Service Clients v8.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |