|
Oracle BPEL Process Manager Workflow Services API Reference 10g Release 3 (10.1.3) B28985-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
java.util.Map |
getOutcomes(IWorkflowContext context, Task task, java.util.Locale locale) Get the outcomes for the given task object. |
ResourceBundleInfo |
getResourceBundleInfo(IWorkflowContext context, Task task, java.util.Locale locale) Get the resource bundle information |
java.util.List |
getRestrictedActions(IWorkflowContext context, Task task) Get the restricted actions |
java.util.List |
getTaskAttributes(IWorkflowContext context) Get a list of TaskAttribute objects for standard task attributes. |
java.util.List |
getTaskAttributesForTaskDefinition(IWorkflowContext context, java.lang.String taskDefinitionId) Get a list of TaskAttribute objects that describe standard task attributes and mapped flex-field columns for the specified task definition. |
TaskDefinition |
getTaskDefinition(IWorkflowContext context, Task task) Get the task definition object given the task object |
TaskDefinition |
getTaskDefinitionById(IWorkflowContext context, java.lang.String taskDefinitionId) Get the task definition object given the task definition id |
java.util.Map |
getTaskDefinitionOutcomes(IWorkflowContext context, java.lang.String taskDefinitionId, java.util.Locale locale) Get the outcomes for the given task definition. |
TaskDisplay |
getTaskDisplay(IWorkflowContext context, Task task, java.lang.String applicationName) Get the workflow task display |
TaskDisplayRegion |
getTaskDisplayRegion(IWorkflowContext context, Task task, java.lang.String applicationName, java.lang.String regionName) Get a region definition for the given region |
java.util.List |
getVersionTrackedAttrs(IWorkflowContext context, Task task) Get the version tracked attributes |
java.util.List |
listTaskMetadata(IWorkflowContext context, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder) List the task metadata objects given the key word to search task metadata with |
Method Detail |
public TaskDefinition getTaskDefinitionById(IWorkflowContext context, java.lang.String taskDefinitionId) throws TaskMetadataServiceException
context
- The workflow contexttaskDefinitionId
- a String
valueTaskMetadataServiceException
- if an error occurspublic TaskDefinition getTaskDefinition(IWorkflowContext context, Task task) throws TaskMetadataServiceException
context
- The workflow contexttask
- The task objectTaskMetadataServiceException
- if an error occurspublic java.util.List listTaskMetadata(IWorkflowContext context, java.lang.String keyword, java.lang.String sortAttribute, java.lang.String sortOrder) throws TaskMetadataServiceException
context
- The workflow contextkeyword
- The keyword to search for task metadata. This keyword could be from id, name, title, domainId, processId, processNamesortAttribute
- The attribute to sort the results by. The possible values are 'id', 'name', 'title', 'description', 'domainId', 'processId', 'processVersion' If not one of the values above, it would be defaulted to 'name'sortOrder
- The sort order - either 'ACS' or 'DESC'TaskMetadataServiceException
- if an error occurspublic java.util.Map getOutcomes(IWorkflowContext context, Task task, java.util.Locale locale) throws TaskMetadataServiceException
context
- The workflow contexttask
- The task objectlocale
- The locale of the usersTaskMetadataServiceException
- if an error occurspublic java.util.Map getTaskDefinitionOutcomes(IWorkflowContext context, java.lang.String taskDefinitionId, java.util.Locale locale) throws TaskMetadataServiceException
context
- The workflow contexttaskDefinitionId
- a String
valuelocale
- The locale of the usersTaskMetadataServiceException
- if an error occurspublic java.util.List getVersionTrackedAttrs(IWorkflowContext context, Task task) throws TaskMetadataServiceException
context
- The workflow contexttask
- The task objectTaskMetadataServiceException
- if an error occurspublic java.util.List getRestrictedActions(IWorkflowContext context, Task task) throws TaskMetadataServiceException
context
- The workflow contexttask
- The task objectTaskMetadataServiceException
- if an error occurspublic TaskDisplay getTaskDisplay(IWorkflowContext context, Task task, java.lang.String applicationName) throws TaskMetadataServiceException
context
- The workflow contexttask
- The task objectapplicationName
- The application in whose context is the TaskDisplay URI requiredTaskMetadataServiceException
- For any exceptionpublic TaskDisplayRegion getTaskDisplayRegion(IWorkflowContext context, Task task, java.lang.String applicationName, java.lang.String regionName) throws TaskMetadataServiceException
context
- The workflow contexttask
- The task objectapplicationName
- The application in whose context is the TaskDisplay URI requiredregionName
- The region nameTaskMetadataServiceException
- if an error occurspublic ResourceBundleInfo getResourceBundleInfo(IWorkflowContext context, Task task, java.util.Locale locale) throws TaskMetadataServiceException
context
- The workflow contexttask
- The task objectlocale
- The locale for which to get the resource bundle. This is needed because of some validation done in getting the resource bundle informationTaskMetadataServiceException
- if an error occurspublic java.util.List getTaskAttributes(IWorkflowContext context) throws TaskMetadataServiceException
TaskAttribute
objects for standard task attributes. TaskAttribute objects provide information on attribute type, column name, and user-disaplayable labels, localized to the Locale of the context user, and have the following properties:
String
name of the attribute, using dot-seperated format to specify path to attribute. For example, "title", "systemAttributes.createdDate", "systemMessageAttributes.textAttribute1".String
the name of the column on the WFTASK table corresponding to this attribute.String
human-readable label for the attribute, appropriate for the Locale in the supplied IWorkflowContext.String
the type of this attribute. Will be one of the following values:
context
- The workflow contextTaskMetadataServiceException
- if an error occurspublic java.util.List getTaskAttributesForTaskDefinition(IWorkflowContext context, java.lang.String taskDefinitionId) throws TaskMetadataServiceException
TaskAttribute
objects that describe standard task attributes and mapped flex-field columns for the specified task definition. TaskAttribute objects provide information on attribute type, column name, and user-disaplayable labels, localized to the Locale of the context user. TaskAttribute has the following properties:
String
name of the attribute, using dot-seperated format to specify path to attribute. For example, "title", "systemAttributes.createdDate", "systemMessageAttributes.textAttribute1".String
the name of the column on the WFTASK table corresponding to this attribute.String
human-readable label for the attribute, appropriate for the Locale in the supplied IWorkflowContext.String
the type of this attribute. Will be one of the following values:
context
- The workflow contexttaskDefinitionId
- Id of the task definition to get attributes forTaskMetadataServiceException
|
Oracle BPEL Process Manager Workflow Services API Reference 10g Release 3 (10.1.3) B28985-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |