oracle.bpel.services.workflow.metadata
Interface ITaskMetadataService

public interface ITaskMetadataService

Field Summary

static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_ACQUIRED_BY
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_ALL_UPDATED_DATE
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_ASSIGNED_DATE
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_ASSIGNEE_GROUPS
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_ASSIGNEE_USERS
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_ASSIGNEES
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_ATTACHMENTS
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_COMMENTS
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_CREATED_DATE
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_DATES
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_END_DATE
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_EXPIRATION_DATE
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_FLEXFIELDS
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_HISTORY
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_PAYLOAD
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_PAYLOAD_MESSAGE_ATTR_PREFIX
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_REVIEWERS
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_START_DATE
static java.lang.String	TASK_VISIBILITY_ATTRIBUTE_SYSTEM_END_DATE

Method Summary

boolean	containsComponentTopicDocumentations(IWorkflowContext context, java.lang.String compositeDN, java.lang.String componentName, java.lang.String topicName, oracle.bpel.services.workflow.metadata.processDocumentation.model.DocumentationAudienceEnum documentationAudience, java.util.Locale locale) Returns if the given Component in the composite contains TopicDocumentation objects in the specified topicName, documentationAudience and locale
boolean	containsTaskTopicDocumentations(IWorkflowContext context, java.lang.String taskId, java.lang.String topicName, oracle.bpel.services.workflow.metadata.processDocumentation.model.DocumentationAudienceEnum documentationAudience, java.util.Locale locale) Returns if the given Human task contains TopicDocumentation objects in the specified topicName, documentationAudience and locale
java.util.List<oracle.bpel.services.workflow.metadata.processDocumentation.model.TopicDocumentationType>	getComponentTopicDocumentations(IWorkflowContext context, java.lang.String compositeDN, java.lang.String componentName, java.lang.String topicName, oracle.bpel.services.workflow.metadata.processDocumentation.model.DocumentationAudienceEnum documentationAudience, java.util.Locale locale) Get the list of TopicDocumentation objects for the specified Component of the composite, topicName, documentationAudience and locale
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.
java.util.List<TaskAttributeType>	getTaskAttributesForTaskDefinitions(IWorkflowContext context, java.util.List<java.lang.String> taskDefinitionIds) Get a list of TaskAttribute objects that describe standard task attributes and mapped flex-field columns that are common for the specified task definitions.
java.util.List<TaskAttributeType>	getTaskAttributesForTaskNamespaces(IWorkflowContext context, java.util.List<java.lang.String> taskNamespaces) Get a list of TaskAttribute objects that describe standard task attributes and mapped flex-field columns that are common for task definitions identified by the specified namespaces.
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
TaskDefinition	getTaskDefinitionById(IWorkflowContext context, java.lang.String taskDefinitionId, java.lang.String mdsLabel) 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.
java.util.Map	getTaskDefinitionOutcomes(IWorkflowContext context, java.lang.String taskDefinitionId, java.lang.String mdsLabel, java.util.Locale locale) Get the outcomes for the given task definition.
TaskDisplay	getTaskDisplay(IWorkflowContext context, Task task, java.lang.String applicationName) Deprecated. Since 11.1.1.1.0.
TaskDisplayRegion	getTaskDisplayRegion(IWorkflowContext context, Task task, java.lang.String applicationName, java.lang.String regionName) Get a region definition for the given region
TaskMetadata	getTaskMetadataByNamespace(IWorkflowContext context, java.lang.String taskDefinitionNamespace, java.lang.String compositeVersion) Gets the TaskMetadata object that describes the Human Task component with the specified task definition namespace and composite version.
java.util.List<oracle.bpel.services.workflow.metadata.processDocumentation.model.TopicDocumentationType>	getTaskTopicDocumentations(IWorkflowContext context, java.lang.String taskId, java.lang.String topicName, oracle.bpel.services.workflow.metadata.processDocumentation.model.DocumentationAudienceEnum documentationAudience, java.util.Locale locale) Get the list of TopicDocumentation objects for the specified Human task, topicName, documentationAudience and locale
java.util.Map<java.lang.String,IPrivilege>	getTaskVisibilityRules(IWorkflowContext context, java.lang.String taskId) Get the task visibility rules.
java.util.Map<java.lang.String,IPrivilege>	getTaskVisibilityRules(IWorkflowContext context, Task task) Get the task visibility rules.
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) Gets a List of the TaskMetadata objects that match the specified keyword(s).

