Skip navigation links

Oracle Fusion Middleware
Workflow Services Java API Reference for Oracle SOA Suite
11g Release 1 (11.1.1.5.0)
E10660-05


oracle.bpel.services.workflow.user
Interface IUserMetadataService


public interface IUserMetadataService

The UserMetadataService provides methods for querying and updating workflow metadata specific to users or groups. It is used for dealing with workflow assignment rules, user views, user preferences and vacation information.

An instance of IUserMetadataService can be created by calling IWorkflowServiceClient.getUserMetadataService(). An instance of IWorkflowServiceClient can be created using the WorkflowServiceClientFactory.

All the UserMetadataService methods take IWorkflowContext as their first parameter. The IWorkflowContext object allows the UserMetdataService 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).

For most methods, users can only query and update their own metadata - they are not permitted to access metadata belonging to other users. In the case of metadata for groups (specifically for workflow rules), only users who are registered as the owner of that group can access the metadata. However, users with administrator privileges can usually access any user or group's metadata.

Many of the parameters and return types of the methods are JAXB model objects from the packages oracle.bpel.services.workflow.user.model, oracle.bpel.services.workflow.query.model, and oracle.bpel.services.workflow.common.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.user.model.ObjectFactory, oracle.bpel.services.workflow.query.model.ObjectFactory or oracle.bpel.services.workflow.common.model.ObjectFactory

Many of the methods in this API use Participant objects to specify a user or group. A Participant object contains parameters that specify the user or group name, the realm (identity context) of the user, and whether the Participant is a user or group.

Since:
10.1.3.1

Nested Class Summary
static class IUserMetadataService.PresentationDataType
          Enumeration specifying the different types of presentation that can be defined.
static class IUserMetadataService.UserTaskViewGrantType
          Enumeration specifying the different grant types that can be used when granting another user access to a UserTaskView.
static class IUserMetadataService.UserTaskViewType
          Enumeration specifying the different types of view that can be defined.

 

Field Summary
static java.lang.String RULE_ACTION_DELEGATE
          Rule action: Delegate task to specified user or group
static java.lang.String RULE_ACTION_DYN_REASSIGN
          Rule action: Dynamically reasign task using dynamic assignment funtion to select user
static java.lang.String RULE_ACTION_NOOP
          Rule action: No operation
static java.lang.String RULE_ACTION_REASSIGN
          Rule action: Reassign task to specified user or group
static java.lang.String RULE_ACTION_SET_OUTCOME
          Rule action: Set task outcome to specified value
static java.lang.String RULE_OP_AFTER
          Rule condition operator: Date occured after
static java.lang.String RULE_OP_BEFORE
          Rule condition operator: Date occured before
static java.lang.String RULE_OP_BEGINS
          Rule condition operator: String begins with value
static java.lang.String RULE_OP_CONTAINS
          Rule condition operator: String contains value
static java.lang.String RULE_OP_ENDS
          Rule condition operator: String ends with value
static java.lang.String RULE_OP_EQ
          Rule condition operator: equal to "=="
static java.lang.String RULE_OP_GT
          Rule condition operator: greater than ">"
static java.lang.String RULE_OP_GTE
          Rule condition operator: greater than or equal to ">="
static java.lang.String RULE_OP_LT
          Rule condition operator: less than "<"
static java.lang.String RULE_OP_LTE
          Rule condition operator: less than or equal to "<="
static java.lang.String RULE_OP_NEQ
          Rule condition operator: not equal to "!="
static java.lang.String RULE_OP_NOT_BEGINS
          Rule condition operator: String does not begin with value
static java.lang.String RULE_OP_NOT_CONTAINS
          Rule condition operator: String does not contain value
static java.lang.String RULE_OP_NOT_ENDS
          Rule condition operator: String does not end with value
static java.lang.String[] VALID_DATE_RULE_OPS
          Array of valid operators for rule conditions on Date values
static java.lang.String[] VALID_NUMBER_RULE_OPS
          Array of valid operators for rule conditions on number values
static java.lang.String[] VALID_STRING_RULE_OPS
          Array of valid operators for rule conditions on String values

 

