IRuntimeConfigService (Oracle Fusion Middleware BPM-Services Java API Reference for Oracle BPM Suite)

Class

Tree

Help

Oracle Fusion Middleware
Java API Reference for Oracle BPM Suite
11g Release 1 (11.1.1.6.3)
E25378-06

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.bpel.services.workflow.runtimeconfig
Interface IRuntimeConfigService

public interface IRuntimeConfigService

The RuntimeConfigService is used to query and update metadata specific to the runtime operation of the Workflow Service. It is used for querying and setting flexfield mappings, for querying the what Dynamic Assignment Functions are available, and for querying and setting the URIs used to display task details.

An instance of IRuntimeConfigService can be created by calling IWorkflowServiceClient.getRuntimeConfigService(). An instance of IWorkflowServiceClient can be created using the WorkflowServiceClientFactory.

All the RuntimeConfigService methods take IWorkflowContext as their first parameter. The IWorkflowContext object allows the RuntimeConfigService to validate that the method is being called by an authenticated user, and that the user has the necessary authority to perform the action being requested. The IWorkflowContext object also contains information on the user's timezone and locale. An IWorkflowContext object can be obtained by calling ITaskQueryService.authenticate(java.lang.String, java.lang.String, java.lang.String, java.lang.String) or ITaskQueryService.createContext(HttpServletRequest).

In most cases, any authenticated user can use the query methods, but only a user with specific privileges can use methods that update data.

Many of the parameters and return types of the methods are JAXB model objects from the package oracle.bpel.services.workflow.runtimeconfig.model. These objects do not have public constructors. To create new instances of these objects you should use the appropriate methods on oracle.bpel.services.workflow.runtimeconfig.model.ObjectFactory.

Since:: 10.1.3.1.0

Nested Class Summary
`static class`	`IRuntimeConfigService.WorkflowExtension` Enumeration that lists all the workflow extensions supported

Method Summary
`void`	`bulkUpdateApprovalGroup(IWorkflowContext wctx, ApprovalGroup ag)` Bulk updates an approval group.To be used when bulk changes are made to the approval group content.
`void`	`createApprovalGroup(IWorkflowContext wctx, ApprovalGroup ag)` Creates an approval group This API is available only if Approval Management Extension is enabled
`AttributeLabel`	`createAttributeLabel(IWorkflowContext ctx, AttributeLabelType label)` Creates a new label for a Task flexfield attribute from the supplied `AttributeLabel` object.
`void`	`createInGroup(IWorkflowContext wctx, java.lang.String approvalGroupName, ApprovalGroupMemberType approvalGroupMember)` Create a member in approval group This API is available only if Approval Management Extension is enabled
`PayloadMapping`	`createPayloadMapping(IWorkflowContext ctx, PayloadMappingType mapping)` Creates a mapping between a specific task defintion, and a task flexfield attribute, using an attribute label.
`void`	`deleteApprovalGroup(IWorkflowContext wctx, java.lang.String approvalGroupName)` Deletes an approval group This API is available only if Approval Management Extension is enabled
`void`	`deleteAttributeLabel(IWorkflowContext ctx, java.lang.String labelId)` Deletes the attribute label with the suppled labelId.
`void`	`deleteFromGroup(IWorkflowContext wctx, java.lang.String approvalGroupName, ApprovalGroupMemberType approvalGroupMember)` Delete a member from approval group This API is available only if Approval Management Extension is enabled
`void`	`deletePayloadMapping(IWorkflowContext ctx, PayloadMappingType mapping)` Deletes the payload mapping described by the supplied `PayloadMapping` object.
`void`	`deleteTaskDisplayInfo(IWorkflowContext ctx, TaskDisplayInfoType taskDisplayInfo)` Deletes all instances of a particular task display information.
`ApprovalGroup`	`getApprovalGroup(IWorkflowContext wctx, java.lang.String approvalGroupName)` Gets an approval group This API is available only if Approval Management Extension is enabled
`AttributeLabelUsageList`	`getAttributeLabelUsages(IWorkflowContext ctx, java.lang.String attributeType)` Gets a list of attribute labels and their usages by payload mappings.
`java.util.List<PayloadMappingType>`	`getBPMProcessPayloadMappings(IWorkflowContext ctx, java.lang.String processDN)` Gets a list of payload flexfield mappings that have been defined for the specified, BPM Process in the form of a `PayloadMappingsList` object.
`org.w3c.dom.Element`	`getConfiguration(IWorkflowContext adminCtx)` Returns the current workflow configuration settings as an org.w3c.dom.Element object.
`java.util.List<DynamicAssignFunctionType>`	`getDynamicAssignmentFunctions(IWorkflowContext ctx, oracle.bpel.services.workflow.assignment.dynamic.IDynamicAssignmentPattern.AssigneeType assigneeType)` Gets a list of the currently registered dynamic assignment functions.
`DynamicAssignFunctionList`	`getGroupDynamicAssignmentFunctions(IWorkflowContext ctx)` Deprecated. since 11.1.1.6.3 - use `getDynamicAssignmentFunctions(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.assignment.dynamic.IDynamicAssignmentPattern.AssigneeType)` with an assigneeType of AssigneeType.GROUP instead.
`java.lang.String`	`getInternalServerURL()` Retrieves the internal server url from the fabric config manager.
`java.lang.String`	`getJndiURLFromFabricConfig()` Retrieves the server url from the fabric config manager
`java.lang.String`	`getServerURLFromFabricConfig()` Retrieves the SOA server url.
`java.util.List<IRuntimeConfigService.WorkflowExtension>`	`getSupportedWorkflowExtensions()` Get list of supported workflow extensions
`TaskDisplayInfoList`	`getTaskDisplayInfo(IWorkflowContext ctx, java.lang.String taskDefinitionNamespace, java.lang.String compositeVersion, java.lang.String applicationName)` Deprecated. since 11.1.1.4.0. Use `getTaskDisplayInfo(IWorkflowContext,String,String,String,String)` instead.
`java.util.List<TaskDisplayInfoType>`	`getTaskDisplayInfo(IWorkflowContext ctx, java.lang.String taskDefinitionNamespace, java.lang.String compositeVersion, java.lang.String partitionName, java.lang.String applicationName)` Retreives information relating to the URI to be used by client applications to display the task details for tasks of a particular type, in the form of a `TaskDisplayInfoList` object.
`java.util.List<TaskDisplayInfoType>`	`getTaskDisplayInfoByTaskDefinitionId(IWorkflowContext ctx, java.lang.String taskDefinitionId, java.lang.String applicationName)` Retreives information relating to the URI to be used by cleint applications to display the task details for tasks of a particular type, in the form of a `TaskDisplayInfoList` object.
`TaskStatus`	`getTaskStatus(IWorkflowContext ctx, java.lang.String taskDefinitionId, java.lang.String taskDefinitionNamespace, java.lang.String compositeInstanceId)` Get the status of a task instance corresponding to a particular task definition and composite instance.
`UcmInfo`	`getUCMInfo(IWorkflowContext context, UcmRequest request)`
`DynamicAssignFunctionList`	`getUserDynamicAssignmentFunctions(IWorkflowContext ctx)` Deprecated. since 11.1.1.6.3 - use `getDynamicAssignmentFunctions(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.assignment.dynamic.IDynamicAssignmentPattern.AssigneeType)` with an assigneeType of AssigneeType.USER instead.
`PayloadMappingsList`	`getWorkflowPayloadMappings(IWorkflowContext ctx, java.lang.String workflowId)` Gets a list of payload flexfield mappings that have been defined for the specified task type, in the form of a `PayloadMappingsList` object.
`ApprovalGroupNameList`	`searchApprovalGroups(IWorkflowContext wctx, java.lang.String searchString, java.lang.String searchType, java.lang.String sortType)` Fetches a list of matching approval group names This API is available only if Approval Management Extension is enabled
`void`	`setTaskDisplayInfo(IWorkflowContext ctx, java.lang.String taskDefinitionNamespace, java.lang.String compositeVersion, java.lang.String partitionName, java.util.List<TaskDisplayInfoType> taskDisplayInfoList)` Sets information relating to the URI to be used by client applications to display the task details for tasks of a particular type, in a particular partition, in the form of a list of `TaskDisplayInfoType` objects.
`void`	`setTaskDisplayInfo(IWorkflowContext ctx, java.lang.String taskDefinitionNamespace, java.lang.String compositeVersion, TaskDisplayInfoList taskDisplayInfo)` Deprecated. since 11.1.1.4.0. Use `setTaskDisplayInfo(IWorkflowContext, String, String, String, List)` instead.
`void`	`updateApprovalGroup(IWorkflowContext wctx, ApprovalGroup ag)` Updates an approval group This API is available only if Approval Management Extension is enabled
`AttributeLabel`	`updateAttributeLabel(IWorkflowContext ctx, AttributeLabelType label)` Updates an existing attribute label using the supplied `AttributeLabel` object.
`void`	`updateInGroup(IWorkflowContext wctx, java.lang.String approvalGroupName, ApprovalGroupMemberType approvalGroupMember)` Update a member in approval group This API is available only if Approval Management Extension is enabled

Method Detail

getWorkflowPayloadMappings

PayloadMappingsList getWorkflowPayloadMappings(IWorkflowContext ctx,
                                               java.lang.String workflowId)
                                               throws WorkflowException

Gets a list of payload flexfield mappings that have been defined for the specified task type, in the form of a PayloadMappingsList object. A payload mapping defines a mapping between Tasks of a particular type and a flexfield attribute column on the WFTASK table (such as TextAttribute1), via an AttributeLabel. The mapping may also specify how the value of the flexfield attribute should be determined, either via an xpath expression or by specfifying a payload attribute. The PayloadMappingsList contains a List of PayloadMappingType objects. See

createPayloadMapping(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.runtimeconfig.model.PayloadMappingType)

for a complete description of the PayloadMappingType object.

This method should only be used for querying payload mappings for Human Workflow Tasks. The method getBPMProcessPayloadMappings(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String) should be used to query payload mappings for BPM Processes.

Parameters:: ctx - an authenticated IWorkflowContext; workflowId - String the TaskDefinitionId of the task type to query mappings for.
Returns:: PayloadMappingsList contains a List of PayloadMappingType objects.
Throws:: WorkflowException - if some error condition occurs.

getBPMProcessPayloadMappings

java.util.List<PayloadMappingType> getBPMProcessPayloadMappings(IWorkflowContext ctx,
                                                                java.lang.String processDN)
                                                                throws WorkflowException

Gets a list of payload flexfield mappings that have been defined for the specified, BPM Process in the form of a PayloadMappingsList object. A payload mapping defines a mapping between process instances (of a particular process) and a flexfield attribute column on the WFTASK table (such as TextAttribute1), via an AttributeLabel. The mapping may also specify how the value of the flexfield attribute should be determined, either via an xpath expression or by specfifying a payload attribute. The method returns a List of PayloadMappingType objects. See

createPayloadMapping(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.runtimeconfig.model.PayloadMappingType)

for a complete description of the PayloadMappingType object.

This method should only be used for querying payload mappings for BPM Processes. The method getWorkflowPayloadMappings(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String) should be used to query payload mappings for Human Workflow Tasks.

Parameters:: ctx - an authenticated IWorkflowContext; processDN - String the unique id for a particular BPM Process deployment
Returns:: a List of PayloadMappingType objects.
Throws:: WorkflowException - if some error condition occurs.

createAttributeLabel

AttributeLabel createAttributeLabel(IWorkflowContext ctx,
                                    AttributeLabelType label)
                                    throws WorkflowException