Field Detail

TASK_VISIBILITY_ATTRIBUTE_PAYLOAD

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_PAYLOAD

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_COMMENTS

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_COMMENTS

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_ATTACHMENTS

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_ATTACHMENTS

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_HISTORY

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_HISTORY

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_FLEXFIELDS

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_FLEXFIELDS

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_REVIEWERS

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_REVIEWERS

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_ASSIGNEES

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_ASSIGNEES

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_ASSIGNEE_USERS

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_ASSIGNEE_USERS

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_ASSIGNEE_GROUPS

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_ASSIGNEE_GROUPS

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_ACQUIRED_BY

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_ACQUIRED_BY

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_DATES

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_DATES

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_START_DATE

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_START_DATE

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_END_DATE

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_END_DATE

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_ASSIGNED_DATE

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_ASSIGNED_DATE

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_SYSTEM_END_DATE

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_SYSTEM_END_DATE

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_CREATED_DATE

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_CREATED_DATE

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_EXPIRATION_DATE

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_EXPIRATION_DATE

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_ALL_UPDATED_DATE

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_ALL_UPDATED_DATE

See Also:

Constant Field Values

TASK_VISIBILITY_ATTRIBUTE_PAYLOAD_MESSAGE_ATTR_PREFIX

static final java.lang.String TASK_VISIBILITY_ATTRIBUTE_PAYLOAD_MESSAGE_ATTR_PREFIX

See Also:

Constant Field Values

Method Detail

getTaskDefinitionById

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

Get the task definition object given the task definition id

Parameters:

context - The workflow context

taskDefinitionId - a String value

mdsLabel - Label associated to this task definition when persisted to mds. Can be null if not available.

Returns:

TaskDefinition The task definition object

Throws:

TaskMetadataServiceException - if an error occurs

getTaskDefinitionById

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

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

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

Gets a List of the TaskMetadata objects that match the specified keyword(s). The TaskMetadata objects describe version and composite information for Human Task components.

Parameters:

context - The workflow context

keyword - The keyword to search for task metadata. This keyword could be from id, name, title, applicationName, compositeName, componentName

sortAttribute - The attribute to sort the results by. The possible values are 'id', 'name', 'title', 'description','applicationName','compositeName', 'componentName', 'compositeVersion', 'compositeDN' If not one of the values above, it would be defaulted to 'name'

sortOrder - The sort order - either 'ASC' or 'DESC'

Returns:

List List of TaskMetadata objects

Throws:

TaskMetadataServiceException - if an error occurs

getTaskMetadataByNamespace

TaskMetadata getTaskMetadataByNamespace(IWorkflowContext context,
                                        java.lang.String taskDefinitionNamespace,
                                        java.lang.String compositeVersion)
                                        throws TaskMetadataServiceException

Gets the TaskMetadata object that describes the Human Task component with the specified task definition namespace and composite version. If no composite version is specified, the task metadata returned corresponds to the Humant Task component in the active version of the composite.

Parameters:

context - The worklfow context

taskDefinitionNamespace - String the target namespace defined for the Human Task component to search for. This is the target namespace for the task definition, and is defined at design time. It defaults to "http://xmlns.oracle.com/<Application Name>/<Composite Name>/<Component Name>"

compositeVersion - The version of the composite the workflow component is located in. If null, the currently active composite version will be used.

Returns:

TaskMetadata object that provides information on the specified Human Task component.

Throws:

TaskMetadataServiceException

getOutcomes

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 is a Map containing the outcome display values for the specified Locale, keyed by the outcome value. The outcome display values are determined as follows:

• If the task definition for the Task object specifies a resource bundle, then the display value will be looked up in Task resource bundle, using the outcome value as a key.
• If no Task resource bundle is specified, the display value will be looked up in the WorkflowLabels.properties resource bundle using a key of the form TASK_OUTCOME.<OUTCOME VALUE>. This resource bundle will be loaded from the classpath specified in the worklfow configuration parameter workflowCustomClasspathURL, if available. If not available on the custom classpath, resource bundle will be loaded from the HWF services classpath.
• If a resource string could not be located in a resource bundle, then the display value will be the same as the outcome value.

Parameters:

context - The workflow context

task - The task object

locale - Locale to use when looking up display strings.

Returns:

Map Map with key as outcome value and the value is the display value

Throws:

TaskMetadataServiceException - if an error occurs

getTaskDefinitionOutcomes

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

Get the outcomes for the given task definition. The return value is a Map containing the outcome display values for the specified Locale, keyed by the outcome value. The outcome display values are determined as follows:

• If the task definition specifies a resource bundle, then the display value will be looked up in Task resource bundle, using the outcome value as a key.
• If no Task resource bundle is specified, the display value will be looked up in the WorkflowLabels.properties resource bundle using a key of the form TASK_OUTCOME.<OUTCOME VALUE>. This resource bundle will be loaded from the classpath specified in the worklfow configuration parameter workflowCustomClasspathURL, if available. If not available on the custom classpath, resource bundle will be loaded from the HWF services classpath.
• If a resource string could not be located in a resource bundle, then the display value will be the same as the outcome value.

Parameters:

context - The workflow context

taskDefinitionId - a String value

mdsLabel - Label associated to this task definition when persisted to mds. Can be null if not available.

locale - The Locale to use when looking up display strings.

Returns:

Map Map with key as outcome value and the value is the display value

Throws:

TaskMetadataServiceException - if an error occurs

getTaskDefinitionOutcomes

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 is a Map containing the outcome display values for the specified Locale, keyed by the outcome value. The outcome display values are determined as follows:

• If the task definition specifies a resource bundle, then the display value will be looked up in Task resource bundle, using the outcome value as a key.
• If no Task resource bundle is specified, the display value will be looked up in the WorkflowLabels.properties resource bundle using a key of the form TASK_OUTCOME.<OUTCOME VALUE>. This resource bundle will be loaded from the classpath specified in the worklfow configuration parameter workflowCustomClasspathURL, if available. If not available on the custom classpath, resource bundle will be loaded from the HWF services classpath.
• If a resource string could not be located in a resource bundle, then the display value will be the same as the outcome value.

Parameters:

context - The workflow context

taskDefinitionId - a String value

locale - The Locale to use when looking up display strings.

Returns:

Map Map with key as outcome value and the value is the display value

Throws:

TaskMetadataServiceException - if an error occurs

getVersionTrackedAttrs

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

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

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

Deprecated. Since 11.1.1.1.0.

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

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

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

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. This label is looked up from the WorkflowLabels.properties resource bundle. The resource bundle is loaded from the classpath specified in the configuration parameter worklfowCustomClasspathURL. If not available from that classpath, the bunde is loaded from the classpath used by workflow services. Labels are looked up using a key of the form TASK_ATTR.<attributeName>. If no resource string is found, then the attributeName or flexfield attribute label name is used as the label.
• attributeType String the type of this attribute. Will be one of the following values:
  • IWorkflowConstants.TASK_ATTR_STRING
  • IWorkflowConstants.TASK_ATTR_DATE
  • IWorkflowConstants.TASK_ATTR_INTEGER
  • IWorkflowConstants.TASK_ATTR_DOUBLE
  • IWorkflowConstants.TASK_ATTR_FLOAT
  • IWorkflowConstants.TASK_ATTR_USER
  • IWorkflowConstants.TASK_ATTR_GROUP
  • IWorkflowConstants.TASK_ATTR_ROLE
  • IWorkflowConstants.TASK_ATTR_USERGROUP
  • IWorkflowConstants.TASK_ATTR_USER_LIST
  • IWorkflowConstants.TASK_ATTR_GROUP_LIST
  • IWorkflowConstants.TASK_ATTR_ROLE_LIST
  • IWorkflowConstants.TASK_ATTR_IDENTITY_LIST