Method Summary
 PresentationType createPresentation(IWorkflowContext ctx, PresentationType presentation)
          FOR FUTURE USE ONLY.
 RuleDetail createRule(IWorkflowContext ctx, RuleDetail rule)
          Creates a new rule from a RuleDetail object.
 UserApplicationDataType createUserApplicationData(IWorkflowContext ctx, UserApplicationDataType applicationData)
          FOR FUTURE USE ONLY.
 UserViewDetail createUserTaskView(IWorkflowContext ctx, UserViewDetail view)
          Creates a new view from the specified UserViewDetail object.
 void decreaseRulePriority(IWorkflowContext ctx, java.lang.String ruleId)
          Decreases the priority of the specified rule by 1.
 void deletePresentation(IWorkflowContext ctx, java.lang.String presentationId)
          FOR FUTURE USE ONLY.
 void deleteRule(IWorkflowContext ctx, java.lang.String ruleId)
          Deletes an existing workflow rule, based on its ruleId.
 void deleteUserApplicationData(IWorkflowContext ctx, java.lang.String applicationDataId)
          FOR FUTURE USE ONLY.
 void deleteUserTaskView(IWorkflowContext ctx, java.lang.String viewId)
          Deletes an existing view identifies by its viewId.
 GrantedViewList getGrantedTaskViewList(IWorkflowContext ctx, Participant user)
          Gets the list of task views that have been granted to the specified user by other users.
 PresentationType getPresentation(IWorkflowContext ctx, java.lang.String presentationId)
          FOR FUTURE USE ONLY.
 UserPreferences getPublicPreferences(IWorkflowContext ctx, Participant user)
          Gets 'public' preferences for specified user.
 RuleDetail getRuleDetail(IWorkflowContext ctx, java.lang.String ruleId)
          Returns the full details for a particular rule, identified by its ruleId.
 RuleList getRuleList(IWorkflowContext ctx, Participant user)
          Returns a list of rules for the specified user or group, as a RuleList object.
 RulesetInfo getRuleSetInfo(IWorkflowContext ctx, Participant user)
          Deprecated. Rules persistence is no longer configurable, and rules are now persisted internally in the workflow database schema, so this method is now of limited use.
 UserViewDetail getStandardTaskViewDetails(IWorkflowContext ctx, java.lang.String viewId)
          Gets the full details for a particular standard view, identified by its viewId.
 UserViewList getStandardTaskViewList(IWorkflowContext ctx)
          Gets the list of standard task views which ship with the product, and are available to all users.
 UserApplicationDataType getUserApplicationData(IWorkflowContext ctx, java.lang.String applicationDataId)
          FOR FUTURE USE ONLY.
 UserViewDetail getUserInboxView(IWorkflowContext ctx, Participant user)
          Deprecated.  
 UserPreferences getUserPreferences(IWorkflowContext ctx, Participant user)
          Gets the user preferences for the specified user as a UserPreferences object.
 UserViewDetail getUserTaskViewDetails(IWorkflowContext ctx, java.lang.String viewId)
          Gets the full details for a particular user view, identified by its viewId.
 UserViewList getUserTaskViewList(IWorkflowContext ctx, Participant user)
          Gets the list of task views belonging to the specified user.
 VacationInfo getVacationInfo(IWorkflowContext ctx, Participant user)
          Gets the current vacation information for the specified user in the form of a VacationInfo object.
 void increaseRulePriority(IWorkflowContext ctx, java.lang.String ruleId)
          Increases the priority of the specified rule by 1.
 java.util.List<PresentationType> listGrantedPresentations(IWorkflowContext ctx, IUserMetadataService.PresentationDataType presentationType, PrincipleRefType grantee, boolean directOnly)
          FOR FUTURE USE ONLY.
 java.util.List<UserApplicationDataType> listGrantedUserApplicationData(IWorkflowContext ctx, java.lang.String dataType, PrincipleRefType grantee, boolean directOnly)
          FOR FUTURE USE ONLY.
 java.util.List<ViewGrantType> listGrantedUserViews(IWorkflowContext ctx, IUserMetadataService.UserTaskViewType viewType, PrincipleRefType grantee, IUserMetadataService.UserTaskViewGrantType grantType, boolean directOnly)
          Returns a list of all views of the specified type (task views, process views, standard task views, standard process views) and grant type (data or definition) granted to the specified grantee.
 java.util.List<PresentationType> listPresentations(IWorkflowContext ctx, IUserMetadataService.PresentationDataType presentationType, java.lang.String owner)
          FOR FUTURE USE ONLY.
 java.util.List<UserApplicationDataType> listUserApplicationData(IWorkflowContext ctx, java.lang.String dataType, java.lang.String owner)
          FOR FUTURE USE ONLY.
 java.util.List<ViewSummaryType> listUserViews(IWorkflowContext ctx, IUserMetadataService.UserTaskViewType viewType, java.lang.String ownerUser)
          Returns a list of all views of the specified view type (task views, process views, standard task views, standard process views) and grant type (data or definition) owned by the specified user.
 java.util.List<ViewSummaryType> listViewsUsingPresentation(IWorkflowContext ctx, java.lang.String presentationId)
          Returns a list of ViewSummaryType objects that describe views which are using the specified presentation.
 UserPreferences setPublicPreferences(IWorkflowContext ctx, UserPreferences prefs)
          Sets 'public' preferences for specified user.
 UserPreferences setUserPreferences(IWorkflowContext ctx, UserPreferences prefs)
          Sets the user preferences for the specified from a UserPreferences object.
 VacationInfo setVacationInfo(IWorkflowContext ctx, VacationInfo vacationInfo)
          Updates the vacation information for a user using the supplied VacationInfo object.
 ViewGrant updateGrantedTaskView(IWorkflowContext ctx, ViewGrant grant)
          Allows a grantee to update certain information on a view that has been granted to them.
 PresentationType updatePresentation(IWorkflowContext ctx, PresentationType presentation)
          FOR FUTURE USE ONLY.
 RuleDetail updateRule(IWorkflowContext ctx, RuleDetail rule)
          Updates an existing workflow rule to the definition specified in a RuleDetail object.
 UserApplicationDataType updateUserApplicationData(IWorkflowContext ctx, UserApplicationDataType applicationData)
          FOR FUTURE USE ONLY.
 UserViewDetail updateUserTaskView(IWorkflowContext ctx, UserViewDetail view)
          Updates an existing view to the defintion specified in a UserViewDetail object.

 