Creates a new label for a Task flexfield attribute from the supplied AttributeLabel object. Only users with the workflow.mapping.publicFlexField privilege can create attribute labels, and only users with the workflow.mapping.protectedFlexField privilege can create attribute labels for protected flexfields. An AttributeLabel is associated with a particular Task flexfield. (Flexfield columns are the general purpose columns named TextAttribute1...20, NumberAttribute1...10, DateAttribute1...10, ProtectedTextAttribute1...20 and so on). An AttributeLabel allows a more meaningful name to be assigned to a flexfield column (for example, a label named "CustomerName" is more meaningful than "TextAttribute1"). PayloadMappings map task payload attributes to AttributeLabels - a single AttributeLabel can be associated with more than one PayloadMapping. This allows payload attributes from different tasks that share the same semantic meaning to be mapped to a common label. For example, a number of task types may contain payload attributes that contain a customer name - all of them can be mapped to a single "CustomerName" label.

The label name can be used when displaying mapped flexfield columns for tasks of a particular type or types. The method ITaskMetadataService.getTaskAttributesForTaskDefinition(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String) will return a list of task attributes including any flexfield attributes that have been mapped for that task defintion. The flexfield attributes in the list will have a display name derived from the appropriate AttributeLabel name. It is possible to provide internationalization support for AttributeLabel names, by adding entries to the WorkflowLabels.properties file. See the Workflow Services chapter of the BPEL Process Manager Developer's Guide for more details.

The AttributeLabel object contains the following properties:

id String Unique identifier for AttributeLabel. Automatically populated by API during create operation.
dataType String The type of flexfield column this label is for. Automatically maintained by API, will be populated with one of the following values after create operation:
- "Text"
- "Form"
- "Url"
- "Date"
- "Number"
labelName String The name for the label.
taskAttribute String The name of the flexfield attribute column the label is for. Should be one of the following values:
- TextAttribute1..20
- FormAttribute1..10
- UrlAttribute1..10
- DateAttribute1..10
- NumberAttribute1..10
Users with the workflow.mapping.protectedFlexField permission can also create AttributeLabels using the following values:
- ProtectedTextAttribute1..20
- ProtectedFormAttribute1..10
- ProtectedUrlAttribute1..10
- ProtectedDateAttribute1..10
- ProtectedNumberAttribute1..10
descriptionOptional field used to provide aditional information on the label - for example, to note the origianl source for the data that is stored in attributes mapped to this label
active Not used.
workflowType Not used. Always set to IWorkflowConstants.WF_TYPE by API.
createdDate Calendar Date attribute label was created. Automatically maintained by API.

Parameters:: ctx - an authenticated IWorkflowContext; label - AttributeLabelType object defining attribute label to create.
Returns:: the created AttributeLabel, with API maintained properties populated.
Throws:: WorkflowException - if a non-admin user attempts to create an attribute label, or some other error condition occurs.

updateAttributeLabel

AttributeLabel updateAttributeLabel(IWorkflowContext ctx,
                                    AttributeLabelType label)
                                    throws WorkflowException

Updates an existing attribute label using the supplied AttributeLabel object. Only users with the workflow.mapping.publicFlexField privilege can update attribute labels, and only users with the workflow.mapping.protectedFlexField privilege can update attribute labels for protected flexfields. See

createAttributeLabel(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.runtimeconfig.model.AttributeLabelType)

for a description ofthe AttributeLabel object.

Parameters:: ctx - an authenticated IWorkflowContext; label - AttributeLabelType to update.
Returns:: the updated AttributeLabel.
Throws:: WorkflowException - if a non-admin user attempts to update an attribute label, or some other error condition occurs.

deleteAttributeLabel

void deleteAttributeLabel(IWorkflowContext ctx,
                          java.lang.String labelId)
                          throws WorkflowException

Deletes the attribute label with the suppled labelId. Only users with Only users with the workflow.mapping.publicFlexField privilege can delete attribute labels, and only users with the workflow.mapping.protectedFlexField privilege can delete attribute labels for protected flexfields. When an attribute label is deleted, any payload mappings that use that label are also deleted.

Parameters:: ctx - an authenticated IWorkflowContext; labelId - String unique identifier for attribute label.
Throws:: WorkflowException - if a non-admin user attempts to delete an attribute label, or some other error condition occurs.

getAttributeLabelUsages

AttributeLabelUsageList getAttributeLabelUsages(IWorkflowContext ctx,
                                                java.lang.String attributeType)
                                                throws WorkflowException

Gets a list of attribute labels and their usages by payload mappings. All attribute labels can be queried, or the query can be restricted to attribute labels for a specific flexfield type, by passing the appropriate value to the attributeType parameter:

null - if attributeType is null, all attribute labels will be returned
"Public" - all attribute labels for public flexfields will be returned
"Protected" - all attribute labels for protected flexfields will be returned
"Text" - attribute labels for flexfields TextAttribute1..20 and ProtectedTextAttribute1..20 will be returned
"Form" - attribute labels for flexfields FormAttribute1..10 and ProtectedFormAttribute1..10 will be returned
"Url" - attribute labels for flexfields UrlAttribute1..10 and ProtectedUrlAttribute1..10 will be returned
"Date" - attribute labels for flexfields DateAttribute1..10 and ProtectedDateAttribute1..10 will be returned
"Number" - attribute labels for flexfields NumberAttribute1..10 and ProtectedNumberAttribute1..10 will be returned
"PublicText" - attribute labels for flexfields TextAttribute1..20 will be returned
"PublicForm" - attribute labels for flexfields FormAttribute1..10 will be returned
"PublicUrl" - attribute labels for flexfields UrlAttribute1..10 will be returned
"PublicDate" - attribute labels for flexfields DateAttribute1..10 will be returned
"PublicNumber" - attribute labels for flexfields NumberAttribute1..10 will be returned
"ProtectedText" - attribute labels for flexfields ProtectedTextAttribute1..20 will be returned
"ProtectedForm" - attribute labels for flexfields ProtectedFormAttribute1..10 will be returned
"ProtectedUrl" - attribute labels for flexfields ProtectedUrlAttribute1..10 will be returned
"ProtectedDate" - attribute labels for flexfields ProtectedDateAttribute1..10 will be returned
"ProtectedNumber" - attribute labels for flexfields ProtectedNumberAttribute1..10 will be returned

The returned AttributeLabelUsageList object contains a List of LabelUsages objects. Each LabelUsages contains information about a particular label, and all its usages in payload mappings. A LabelUsages object contains the following properties:

label AttributeLabelType describing the attribute label. See createAttributeLabel(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.runtimeconfig.model.AttributeLabelType) for a description.
usages List of LabelUsageType objects. Each LabelUsageType object describes a usage of the attribute label in a payload mapping, and has the following properties:
- workflowId String TaskDefinitionId of the task definition whose payload is being mapped.
- workflowName String name of the task definition whose payload is being mappied.
- taskDefinitionNamespce String the task definition namespace of the task type the whose payload is being mapped
- forAllTaskVersions boolean value indicating if this mapping is for this specific task definition version, or applies to all versions of the task definition.
- payloadAttribute String name of the payload attribute being mapped (if any). The payload attribute must be a simple type. To select a mapped value from a complex payload attribute, an xpath expression should be used instead.
- xpath XpathType object describing the xpath expression (if any) used to select a value from the Task instance. The xpath expression must evaluate to a simple type. Xpath expressions are typically used to select a value from a complex payload attribute, but any valid xpath expression can be used (for example, an xpath function could be invoked). The XpathType object has the following properties:
  - expression String the xpath expression used to select the value, from within a task instance. For example: /task:task/task:payload/ord:order/ord:item/ord:itemName
  - namespace List of XpathType.NamespaceType objects that describe the namespace prefixes used in the xpath expression, and the namespace URIs they correspond to. Each NamespaceType object has the following properties:
    - prefix String the prefix, for example ord
    - Uri String the namespace URI, for example http://acme.com/xml/order
- descriptionOptional field used to provide aditional information on this mapping - for example, to note the origianl source for the data that this mapping corresponds to.
- createdDate Calendar date the mapping was created.

Parameters:: ctx - an authenticated IWorkflowContext.; attributeType - String null if all attributes are required, otherwise, which type of attributes should be queried.
Returns:: AttributeLabelUsageList containing list of attribute labels and their usages in payload mappings.
Throws:: WorkflowException - if some error condition occurs.

createPayloadMapping

PayloadMapping createPayloadMapping(IWorkflowContext ctx,
                                    PayloadMappingType mapping)
                                    throws WorkflowException

Creates a mapping between a specific task defintion, and a task flexfield attribute, using an attribute label. Only users with the workflow.mapping.publicFlexField or workflow.mapping.protectedFlexField privilege can create a payload mapping.

Note that mappings to protected flexfield attribute labels cannot be created using this API. Such mappings can only be defined in a task definition, and are created during deployment of the task component.

A payload mapping can define a mapping between a value in a task's payload and a flexfield attribute column on the WFTASK table (such as TextAttribute1). This mapping can be specified either as the name of a payload attribute, or as an xpath expression. When payload mapping exists for a particular Task type, the value of the Task payload attribute or xpath expression is written to the mapped flexfield column, allowing queries, views and rules to be defined using the mapped value.

If no payload attribute or xpath expression is specified, then the mapping is for labelling purposes only. It is up to workflow service clients to manually populate the appropriate flexfield attribute on the Task object (e.g. textAttribute1). The label specified in the mapping can still be used in queries etc., however.

Payload mappings are actually made between the a task type and an AttributeLabel. An AttributeLabel allows a more meaningful name to be assigned to a flexfield column, and allows different task types to map payload attributes to a common label.

If a payload attribute is being mapped, it must be a simple type (for example, xsd:string. In order to map to values inside a payload attribute that is a complex type, an xpath expression is required instead.

Payload mappings can be created for a specific version of a task definition, or for all versions of the task definition. If the mapping is created for a specific version, then every time a new version of the task definition is deployed, or every time an existing version of the task definition is redeployed, the payload mappings must be re-created for that new version. If the payload mapping is created for all versions of a task, there is no need to recreate the mapping for new versions or redeployments.

The mapping to be created is defined by the PayloadMappingType object supplied to the method. The attribute label being mapped to must already exist before creating the mapping. PayloadMappingType has the following properties:

workflowId String the TaskDefintionId of the task type the mapping is being created for.
taskDefinitionNamespce String the task definition namespace of the task type the mapping is being created for. Optional parameter, automatically populated by the API.
forAllTaskVersions boolean value indicating if this mapping is for this specific task definition version, or should apply to all versions of the task definition. Optional parameter, defaults to false.
label AttributeLabelType the attribute label being mapped to. Must already exist. See createAttributeLabel(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.runtimeconfig.model.AttributeLabelType) for a description. When creating (or deleting) a payload mapping, only the id property needs to be set on the AttributeLabelType object.
payloadAttribute String the name of the payload attribute that specifies the value that will be used to populate the flexfield column. This is optional, and the payload attribute must be a simple type.
xpath XpathType object describing the xpath expression (if any) used to select a value from the Task instance. The xpath expression must evaluate to a simple type. Xpath expressions are typically used to select a value from a complex payload attribute, but any valid xpath expression can be used (for example, an xpath function could be invoked). The XpathType object has the following properties:
- expression String the xpath expression used to select the value, from within a task instance. For example: /task:task/task:payload/ord:order/ord:item/ord:itemName
- namespace List of XpathType.NamespaceType objects that describe the namespace prefixes used in the xpath expression, and the namespace URIs they correspond to. Each NamespaceType object has the following properties:
  - prefix String the prefix, for example ord
  - Uri String the namespace URI, for example http://acme.com/xml/order

Parameters:: ctx - an authenticated IWorkflowContext.; mapping - PayloadMapping object describing the mapping to create.
Throws:: WorkflowException - if a non-admin user attempts to create a payload mapping, or some other error condition occurs.

deletePayloadMapping

void deletePayloadMapping(IWorkflowContext ctx,
                          PayloadMappingType mapping)
                          throws WorkflowException

Deletes the payload mapping described by the supplied PayloadMapping object. Only users with the workflow.mapping.publicFlexField or workflow.mapping.protectedFlexField privilege can delete a payload mapping. Note that mappings to protected flexfields cannot be deleted via this API - such mappings are specified in the task definitionat design time and are deleted only when the task component is undeployed. See

createPayloadMapping(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.runtimeconfig.model.PayloadMappingType)

for a description of the PayloadMapping object.

Parameters:: ctx - an authenticated IWorkflowContext.; mapping - PayloadMapping object describing the mapping to delete.
Throws:: WorkflowException - if a non-admin user attempts to delete a payload mapping, or some other error condition occurs.

getDynamicAssignmentFunctions

java.util.List<DynamicAssignFunctionType> getDynamicAssignmentFunctions(IWorkflowContext ctx,
                                                                        oracle.bpel.services.workflow.assignment.dynamic.IDynamicAssignmentPattern.AssigneeType assigneeType)
                                                                        throws WorkflowException

Gets a list of the currently registered dynamic assignment functions.

The list can be optionally restricted to only those functions that can select a specific assignee type, by providing the appropriate value for the assigneeType parameter. If this parameter is null, an unrestricted list of all assignment functions will be returned.

The method returns a List of DynamicAssignFunctionType objects. These have the following properties:

name String name of dynamic assignment function.
label String human-readable label for dynamic assignment function. If the implementation of this function does not supply a label, the dynamic assignment function name is used as the label. May be localized appropriately for the supplied IWorkflowContext.
description String short, human-readable description of the function, if the implementation provides one. May be localized appropriately for the supplied IWorkflowContext.
supportedAssigneeTypes contains a List of the assignee types (USER, GROUP, APPROLE) that the function can support.

parameters contains a List of DynamicAssignmentParameterType objects that describe the input parameters (if any) for the function. These have the following properties:

name String name of the parameter
parameterType String the type of parameter (STRING, NUMBER)
mandatory boolean value indicating if parameter is mandatory or optional
defaultValue String default value for the parameter, if the implementation provides one.
label String human-readable label for the parameter. If the implementation of this function does not supply a label, the dynamic parameter name is used as the label. May be localized appropriately for the supplied IWorkflowContext.
description String short, human-readable description of the parameter, if the implementation provides one. May be localized appropriately for the supplied IWorkflowContext.

Parameters:: ctx - an authenticated IWorkflowContext. used to determine appropraite Locale for user-readable labels.; assigneeType - a value of IDynamicAssignmentPattern.AssigneeType that specifies what assignee type (user, group, application role) the queried assignment functions should be able to select. If null, then all assignment functions will be returned.
Returns:: a List of DynamicAssignFunctionType objects.
Throws:: WorkflowException - if an invalid workflow context is provided or some other error condition occurs.

getUserDynamicAssignmentFunctions

DynamicAssignFunctionList getUserDynamicAssignmentFunctions(IWorkflowContext ctx)
                                                            throws WorkflowException

Deprecated. since 11.1.1.6.3 - use getDynamicAssignmentFunctions(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.assignment.dynamic.IDynamicAssignmentPattern.AssigneeType) with an assigneeType of AssigneeType.USER instead.

Parameters:: ctx - an authenticated IWorkflowContext. used to determine appropraite Locale for user-readable labels.
Returns:: DynamicAssignFunctionList contains a List of DynamicAssignFunctionType objects.
Throws:: WorkflowException - if some error condition occurs.

getGroupDynamicAssignmentFunctions

DynamicAssignFunctionList getGroupDynamicAssignmentFunctions(IWorkflowContext ctx)
                                                             throws WorkflowException

Parameters:: ctx - an authenticated IWorkflowContext. used to determine appropraite Locale for user-readable labels.
Returns:: DynamicAssignFunctionList contains a List of DynamicAssignFunctionType objects.
Throws:: WorkflowException - if somem error condition occurs.

getConfiguration

org.w3c.dom.Element getConfiguration(IWorkflowContext adminCtx)
                                     throws WorkflowException

Returns the current workflow configuration settings as an org.w3c.dom.Element object.

Method can only be invoked by authenticated users with workflow.admin level permissions.

Note that the returned object cannot be used for setting configuration settings. WorkflowConfiguration chnages must be made via config MBeans or via Enterprise Manager.

Returned DOM Element can be converted to a WorkflowConfigurations object using the method oracle.bpel.services.workflow.runtimeconfig.impl.RuntimeConfigUtil#getWorkflowConfigurationsFromDOMElement, but the classpath for the client must include the soa-infra-mgmt.jar file for this to work.

Parameters:: adminCtx - authenticated IWorkflowContext for a user with andministrator privileges.
Returns:: WorkflowConfigurations object representing the current state of workflow configuration settings.
Throws:: WorkflowException - if non-admin user attempts to excecute method, or some other error condition occurs.

getTaskDisplayInfo

@Deprecated
TaskDisplayInfoList getTaskDisplayInfo(IWorkflowContext ctx,
                                                  java.lang.String taskDefinitionNamespace,
                                                  java.lang.String compositeVersion,
                                                  java.lang.String applicationName)
                                       throws WorkflowException

Deprecated. since 11.1.1.4.0. Use getTaskDisplayInfo(IWorkflowContext,String,String,String,String) instead.

Retreives information relating to the URI to be used by cleint applications to display the task details for tasks of a particular type, from the Default partition, in the form of a TaskDisplayInfoList object. The task type must be specified by taskDefinitionNamespace and/or compositeVersion. The method can retreive either the task display information for all applications (by passing a null value to the applicationName parameter), or for a specific application (by passing the application name to the applicationName parameter).

If the compositeVersion is specified, then the information pertaining to that specific compositeVersion will be retrieved. Otherwsie, placeholder TaskDisplayInfo entries (if any) that are not targeted to a specific compositeVersion are returned.

This method is deprecated - the methods getTaskDisplayInfo(IWorkflowContext, String, String, String, String) or getTaskDisplayInfoByTaskDefinitionId(IWorkflowContext, String, String) should be used instead. This method will only query the task display info for the partition named 'default'.

Parameters:: ctx - an authenticated IWorkflowContext.; taskDefinitionNamespace - String namespace that identifies the task type to query task display info for.; compositeVersion - String The version of the composite the task type is located in. If null, then any placeholder TaskDisplayInfo entries that do not apply to a specific composite version are returned.; applicationName - String the name of the client application to query task display info for. If null, then task display info for all applications is returned.
Returns:: TaskDisplayInfoList TaskDisplayInfoList object contains a List of TaskDisplayInfoType objects.
Throws:: WorkflowException - if some error condition occurs.

getTaskDisplayInfo

java.util.List<TaskDisplayInfoType> getTaskDisplayInfo(IWorkflowContext ctx,
                                                       java.lang.String taskDefinitionNamespace,
                                                       java.lang.String compositeVersion,
                                                       java.lang.String partitionName,
                                                       java.lang.String applicationName)
                                                       throws WorkflowException

Retreives information relating to the URI to be used by client applications to display the task details for tasks of a particular type, in the form of a TaskDisplayInfoList object. The task type must be specified by taskDefinitionNamespace and/or compositeVersion. The method can retreive either the task display information for all display applications (by passing a null value to the applicationName parameter), or for a specific application (by passing the application name to the applicationName parameter).

If the partitionName is specified, then the information pertaining to that specific partition will be retrieved. Otherwise, placeholder TaskDisplayInfo entries (if any) that apply across all partitions are returned.

The method returns a List of TaskDisplayInfoType objects. The properties of TaskDisplayInfoType} are:

applicationName String The application name this display info corresponds to. Different client applications may choose to display task details differently. The worklist application that ships with the product uses the applicationName "worklist".
uri String the uri to the task display page.
hostname String the name of the host that hosts the task display page.
httpPort String the port number for http requests to the host.
httpsPort String the port number for https requests to the host.

Parameters:: ctx - an authenticated IWorkflowContext.; taskDefinitionNamespace - String namespace that identifies the task type to query task display info for.; compositeVersion - String The version of the composite the TaskDisplayInfo applies to. If null, then any placeholder TaskDisplayInfo entries that do not apply to a specific composite version are returned.; partitionName - String the name of the partition for which the TaskDisplayInfo applies. If null, then any placeholder TaskDisplayInfo objects that apply to all partitions are returned.; applicationName - String the name of the client application to query task display info for. If null, then TaskDisplayInfo entries for all applications is returned.
Returns:: TaskDisplayInfoList TaskDisplayInfoList object contains a List of TaskDisplayInfoType objects.
Throws:: WorkflowException - if some error condition occurs.

setTaskDisplayInfo

@Deprecated
void setTaskDisplayInfo(IWorkflowContext ctx,
                                   java.lang.String taskDefinitionNamespace,
                                   java.lang.String compositeVersion,
                                   TaskDisplayInfoList taskDisplayInfo)
                        throws WorkflowException

Deprecated. since 11.1.1.4.0. Use setTaskDisplayInfo(IWorkflowContext, String, String, String, List) instead.

Sets information relating to the URI to be used by client applications to display the task details for tasks of a particular type, in the form of a TaskDisplayInfoList object. Only a user with the workflow.admin privilege may set the task display information. The task type must be specified by taskDefinitionNamespace and/or compositeVersion. Task display information created by this method will apply for a particular task type across all partitions, unless task display information has beeen created for a specific partition, in which case the partition-specific information takes precendence.

The TaskDisplayInfoList object contains a List of TaskDisplayInfoType objects. The properties of TaskDisplayInfoType are:

applicationName String The application name this display info corresponds to. Different client applications may choose to display task details differently. The worklist application that ships with the product uses the applicationName "worklist".
uri String the uri to the task display page.
hostname String the name of the host that hosts the task display page.
httpPort String the port number for http requests to the host.
httpsPort String the port number for https requests to the host.

Parameters:: ctx - an authenticated IWorkflowContext.; taskDefinitionNamespace - String namespace that identifies the task type to set task display info for.; compositeVersion - String The version of the composite the task type is located in. If null, the currently active composite version will be used, and task display info will be associated with all subsequent deployments of the task type.; taskDisplayInfo - TaskDisplayInfoList object contains a List of TaskDisplayInfoType objects.
Throws:: WorkflowException - if non-admin user attempts to set task display info, or some other error condition occurs.

setTaskDisplayInfo

void setTaskDisplayInfo(IWorkflowContext ctx,
                        java.lang.String taskDefinitionNamespace,
                        java.lang.String compositeVersion,
                        java.lang.String partitionName,
                        java.util.List<TaskDisplayInfoType> taskDisplayInfoList)
                        throws WorkflowException

Sets information relating to the URI to be used by client applications to display the task details for tasks of a particular type, in a particular partition, in the form of a list of TaskDisplayInfoType objects. Only a user with the workflow.admin privilege may set the task display information. The task type must be specified by taskDefinitionNamespace and optionally, compositeVersion.