• category String the category of this attribute. Will be one of the following values:
  • Basic - Attributes like title, task name, category, etc.
  • User - Attributes like assignees, creator, updatedBy, etc.
  • Time - Attributes like createdDate, updatedDate, etc.
  • Custom - All flex fields and custom attributes
  • Advanced - Anything that is not covered above

The returned list of TaskAttributeType can be converted to map indexed by category using See oracle.bpel.services.workflow.metadata.taskattributes.TaskAttributesUtil#getTaskAttrCategoryMap(List)

Parameters:

context - The workflow context

Returns:

List of TaskAttribute objects

Throws:

TaskMetadataServiceException - if an error occurs

getTaskAttributesForTaskDefinition

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. This label is looked up from the WorkflowLabels.properties resource bundle. The resource bundle is loaded from the classpath specified in the configuration parameter worklfowCustomClasspathURL. If not available from that classpath, the bunde is loaded from the classpath used by workflow services. Labels are looked up using a key of the form TASK_ATTR.<attributeName> for task attributes. For mapped flex-fields, labels are looked up with a key of the form FLEX_LABEL.<attributeLabelName>. If no resource string is found, then the attributeName or flexfield attribute label name is used as the label.
• attributeType String the type of this attribute. Will be one of the following values:
  • IWorkflowConstants.TASK_ATTR_STRING
  • IWorkflowConstants.TASK_ATTR_DATE
  • IWorkflowConstants.TASK_ATTR_INTEGER
  • IWorkflowConstants.TASK_ATTR_DOUBLE
  • IWorkflowConstants.TASK_ATTR_FLOAT
  • IWorkflowConstants.TASK_ATTR_USER
  • IWorkflowConstants.TASK_ATTR_GROUP
  • IWorkflowConstants.TASK_ATTR_ROLE
  • IWorkflowConstants.TASK_ATTR_USERGROUP
  • IWorkflowConstants.TASK_ATTR_USER_LIST
  • IWorkflowConstants.TASK_ATTR_GROUP_LIST
  • IWorkflowConstants.TASK_ATTR_ROLE_LIST
  • IWorkflowConstants.TASK_ATTR_IDENTITY_LIST
• category String the category of this attribute. Will be one of the following values:
  • Basic - Attributes like title, task name, category, etc.
  • User - Attributes like assignees, creator, updatedBy, etc.
  • Time - Attributes like createdDate, updatedDate, etc.
  • Custom - All flex fields and custom attributes
  • Advanced - Anything that is not covered above

The returned list of TaskAttributeType can be converted to map indexed by category using See oracle.bpel.services.workflow.metadata.taskattributes.TaskAttributesUtil#getTaskAttrCategoryMap(List)

Parameters:

context - The workflow context

taskDefinitionId - Id of the task definition to get attributes for

Returns:

List of TaskAttribute objects

Throws:

TaskMetadataServiceException

getTaskAttributesForTaskDefinitions

java.util.List<TaskAttributeType> getTaskAttributesForTaskDefinitions(IWorkflowContext context,
                                                                      java.util.List<java.lang.String> taskDefinitionIds)
                                                                      throws TaskMetadataServiceException

Get a list of TaskAttribute objects that describe standard task attributes and mapped flex-field columns that are common for the specified task definitions.

For mapped flex-field columns, only attribute labels that are used by all task definitions specified are returned. For example, if taskDefinitionA uses the flex-field attribute labels "CustomerName" and "POCode", and taskDefinitionB uses the flex-field attribute labels "CustomerName" and "InvoiceID", a request for task attributes for taskDefinitionA and taskDefinitionB will return all the standard attributes, but only the flex-field attribute corresponding to "CustomerName".

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. This label is looked up from the WorkflowLabels.properties resource bundle. The resource bundle is loaded from the classpath specified in the configuration parameter worklfowCustomClasspathURL. If not available from that classpath, the bunde is loaded from the classpath used by workflow services. Labels are looked up using a key of the form TASK_ATTR.<attributeName> for task attributes. For mapped flex-fields, labels are looked up with a key of the form FLEX_LABEL.<attributeLabelName>. If no resource string is found, then the attributeName or flexfield attribute label name is used as the label.
• attributeType String the type of this attribute. Will be one of the following values:
  • IWorkflowConstants.TASK_ATTR_STRING
  • IWorkflowConstants.TASK_ATTR_DATE
  • IWorkflowConstants.TASK_ATTR_INTEGER
  • IWorkflowConstants.TASK_ATTR_DOUBLE
  • IWorkflowConstants.TASK_ATTR_FLOAT
  • IWorkflowConstants.TASK_ATTR_USER
  • IWorkflowConstants.TASK_ATTR_GROUP
  • IWorkflowConstants.TASK_ATTR_ROLE
  • IWorkflowConstants.TASK_ATTR_USERGROUP
  • IWorkflowConstants.TASK_ATTR_USER_LIST
  • IWorkflowConstants.TASK_ATTR_GROUP_LIST
  • IWorkflowConstants.TASK_ATTR_ROLE_LIST
  • IWorkflowConstants.TASK_ATTR_IDENTITY_LIST
• category String the category of this attribute. Will be one of the following values:
  • Basic - Attributes like title, task name, category, etc.
  • User - Attributes like assignees, creator, updatedBy, etc.
  • Time - Attributes like createdDate, updatedDate, etc.
  • Custom - All flex fields and custom attributes
  • Advanced - Anything that is not covered above

The returned list of TaskAttributeType can be converted to map indexed by category using See oracle.bpel.services.workflow.metadata.taskattributes.TaskAttributesUtil#getTaskAttrCategoryMap(List)

Parameters:

context - The workflow context

taskDefinitionIds - List of taskDefinitionIds to get attributes for

Returns:

List of TaskAttribute objects

Throws:

TaskMetadataServiceException

getTaskAttributesForTaskNamespaces

java.util.List<TaskAttributeType> getTaskAttributesForTaskNamespaces(IWorkflowContext context,
                                                                     java.util.List<java.lang.String> taskNamespaces)
                                                                     throws TaskMetadataServiceException

Get a list of TaskAttribute objects that describe standard task attributes and mapped flex-field columns that are common for task definitions identified by the specified namespaces.

The method will attempt to determine the task definitions by looking up the currently active versions of task components that have the specified task namespace. If no active version can be found for a particular namespace, the namespace will be skipped.

For mapped flex-field columns, only attribute labels that are used by all task definitions specified are returned. For example, if taskDefinitionA uses the flex-field attribute labels "CustomerName" and "POCode", and taskDefinitionB uses the flex-field attribute labels "CustomerName" and "InvoiceID", a request for task attributes for taskDefinitionA and taskDefinitionB will return all the standard attributes, but only the flex-field attribute corresponding to "CustomerName".

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. This label is looked up from the WorkflowLabels.properties resource bundle. The resource bundle is loaded from the classpath specified in the configuration parameter worklfowCustomClasspathURL. If not available from that classpath, the bunde is loaded from the classpath used by workflow services. Labels are looked up using a key of the form TASK_ATTR.<attributeName> for task attributes. For mapped flex-fields, labels are looked up with a key of the form FLEX_LABEL.<attributeLabelName>. If no resource string is found, then the attributeName or flexfield attribute label name is used as the label.
• attributeType String the type of this attribute. Will be one of the following values:
  • IWorkflowConstants.TASK_ATTR_STRING
  • IWorkflowConstants.TASK_ATTR_DATE
  • IWorkflowConstants.TASK_ATTR_INTEGER
  • IWorkflowConstants.TASK_ATTR_DOUBLE
  • IWorkflowConstants.TASK_ATTR_FLOAT
  • IWorkflowConstants.TASK_ATTR_USER
  • IWorkflowConstants.TASK_ATTR_GROUP
  • IWorkflowConstants.TASK_ATTR_ROLE
  • IWorkflowConstants.TASK_ATTR_USERGROUP
  • IWorkflowConstants.TASK_ATTR_USER_LIST
  • IWorkflowConstants.TASK_ATTR_GROUP_LIST
  • IWorkflowConstants.TASK_ATTR_ROLE_LIST
  • IWorkflowConstants.TASK_ATTR_IDENTITY_LIST