Field Detail

RULE_ACTION_NOOP

static final java.lang.String RULE_ACTION_NOOP
Rule action: No operation
See Also:
Constant Field Values

RULE_ACTION_REASSIGN

static final java.lang.String RULE_ACTION_REASSIGN
Rule action: Reassign task to specified user or group
See Also:
Constant Field Values

RULE_ACTION_DYN_REASSIGN

static final java.lang.String RULE_ACTION_DYN_REASSIGN
Rule action: Dynamically reasign task using dynamic assignment funtion to select user
See Also:
Constant Field Values

RULE_ACTION_DELEGATE

static final java.lang.String RULE_ACTION_DELEGATE
Rule action: Delegate task to specified user or group
See Also:
Constant Field Values

RULE_ACTION_SET_OUTCOME

static final java.lang.String RULE_ACTION_SET_OUTCOME
Rule action: Set task outcome to specified value
See Also:
Constant Field Values

RULE_OP_LTE

static final java.lang.String RULE_OP_LTE
Rule condition operator: less than or equal to "<="
See Also:
Constant Field Values

RULE_OP_GTE

static final java.lang.String RULE_OP_GTE
Rule condition operator: greater than or equal to ">="
See Also:
Constant Field Values

RULE_OP_EQ

static final java.lang.String RULE_OP_EQ
Rule condition operator: equal to "=="
See Also:
Constant Field Values

RULE_OP_NEQ

static final java.lang.String RULE_OP_NEQ
Rule condition operator: not equal to "!="
See Also:
Constant Field Values

RULE_OP_LT

static final java.lang.String RULE_OP_LT
Rule condition operator: less than "<"
See Also:
Constant Field Values

RULE_OP_GT

static final java.lang.String RULE_OP_GT
Rule condition operator: greater than ">"
See Also:
Constant Field Values

RULE_OP_CONTAINS

static final java.lang.String RULE_OP_CONTAINS
Rule condition operator: String contains value
See Also:
Constant Field Values

RULE_OP_NOT_CONTAINS

static final java.lang.String RULE_OP_NOT_CONTAINS
Rule condition operator: String does not contain value
See Also:
Constant Field Values

RULE_OP_BEGINS

static final java.lang.String RULE_OP_BEGINS
Rule condition operator: String begins with value
See Also:
Constant Field Values

RULE_OP_NOT_BEGINS

static final java.lang.String RULE_OP_NOT_BEGINS
Rule condition operator: String does not begin with value
See Also:
Constant Field Values

RULE_OP_ENDS

static final java.lang.String RULE_OP_ENDS
Rule condition operator: String ends with value
See Also:
Constant Field Values

RULE_OP_NOT_ENDS

static final java.lang.String RULE_OP_NOT_ENDS
Rule condition operator: String does not end with value
See Also:
Constant Field Values

RULE_OP_BEFORE

static final java.lang.String RULE_OP_BEFORE
Rule condition operator: Date occured before
See Also:
Constant Field Values

RULE_OP_AFTER

static final java.lang.String RULE_OP_AFTER
Rule condition operator: Date occured after
See Also:
Constant Field Values

VALID_STRING_RULE_OPS

static final java.lang.String[] VALID_STRING_RULE_OPS
Array of valid operators for rule conditions on String values

VALID_DATE_RULE_OPS

static final java.lang.String[] VALID_DATE_RULE_OPS
Array of valid operators for rule conditions on Date values

VALID_NUMBER_RULE_OPS

static final java.lang.String[] VALID_NUMBER_RULE_OPS
Array of valid operators for rule conditions on number values

Method Detail

getVacationInfo

VacationInfo getVacationInfo(IWorkflowContext ctx,
                             Participant user)
                             throws WorkflowException
Gets the current vacation information for the specified user in the form of a VacationInfo object. Vacation information specifies two dates between which the user is unavailable for assignment of tasks. Dynamic Assignment functions will not assign tasks to users who are currently on vacation. If the user has defined any rules that are flagged as being vacation rules, then the start and end dates for the vacation rules will match the vacation start and end dates.

If no vacation information has been set for the user, an empty VactionInfo object is returned.

VacationInfo has the following properties: