ITaskMetadataService (Oracle BPEL Process Manager Workflow Services API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

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

oracle.bpel.services.workflow.metadata
Interface ITaskMetadataService

public interface ITaskMetadataService

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

getTaskDefinitionById

public TaskDefinition getTaskDefinitionById(IWorkflowContext context,
                                            java.lang.String taskDefinitionId)
                                     throws TaskMetadataServiceException

Get the task definition object given the task definition id

Parameters:: context - The workflow context; taskDefinitionId - a String value
Returns:: TaskDefinition The task definition object
Throws:: TaskMetadataServiceException - if an error occurs

getTaskDefinition

public TaskDefinition getTaskDefinition(IWorkflowContext context,
                                        Task task)
                                 throws TaskMetadataServiceException

Get the task definition object given the task object

Parameters:: context - The workflow context; task - The task object
Returns:: TaskDefinition The task definition object
Throws:: TaskMetadataServiceException - if an error occurs

listTaskMetadata

public java.util.List listTaskMetadata(IWorkflowContext context,
                                       java.lang.String keyword,
                                       java.lang.String sortAttribute,
                                       java.lang.String sortOrder)
                                throws TaskMetadataServiceException

List the task metadata objects given the key word to search task metadata with

Parameters:: context - The workflow context; keyword - The keyword to search for task metadata. This keyword could be from id, name, title, domainId, processId, processName; sortAttribute - 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'
Returns:: List List of TaskMetadata objects
Throws:: TaskMetadataServiceException - if an error occurs

getOutcomes

public java.util.Map getOutcomes(IWorkflowContext context,
                                 Task task,
                                 java.util.Locale locale)
                          throws TaskMetadataServiceException

Get the outcomes for the given task object. The return value also contains the display values according to the locale specified.

Parameters:: context - The workflow context; task - The task object; locale - The locale of the users
Returns:: Map Map with key as outcome value and the value is the display value
Throws:: TaskMetadataServiceException - if an error occurs

getTaskDefinitionOutcomes

public java.util.Map getTaskDefinitionOutcomes(IWorkflowContext context,
                                               java.lang.String taskDefinitionId,
                                               java.util.Locale locale)
                                        throws TaskMetadataServiceException

Get the outcomes for the given task definition. The return value also contains the display values according to the locale specified.

Parameters:: context - The workflow context; taskDefinitionId - a String value; locale - The locale of the users
Returns:: Map Map with key as outcome value and the value is the display value
Throws:: TaskMetadataServiceException - if an error occurs

getVersionTrackedAttrs

public java.util.List getVersionTrackedAttrs(IWorkflowContext context,
                                             Task task)
                                      throws TaskMetadataServiceException

Get the version tracked attributes

Parameters:: context - The workflow context; task - The task object
Returns:: List A list of version tracked attributes
Throws:: TaskMetadataServiceException - if an error occurs

getRestrictedActions

public java.util.List getRestrictedActions(IWorkflowContext context,
                                           Task task)
                                    throws TaskMetadataServiceException

Get the restricted actions

Parameters:: context - The workflow context; task - The task object
Returns:: List A list of restricted actions
Throws:: TaskMetadataServiceException - if an error occurs

getTaskDisplay

public TaskDisplay getTaskDisplay(IWorkflowContext context,
                                  Task task,
                                  java.lang.String applicationName)
                           throws TaskMetadataServiceException

Get the workflow task display

Parameters:: context - The workflow context; task - The task object; applicationName - The application in whose context is the TaskDisplay URI required
Returns:: TaskDisplay The workflow taskDisplay
Throws:: TaskMetadataServiceException - For any exception

getTaskDisplayRegion

public TaskDisplayRegion getTaskDisplayRegion(IWorkflowContext context,
                                              Task task,
                                              java.lang.String applicationName,
                                              java.lang.String regionName)
                                       throws TaskMetadataServiceException

Get a region definition for the given region

Parameters:: context - The workflow context; task - The task object; applicationName - The application in whose context is the TaskDisplay URI required; regionName - The region name
Returns:: TaskDisplayRegion The TaskDisplayRegion will identify the region type, URL for the region jsp and the parameter map. The parameter map is a map with key as parameter name and the value is the resolved value. The values are specified as XPath expression, those expressions are evaluated to populate this map
Throws:: TaskMetadataServiceException - if an error occurs

getResourceBundleInfo

public ResourceBundleInfo getResourceBundleInfo(IWorkflowContext context,
                                                Task task,
                                                java.util.Locale locale)
                                         throws TaskMetadataServiceException

Get the resource bundle information

Parameters:: context - The workflow context; task - The task object; locale - The locale for which to get the resource bundle. This is needed because of some validation done in getting the resource bundle information
Returns:: ResourceBundleInfo The ResourceBundleInfo object
Throws:: TaskMetadataServiceException - if an error occurs

getTaskAttributes

public java.util.List getTaskAttributes(IWorkflowContext context)
                                 throws TaskMetadataServiceException

Get a list of 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:

attributeName String name of the attribute, using dot-seperated format to specify path to attribute. For example, "title", "systemAttributes.createdDate", "systemMessageAttributes.textAttribute1".
attributeColumn String the name of the column on the WFTASK table corresponding to this attribute.
attributeLabel String human-readable label for the attribute, appropriate for the Locale in the supplied IWorkflowContext.
attributeType String the type of this attribute. Will be one of the following values:

Parameters:: context - The workflow context
Returns:: List of TaskAttribute objects
Throws:: TaskMetadataServiceException - if an error occurs

getTaskAttributesForTaskDefinition

public java.util.List getTaskAttributesForTaskDefinition(IWorkflowContext context,
                                                         java.lang.String taskDefinitionId)
                                                  throws TaskMetadataServiceException

Get a list of 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:

attributeName String name of the attribute, using dot-seperated format to specify path to attribute. For example, "title", "systemAttributes.createdDate", "systemMessageAttributes.textAttribute1".
attributeColumn String the name of the column on the WFTASK table corresponding to this attribute.
attributeLabel String human-readable label for the attribute, appropriate for the Locale in the supplied IWorkflowContext.
attributeType String the type of this attribute. Will be one of the following values:

Parameters:: context - The workflow context; taskDefinitionId - Id of the task definition to get attributes for
Returns:: List of TaskAttribute objects
Throws:: TaskMetadataServiceException