• category String the category of this attribute. Will be one of the following values:
  • Basic - Attributes like title, task name, category, etc.
  • User - Attributes like assignees, creator, updatedBy, etc.
  • Time - Attributes like createdDate, updatedDate, etc.
  • Custom - All flex fields and custom attributes
  • Advanced - Anything that is not covered above

The returned list of TaskAttributeType can be converted to map indexed by category using See oracle.bpel.services.workflow.metadata.taskattributes.TaskAttributesUtil#getTaskAttrCategoryMap(List)

Parameters:

context - The workflow context

taskNamespaces - List of task namespaces to get attributes for

Returns:

List of TaskAttribute objects

Throws:

TaskMetadataServiceException

getTaskVisibilityRules

java.util.Map<java.lang.String,IPrivilege> getTaskVisibilityRules(IWorkflowContext context,
                                                                  Task task)
                                                                  throws TaskMetadataServiceException

Get the task visibility rules. This method returns a map with the key being name of the task attribute and value being a IPrivilege object
The keys in map returned will be one of the following (the value in the brackets are the actual value of the constants)

1. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_PAYLOAD (PAYLOAD)
2. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_COMMENTS (COMMENTS)
3. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_ATTACHMENTS (ATTACHMENTS)
4. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_HISTORY (HISTORY)
5. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_FLEXFIELDS (FLEXFIELDS)
6. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_REVIEWERS (REVIEWERS)
7. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_ASSIGNEES (ASSIGNEES) - During configuration of the visibility rules, this is configured as ASSIGNEES
8. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_ASSIGNEE_USERS (ASSIGNEE_USERS) - During configuration of the visibility rules, this is configured as ASSIGNEES
9. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_ASSIGNEE_GROUPS (ASSIGNEE_GROUPS) - During configuration of the visibility rules, this is configured as ASSIGNEES
10. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_ACQUIRED_BY (ACQUIRED_BY) - During configuration of the visibility rules, this is configured as ASSIGNEES
11. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_DATES (All Dates) - During configuration of the visibility rules, this is configured as DATES
12. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_START_DATE (START_DATE) - During configuration of the visibility rules, this is configured as DATES
13. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_END_DATE (END_DATE) - During configuration of the visibility rules, this is configured as DATES
14. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_ASSIGNED_DATE (ASSIGNED_DATE) - During configuration of the visibility rules, this is configured as DATES
15. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_SYSTEM_END_DATE (SYSTEM_END_DATE) - During configuration of the visibility rules, this is configured as DATES
16. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_CREATED_DATE (CREATED_DATE) - During configuration of the visibility rules, this is configured as DATES
17. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_EXPIRATION_DATE (EXPIRATION_DATE) - During configuration of the visibility rules, this is configured as DATES
18. ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_ALL_UPDATED_DATE (ALL_UPDATED_DATE) - During configuration of the visibility rules, this is configured as DATES
19. Message attribute names prefixed with ITaskMetadataService.TASK_VISIBILITY_ATTRIBUTE_PAYLOAD_MESSAGE_ATTR_PREFIX (PAYLOAD.)

This method will return an empty map if there are no task visibility attribute rules defined

Parameters:

context - The workflow context containing the user whose privileges is begin queried for

task - The task for which the visibility rules is begin queried for

Returns:

a Map value. This method will return an empty map if there are no task visibility attribute rules defined

Throws:

TaskMetadataServiceException - if an error occurs

getTaskVisibilityRules

java.util.Map<java.lang.String,IPrivilege> getTaskVisibilityRules(IWorkflowContext context,
                                                                  java.lang.String taskId)
                                                                  throws TaskMetadataServiceException