The task display information overwrites any existing information - any TaskDisplayInfo entries currently stored for the specified composite & partition will be deleted, and the new list of entries written.

If no partition name is supplied, then the task display info will apply across all partitions. If a partition name is supplied, then the task display info applies only to tasks in that particular partition.

If no compositeVersion is specified, then the active version of the composite(s) in the relevant partition(s) is used, and this task display info will be used for any subsequent deployments of the task type to the specified partition. If no compositeVersion is specified, and there are no composites deployed for a partition, then the information is still recorded, and will be set with the active version of the composite when the composite is deployed. This allows task display applications to be deployed prior to the composite.

The properties of TaskDisplayInfoType are:

applicationName String The application name this display info corresponds to. Different client applications may choose to display task details differently. The worklist application that ships with the product uses the applicationName "worklist".
uri String the uri to the task display page.
hostname String the name of the host that hosts the task display page.
httpPort String the port number for http requests to the host.
httpsPort String the port number for https requests to the host.

Parameters:: ctx - an authenticated IWorkflowContext. Authenticated user should have admin privileges.; taskDefinitionNamespace - namespace that identifies the task type to set task display info for.; compositeVersion - The version of the composite the task type is located in. If null, the currently active composite version for the partition will be used. Identifies specific composite version to set task display info for.; partitionName - The partition this task display info applies to. If no partition name is supplied, this task display info applies to the task type in all partitions, apart from partitions that already have their own task display info specified for the task type.; taskDisplayInfoList - List of TaskDisplayInfoType objects.
Throws:: WorkflowException - if non-admin user attempts to set task display info, or some other error condition occurs. .

deleteTaskDisplayInfo

void deleteTaskDisplayInfo(IWorkflowContext ctx,
                           TaskDisplayInfoType taskDisplayInfo)
                           throws WorkflowException

Deletes all instances of a particular task display information. Delete is performed across all namespaces, versions and partitions where the task display info is found. Any entries that match the application, hostname, uri and http or https port are deleted. Typically called when a particular task form application is undeployed, and needs to be removed from any component deployments that refer to it.

Parameters:: ctx - an authenticated IWorkflowContext. Authenticated user should have admin privileges.; taskDisplayInfo - the TaskDisplayInfoType to delete.
Throws:: WorkflowException - if non-admin user attempts to delete task display info, or some other error condition occurs.

getTaskDisplayInfoByTaskDefinitionId

java.util.List<TaskDisplayInfoType> getTaskDisplayInfoByTaskDefinitionId(IWorkflowContext ctx,
                                                                         java.lang.String taskDefinitionId,
                                                                         java.lang.String applicationName)
                                                                         throws WorkflowException

Retreives information relating to the URI to be used by cleint applications to display the task details for tasks of a particular type, in the form of a TaskDisplayInfoList object. The task type must be specified by taskDefinitionId. The method can retreive either the task display information for all applications (by passing a null value to the applicationName parameter), or for a specific application (by passing the application name to the applicationName parameter).

The TaskDisplayInfoList object contains a List of TaskDisplayInfoType objects. The properties of TaskDisplayInfoType} are:

applicationName String The application name this display info corresponds to. Different client applications may choose to display task details differently. The worklist application that ships with the product uses the applicationName "worklist".
uri String the uri to the task display page.
hostname String the name of the host that hosts the task display page.
httpPort String the port number for http requests to the host.
httpsPort String the port number for https requests to the host.

Parameters:: ctx - an authenticated IWorkflowContext.; taskDefinitionId - the unique ID of the task definition.; applicationName - String the name of the client application to query task display info for. If null, then task display info for all applications is returned.
Returns:: TaskDisplayInfoList a List of TaskDisplayInfoType objects.
Throws:: WorkflowException

getTaskStatus

TaskStatus getTaskStatus(IWorkflowContext ctx,
                         java.lang.String taskDefinitionId,
                         java.lang.String taskDefinitionNamespace,
                         java.lang.String compositeInstanceId)
                         throws WorkflowException

Get the status of a task instance corresponding to a particular task definition and composite instance. The task definitino must be identified by passing either the taskDefinitionId or the taskDefinitionNamespace. Method returns a TaskStatus object that has the following parameters:

status String the status of the task instance.
taskId String unique identifier for the task instance.

Parameters:: ctx - an authenticated IWorkflowContext.; taskDefinitionId - String the unique identifier for the task type to get task status info for.; taskDefinitionNamespace - String namespace that identifies the task type to get task status info for.; compositeInstanceId - a String the unique identifier for the composite instance.
Returns:: TaskStatus object.
Throws:: WorkflowException - if some error condition occurs.

createApprovalGroup

void createApprovalGroup(IWorkflowContext wctx,
                         ApprovalGroup ag)
                         throws WorkflowException

Creates an approval group
This API is available only if Approval Management Extension is enabled

Parameters:: wctx - an authenticated IWorkflowContext; ag - an approval group ApprovalGroup
Throws:: WorkflowException - in case of error

updateApprovalGroup

void updateApprovalGroup(IWorkflowContext wctx,
                         ApprovalGroup ag)
                         throws WorkflowException

Updates an approval group
This API is available only if Approval Management Extension is enabled

Parameters:: wctx - an authenticated IWorkflowContext; ag - an approval group ApprovalGroup
Throws:: WorkflowException - in case of error

bulkUpdateApprovalGroup

void bulkUpdateApprovalGroup(IWorkflowContext wctx,
                             ApprovalGroup ag)
                             throws WorkflowException

Bulk updates an approval group.To be used when bulk changes are made to the approval group content.
This API is available only if Approval Management Extension is enabled

Parameters:: wctx - an authenticated IWorkflowContext; ag - an approval group ApprovalGroup
Throws:: WorkflowException - in case of error

getApprovalGroup

