IBM BPM API for Web Service Clients v8.0.0

Package com.lombardisoftware.webapi

Interface Summary
WebAPI  
 

Class Summary
Action  
ActionPermission An ActionPermission describes whether or not the authenticated user can execute a particular action associated with a process instance or task.
AdHocStartingPoint  
BusinessData BusinessData is used to access the variables defined by the root process of a process instance.
ChartData ChartData contains the image data that is referenced in the scoreboard content.
ClientInfo The ClientInfo type is used in a SOAP header to pass information about the client invoking a WebAPI operation.
ComplexValue A ComplexValue is used to wrap complex type values to pass to and from WebAPI operations and can contain a single element from any namespace.
CustomProperty A CustomProperty is used to annotate a library item with custom properties in the form of a string key/value pair.
DeleteDocument  
DeleteDocumentResponse  
Document A Document can be attached to a process instance to store information related to the business process along with the process instance itself.
DocumentProperty A DocumentProperty is used to annotate a document with additional properties/attributes in the form of a string key/value pair.
DocumentType  
ExposedItem An ExposedItem
ExposedItemType  
ExternalActivity The ExternalActivity is the describes the custom properties, input, and output parameters for use by the client to implement the activity.
ExternalActivityAttachment An ExternalActivityAttachment is used to attach the external activity definition and the external activity data to a task.
ExternalActivityData The variables and documents associated with an external activity that can be used by the client to guide the user through the activity.
Favorite A Favorite defines a way for users to start a process or a service based on their membership in the role associated with the favorite.
FavoriteType  
InfoPathForm For use by WLE for Office
InfoPathFormAttachment For use by WLE for Office
InfoPathFormData For use by WLE for Office
Parameter A Parameter defines a name and a type for a parameter (input or output) to a process or activity
Priority Priority is used to organize tasks by importance.
Process A Process is the business process definition and can be used to start new process instances or to group process instances returned by the various operations in this API.
ProcessInstance A ProcessInstance contains information about an instance of a process.
ProcessInstanceStatus  
Report A Report
Role A Role within WLE can determine what actions its members are allowed to perform and which process instances and tasks they can interact with.
SavedSearch A SavedSearch is used by clients to execute a search to retrieve process instances and/or tasks from WLE.
Scoreboard A Scoreboard describes a set of reports usually describing process or task performance that can be viewed by the user.
ScoreboardData ScoreboardData contains the actual data for a scoreboard as of the point in time when it was requested.
Search A search object describes a search to be performed against process runtime data including tasks and process instances.
SearchableProcessColumn  
SearchableProcessInstanceColumn  
SearchableTaskColumn  
SearchableType  
SearchColumn A SearchColumn is used to specify the columns, conditions, and ordering of a search.
SearchColumnMetaData  
SearchCondition A SearchCondition is used to limit the search results by constraining a search column using an operator and a value.
SearchMetaData SearchMetaData is used to describe information required to perform searches and to describe the results of searches.
SearchOperator  
SearchOrder  
SearchOrdering A SearchOrdering is used to specify that the search results should be sorted by a column in either an ascending or descending order.
SearchResultRow A SearchResultRow contains a set of values - one value for each column in the search that met the search conditions.
SearchResults A SearchResults object contains the column meta-data for columns specified in the search and a list of rows containing values for each of the columns ordered by the search ordering.
SendTaskInfo SendTaskInfo can be used to construct and send a task that has no implementation and is not associated with a process instance.
ServerInfo ServerInfo describes information about the server implementation and environment that might be needed by the client.
Service A Service is used as an activity implementation for a task and will typically contain coaches to guide a user through the activity.
Task A task is contain information about an instance of an activity and is typically associated with a process instance.
TaskListSyncInput TaskListSyncInput is used to synchronize a task list on a client with the results of executing a saved search on the server.
TaskListSyncOutput A TaskListSyncOutput contains the lists of changes the client needs to synchronize their task list for a saved search with the current state on the server.
TaskStatus  
TaskSyncAction  
TaskSyncItem A TaskSyncItem indicates to the client what should be done to synchronize their a task in a task list with the result of the saved search.
UpdateDocument  
UpdateDocumentResponse  
User A User is an individual who can participate in process instances and tasks
UserConfiguration UserConfiguration is used to retrieve multiple pieces of information about the current user from the server in a single operation.
Variable Variables store named values and are used throughout the API.
 


IBM BPM API for Web Service Clients v8.0.0

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