Get the task visibility rules. The behavior is the same as the overloaded method that takes the task object.

Parameters:

context - The workflow context containing the user whose privileges is begin queried for

taskId - The task for which the visibility rules is begin queried for

Returns:

a Map value. This method will return an empty map if there are no task visibility attribute rules defined

Throws:

TaskMetadataServiceException - if an error occurs

See Also:

getTaskVisibilityRules(IWorkflowContext , Task)

getComponentTopicDocumentations

java.util.List<oracle.bpel.services.workflow.metadata.processDocumentation.model.TopicDocumentationType> getComponentTopicDocumentations(IWorkflowContext context,
                                                                                                                                         java.lang.String compositeDN,
                                                                                                                                         java.lang.String componentName,
                                                                                                                                         java.lang.String topicName,
                                                                                                                                         oracle.bpel.services.workflow.metadata.processDocumentation.model.DocumentationAudienceEnum documentationAudience,
                                                                                                                                         java.util.Locale locale)
                                                                                                                                         throws TaskMetadataServiceException

Get the list of TopicDocumentation objects for the specified Component of the composite, topicName, documentationAudience and locale

Parameters:

context - The workflow context

compositeDN - The compositeDN of the process

componentName - The component name

topicName - The topic name

documentationAudience - The enum for documentation audience type

locale - The locale of the audience user

Returns:

The list of TopicDocumentation objects for the specified Component of the composite, topicName, documentationAudience and locale

Throws:

TaskMetadataServiceException

containsComponentTopicDocumentations

boolean containsComponentTopicDocumentations(IWorkflowContext context,
                                             java.lang.String compositeDN,
                                             java.lang.String componentName,
                                             java.lang.String topicName,
                                             oracle.bpel.services.workflow.metadata.processDocumentation.model.DocumentationAudienceEnum documentationAudience,
                                             java.util.Locale locale)
                                             throws TaskMetadataServiceException

Returns if the given Component in the composite contains TopicDocumentation objects in the specified topicName, documentationAudience and locale

Parameters:

context - The workflow context

compositeDN - The compositeDN of the process

componentName - The component name

topicName - The topic name

documentationAudience - The enum for documentation audience type

locale - The locale of the audience user

Returns:

true if the given Component in the composite contains TopicDocumentation objects in the specified topicName, documentationAudience and locale

Throws:

TaskMetadataServiceException

getTaskTopicDocumentations

java.util.List<oracle.bpel.services.workflow.metadata.processDocumentation.model.TopicDocumentationType> getTaskTopicDocumentations(IWorkflowContext context,
                                                                                                                                    java.lang.String taskId,
                                                                                                                                    java.lang.String topicName,
                                                                                                                                    oracle.bpel.services.workflow.metadata.processDocumentation.model.DocumentationAudienceEnum documentationAudience,
                                                                                                                                    java.util.Locale locale)
                                                                                                                                    throws TaskMetadataServiceException

Get the list of TopicDocumentation objects for the specified Human task, topicName, documentationAudience and locale

Parameters:

context - The workflow context

taskId - The task id

topicName - The topic name

documentationAudience - The enum for documentation audience type

locale - The locale of the audience user

Returns:

The list of TopicDocumentation objects for the specified Human task, topicName, documentationAudience and locale

Throws:

TaskMetadataServiceException

containsTaskTopicDocumentations

boolean containsTaskTopicDocumentations(IWorkflowContext context,
                                        java.lang.String taskId,
                                        java.lang.String topicName,
                                        oracle.bpel.services.workflow.metadata.processDocumentation.model.DocumentationAudienceEnum documentationAudience,
                                        java.util.Locale locale)
                                        throws TaskMetadataServiceException

Returns if the given Human task contains TopicDocumentation objects in the specified topicName, documentationAudience and locale

Parameters:

context - The workflow context

taskId - The task id

topicName - The topic name

documentationAudience - The enum for documentation audience type

locale - The locale of the audience user

Returns:

true if the given Human task contains TopicDocumentation objects in the specified topicName, documentationAudience and locale

Throws:

TaskMetadataServiceException