ApprovalGroup getApprovalGroup(IWorkflowContext wctx,
                               java.lang.String approvalGroupName)
                               throws WorkflowException

Gets an approval group
This API is available only if Approval Management Extension is enabled

Parameters:: wctx - an authenticated IWorkflowContext; approvalGroupName - internal name of the group
Returns:: the ApprovalGroup object
Throws:: WorkflowException - in case of error

deleteApprovalGroup

void deleteApprovalGroup(IWorkflowContext wctx,
                         java.lang.String approvalGroupName)
                         throws WorkflowException

Deletes an approval group
This API is available only if Approval Management Extension is enabled

Parameters:: wctx - an authenticated IWorkflowContext; approvalGroupName - internal Name of the Group
Throws:: WorkflowException - in case of error

createInGroup

void createInGroup(IWorkflowContext wctx,
                   java.lang.String approvalGroupName,
                   ApprovalGroupMemberType approvalGroupMember)
                   throws WorkflowException

Create a member in approval group
This API is available only if Approval Management Extension is enabled

Parameters:: wctx - an authenticated IWorkflowContext; approvalGroupName - internal Name of the Group; approvalGroupMember - ApprovalGroupMemberType object ApprovalGroupMemberType
Throws:: WorkflowException

updateInGroup

void updateInGroup(IWorkflowContext wctx,
                   java.lang.String approvalGroupName,
                   ApprovalGroupMemberType approvalGroupMember)
                   throws WorkflowException

Update a member in approval group
This API is available only if Approval Management Extension is enabled

Parameters:: wctx - an authenticated IWorkflowContext; approvalGroupMember - ApprovalGroupMemberType object ApprovalGroupMemberType
Throws:: WorkflowException

deleteFromGroup

void deleteFromGroup(IWorkflowContext wctx,
                     java.lang.String approvalGroupName,
                     ApprovalGroupMemberType approvalGroupMember)
                     throws WorkflowException

Delete a member from approval group
This API is available only if Approval Management Extension is enabled

Parameters:: wctx - an authenticated IWorkflowContext; approvalGroupName - internal Name of the Group; approvalGroupMember - ApprovalGroupMemberType object ApprovalGroupMemberType
Throws:: WorkflowException

searchApprovalGroups

ApprovalGroupNameList searchApprovalGroups(IWorkflowContext wctx,
                                           java.lang.String searchString,
                                           java.lang.String searchType,
                                           java.lang.String sortType)
                                           throws WorkflowException

Fetches a list of matching approval group names
This API is available only if Approval Management Extension is enabled

Parameters:: wctx - an authenticated IWorkflowContext; searchString - String for the search. Can contain wild card characters.; searchType - GROUP or USER. If GROUP, it should return all the groups for the search string. If USER, it should return all the groups in which that user (the search string) is present. By default this parameter is set to GROUP.; sortType - ASC, DSC or null. If ASC, it should return the groups sorted in ascending order of name. If DSC, it should return the groups in descending order of name. If null, it should return the groups in the order they were created.
Returns:: ApprovalGroupNameList object -- a List of matching approval group names or null if nothing found
Throws:: WorkflowException

getServerURLFromFabricConfig

java.lang.String getServerURLFromFabricConfig()
                                              throws WorkflowException

Retrieves the SOA server url. If FusionAppsFrontendHostUrl has been configured in the HWF configuration MBeans, that value is returned, otherwise the ServerUrl configured in the Fabric configuration MBeans is returned.

Returns:: String -- a server url
Throws:: WorkflowException - in case of error

getInternalServerURL

java.lang.String getInternalServerURL()
                                      throws WorkflowException

Retrieves the internal server url from the fabric config manager. Value is retrieved directly from the value of ServerUrl configured in the Fabric configuration MBeans - any value configured for FusionAppsFrontendHostUrl in the HWF configuration MBeans is ignored.

Returns:: String -- a server url
Throws:: WorkflowException - in case of error

getJndiURLFromFabricConfig

java.lang.String getJndiURLFromFabricConfig()
                                            throws WorkflowException

Retrieves the server url from the fabric config manager

Returns:: String -- a server url
Throws:: WorkflowException - in case of error

getSupportedWorkflowExtensions

java.util.List<IRuntimeConfigService.WorkflowExtension> getSupportedWorkflowExtensions()
                                                                                       throws WorkflowException

Get list of supported workflow extensions

Returns:: List<WorkflowExtension> List of supported workflow extensions
Throws:: WorkflowException - in case of error

getUCMInfo

UcmInfo getUCMInfo(IWorkflowContext context,
                   UcmRequest request)
                   throws WorkflowException

Throws:: WorkflowException

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle Fusion Middleware
Java API Reference for Oracle BPM Suite
11g Release 1 (11.1.1.6.3)
E25378-06

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.bpel.services.workflow.runtimeconfig Interface IRuntimeConfigService

getWorkflowPayloadMappings

getBPMProcessPayloadMappings

createAttributeLabel

updateAttributeLabel

deleteAttributeLabel

getAttributeLabelUsages

createPayloadMapping

deletePayloadMapping

getDynamicAssignmentFunctions

getUserDynamicAssignmentFunctions

getGroupDynamicAssignmentFunctions

getConfiguration

getTaskDisplayInfo

getTaskDisplayInfo

setTaskDisplayInfo

setTaskDisplayInfo

deleteTaskDisplayInfo

getTaskDisplayInfoByTaskDefinitionId

getTaskStatus

createApprovalGroup

updateApprovalGroup

bulkUpdateApprovalGroup

getApprovalGroup

deleteApprovalGroup

createInGroup

updateInGroup

deleteFromGroup

searchApprovalGroups

getServerURLFromFabricConfig

getInternalServerURL

getJndiURLFromFabricConfig

getSupportedWorkflowExtensions

getUCMInfo

oracle.bpel.services.workflow.runtimeconfig
Interface IRuntimeConfigService