Skip navigation links
Oracle Fusion Middleware
Workflow Services Java API Reference for Oracle SOA Suite
12c Release 2 (12.2.1.2.0)
E67161-01
oracle.bpel.services.workflow.user

Interface IUserMetadataService

Parameters:
ctx - authenticated IWorkflowContext for user
user - Participant user to query information for
Returns:
empty VacationInfo object if no vacation information has been set for user, otherwise a VacationInfo object populated with vacation information.
Throws:
WorkflowException - if non-admin user attempts to query information for another user, or some other error condition occurs
Parameters:
ctx - authenticated IWorkflowContext for user
vacationInfo - VacationInfo the vacation information to set
Returns:
the updated VacationInfo vacation information
Throws:
WorkflowException - if non-admin user attempts to update information for another user, or some other error condition occurs

  • deleteRule

    void deleteRule(IWorkflowContext ctx,
                java.lang.String ruleId)
         throws WorkflowException
    Deletes an existing workflow rule, based on its ruleId.
    Parameters:
    ctx - authenticated IWorkflowContext for user.
    ruleId - String unique identifier for rule.
    Throws:
    WorkflowException - if non-admin user attempts to delete a a rule belonging to another user or a group that they to not own, or some other error condition occurs.

  • increaseRulePriority

    void increaseRulePriority(IWorkflowContext ctx,
                          java.lang.String ruleId)
                   throws WorkflowException
    Increases the priority of the specified rule by 1. Rules are evaluated in order of their priority from highest (largest numerical value) to lowest. Only the first rule whose conditions are met will be triggered. Rules of lower priority will be ignored, even if the task also meets their conditions.
    Parameters:
    ctx - authenticated IWorkflowContext for user.
    ruleId - String unique identifier for rule.
    Throws:
    WorkflowException - if non-admin user attempts to update information for a rule belonging to another user or a group that they to not own, or some other error condition occurs.

  • decreaseRulePriority

    void decreaseRulePriority(IWorkflowContext ctx,
                          java.lang.String ruleId)
                   throws WorkflowException
    Decreases the priority of the specified rule by 1. Rules are evaluated in order of their priority from highest (largest numerical value) to lowest. Only the first rule whose conditions are met will be triggered. Rules of lower priority will be ignored, even if the task also meets their conditions.
    Parameters:
    ctx - authenticated IWorkflowContext for user.
    ruleId - String unique identifier for rule.
    Throws:
    WorkflowException - if non-admin user attempts to update information for a rule belonging to another user or a group that they to not own, or some other error condition occurs.

  • listUserViews

    java.util.List<ViewSummaryType> listUserViews(IWorkflowContext ctx,
                                              IUserMetadataService.UserTaskViewType viewType,
                                              java.lang.String ownerUser)
                                       throws WorkflowException
    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.

    The IdentityService realm for the owner is assumed to be the same as the context user. Only an admin can call this method with an owner different to the context user.

    If no owner user is specified, then the views owned by the context user are returned.

    Note that if the view type specifies standard views (STANARD_VIEW or STDPROCESS_VIEW), then all standard views of that type are returned, regardless of owner, as standard views are accessible by all users. When a standard view type is specified, then setting the owner field has no affect on the list of views returned.

    If no view type is specified, then all views owned by the specified owner, are returned regardless of type. Note that the list will not include standard views, unless the standard view happens to be owned by that user

    The method returns a List of ViewSummaryTypeobjects, each of which provides summary information about a view. In order to retreive the full details for a particular rule, the method getUserTaskViewDetails(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)should be should be used.

    ViewSummaryType has the following properties:

  • id Stringunique identifier for view, automatically populated by API on view creation.
  • name Stringthe name of the view. If this is a standard view, and the WorkflowLabels.proprties resource bundle contains an entry for this standard view name, then the label from the apppropriate Locale for the context user will be used instead.
  • owner PrincipleRefType The owner of the view.
  • hidden boolean value. Can be used by UI to determine how to display the view. In the sample worklist application, views marked as "hidden" are not displayed in the list of views in the user's task listing page.
  • viewType String identifying the type of view, will be set to the toString() value of one of the members of the enumeration IUserMetadataService.UserTaskViewType.
  • description Stringoptional description of view.

    • For regular process and task views, the list of views owned by the user is returned. For standard views, the complete list of standard views of the specified type is returned.
    Parameters:
    ctx - authenticated IWorkflowContextfor user.
    viewType - a value from the enum IUserMetadataService.UserTaskViewTypespecifying the type of views to list. If no viewType is specfied, then all types of view owned by the user will be listed. If a standard view type is specified, then all standard views of the specified type will be listed, regardless of owner.
    ownerUser - String name of the user owing the views to list. If null, the views owned by the context user will be listed. Only an admin may list views owned by a user other than the context user. The value of the owner parameter is ignored if the viewType parameter is set to STANDARD_VIEW or STDPROCESS_VIEW.
    Returns:
    a List of ViewSummaryTypeobjects.
    Throws:
    WorkflowException

  • listGrantedUserViews

    java.util.List<ViewGrantType> listGrantedUserViews(IWorkflowContext ctx,
                                                   IUserMetadataService.UserTaskViewType viewType,
                                                   PrincipleRefType grantee,
                                                   IUserMetadataService.UserTaskViewGrantType grantType,
                                                   boolean directOnly)
                                            throws WorkflowException
    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.

    If no grantee is specified, then the views granted to the context user are returned.

    If no view type is specified, then all granted views matching the grantee (and grant type, if specified) are listed, regardless of type.

    If no grant type is specified, then all grants matching the grantee (and view type, if specified) are listed, regardless of grant type.

    If directOnly is set to true, then only the views granted directly to the specified grantee are returned. Otherwise, all views granted directly to the grantee, and views granted to any groups or application roles the grantee is a member of are returned.

    Only an admin can query the views granted to another user. Only an admin, a group or application role owner, or a member of the group or application role can query views granted to a group or application role.

    The method returns a List of ViewGrantType objects, which have the following properties:

  • grantType Specifies the type of view grant, and determines whether the grantee will see their own data, or the view owner's data when using the view. Will be set to one of the toString values of the IUserMetadataService.UserTaskViewGrantType enumeration ("DATA" or "DEFINITION").
  • viewId String unique identifier for the granted view.
  • grantee PrincipleRefType The user to whom the view has been granted
  • grantedName String The grantee may choose to use a different name for the view to the one chosen by the view's owner.
  • grantedDescription String The grantee may choose to use a different description for the view to the one chosen by the view's owner.
  • hidden boolean Can be used by UI to determine how to display the view. In the sample worklist application, granted views marked as "hidden" are not displayed in the list of views in the user's task listing page.
  • viewOwner PrincipleRefType The owner of the view.
  • originalName String The name of the view chosen by the owner.
  • originalDescription String The description for the view chosen by the owner.
    • Parameters:
    ctx - authenticated IWorkflowContext for user.
    viewType - a value from the enum IUserMetadataService.UserTaskViewType specifying the type of views to list. If no viewType is specfied, then all types of view gratned to the grantee will be listed.
    grantee - PrincipleRefType identifying the user, group or application role for which to list the granted views. If null, then the context user will be used as the grantee. Note that only an admin can query the views granted to another user. Only an admin, a group or application role owner, or a member of the group or application role can query views granted to a group or application role.
    grantType - a value from the enum IUserMetadataService.UserTaskViewGrantType specifying the type of view grant to list. If null, then all types of view grant will be listed.
    directOnly - if true, then only views granted directly to the grantee will be listed. Otherwise, views granted directly to the grantee, and views granted to any groups and application roles the grantee is a member of will be listed.
    Returns:
    a List of ViewGrantType objects.
    Throws:
    WorkflowException

  • getStandardTaskViewList

    UserViewList getStandardTaskViewList(IWorkflowContext ctx)
                              throws WorkflowException
    Gets the list of standard task views which ship with the product, and are available to all users. Only views of type IUserMetadataService.UserTaskViewType.STANDARD_VIEW will be returned. (This list of standard views can be altered by admin users creating, updating or deleting views of type UserTaskViewType.STANDARD_VIEW.) Views are returned as a UserViewList object. The UserViewList object contains a List of ViewSummaryType objects, accessed by calling the UserViewListType.getView() method. Each ViewSummaryType object provides summary information about a view. In order to retreive the full details for a particular rule, the method getStandardTaskViewDetails(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String) should be used.

    ViewSummaryType has the following properties:

  • id String unique identifier for view, automatically populated by API on view creation.
  • name String the name of the view. If the WorkflowLabels.proprties resource bundle contains an entry for this standard view name, then the label from the apppropriate resource bundle for the context user will be used instead.
  • owner PrincipleRefType The owner of the view- this is set to a dummy value for standard views.
  • hidden boolean value. Can be used by UI to determine how to display the view. In the sample worklist application, views marked as "hidden" are not displayed in the list of views in the user's task listing page.
  • viewType String identifying the type of view, will be set to the toString() value of IUserMetadataService.UserTaskViewType.STANDARD_VIEW.
  • description String optional description of view.

    • Parameters:
    ctx - authenticated IWorkflowContext for user.
    Returns:
    UserViewList list of ViewSummaryType objects.
    Throws:
    WorkflowException - if an error occurs retrieving the standard views.

  • getGrantedTaskViewList

    GrantedViewList getGrantedTaskViewList(IWorkflowContext ctx,
                                       Participant user)
                                throws WorkflowException
    Gets the list of task views that have been granted to the specified user by other users. Only views of type IUserMetadataService.UserTaskViewType.VIEW will be returned. Users that have been granted a view can use that view to query tasks as the owner of the view. The view owner and the grantee will see the same data when using the view. The grantee is able query, but not update view details for the granted view.

    Granted views are returned as a GrantedViewList object. The GrantedViewList object contains a List of ViewGrantType objects, accessed by calling the GrantedViewListType.getViewGrant() method. ViewGrantType has the following properties:

  • grantType String Specifies the type of view grant, and determines whether the grantee will see their own data, or the view owner's data when using the view. Will be set to one of the toString values of the IUserMetadataService.UserTaskViewGrantType enumeration ("DATA" or "DEFINITION").
  • viewId String unique identifier for the granted view.
  • grantee PrincipleRefType The user to whom the view has been granted
  • grantedName String The grantee may choose to use a different name for the view to the one chosen by the view's owner.
  • grantedDescription String The grantee may choose to use a different description for the view to the one chosen by the view's owner.
  • hidden boolean Can be used by UI to determine how to display the view. In the sample worklist application, granted views marked as "hidden" are not displayed in the list of views in the user's task listing page.
  • viewOwner PrincipleRefType The owner of the view.
  • originalName String The name of the view chosen by the owner.
  • originalDescription String The description for the view chosen by the owner.
    • Parameters:
    ctx - authenticated IWorkflowContext for user.
    user - Participant user to get the granted views for.
    Returns:
    GrantedViewList list of ViewGrantType objects.
    Throws:
    WorkflowException - if non-admin user attempts to retrieve the list of granted views for another user, or some other error condition occurs.

  • createUserTaskView

    UserViewDetail createUserTaskView(IWorkflowContext ctx,
                                  UserViewDetail view)
                           throws WorkflowException

    Creates a new view from the specified UserViewDetail object. Views provide a way for users to persist queries that return lists of tasks. A view can define which task columns should be queried, how the tasks should be filtered, and how the tasks should be ordered. Views are persisted by the API, and a view can be used to query a list of tasks using the method ITaskQueryService.queryViewTasks(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String, oracle.bpel.services.workflow.repos.Predicate, oracle.bpel.services.workflow.repos.Ordering, int, int).

    Users can grant other users access to their views, allowing the grantee to query the view data as if they are the view owner.

    The UserViewDetail object properties are as follows:

    • id String unique identifier for view, automatically populated by API on view creation.
    • viewType String indicates whether this view is one of the 'standard views', visible to all users, or is a personal view. Should be set to one of the String values of the enumeration IUserMetadataService.UserTaskViewType. (Either 'VIEW' or 'STANDARD_VIEW'). Only admin users can create (or update, or delete) standard views. If no value is specified, viewType will default to 'VIEW'.
    • name String name for view. In the case of standard views, this name can be used to lookup a resource string from the WorkflowLabels.properties resource bundle. When querying standard views, if such a resource string is available, the value of this field will be replaced by this resource string (in the appropriate Locale, as determined from the IWorkflowContext object). If no resource string is found, then the name of the standard view will be set to the same value as specified in this field when the view was created or updated.
    • owner PrincipleRefType The owner of the view.
    • hidden boolean value. Can be used by UI to determine how to display the view. In the sample worklist application, views marked as "hidden" are not displayed in the list of views in the user's task listing page.
    • description String optional description of view.
    • presentationId @{link String} unique idenitifier for the Presentation associated with this view. The Presentation object determines how the results of the view query should be ordered and formatted. Associating a view with a presentaion is optional. If a view is associated with a Presentation, then the view's viewColumns, viewOptionalInfo and viewOrdering properties are ignored - the values from the Presentation are used instead. Refer to the documentation for the createPresentation(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.user.model.PresentationType) method for more details.
    • viewColumns Note that if a Presentation is associated with the view, this field will be ignored. ColumnListType specifies which task columns should be retrieved by the view. The ColumnListType object should be populated with ColumnType objects. ColumnType objects can be added to the ColumnListType by calling the method ColumnListType.getColumn().add(ColumnType column). ColumnType has the following properties:
    • viewOptionalInfo Note that if a Presentation is associated with the view, this field will be ignored. TaskOptionalInfoType specifies additional information that the view query will return in addtion to that which can be queried directly from task columns. The TaskOptionalInfoType object contains a List of String values, that should correspond to values determined from the ITaskQueryService.OptionalInfo enum. Values can be added to the TaskOptionalInfoType by calling the method TaskOptionalInfoType.getTaskOptionalInfo().add(String value).
    • viewPredicate TaskPredicateType specifies how the view should filter tasks. The TaskPredicateType object contains the following properties:
      • assignmentFilter String value corresponding to a value of ITaskQueryService.AssignmentFilter enum.
      • keywords String optional keyword search string. If this parameter is null, it is omitted from all query. If not null, predicates will be added to the query to perform SQL 'like' operation (of the form LIKE '%keyword%') on the following task attributes: task title, identification key, all textAttributes in task, task number (only if the keyword is a number)
      • clause Deprecated. Use the predicate property instead. This property is still available to preserve backward compatibility.
      • predicate A PredicateType object that specifies the additional conditions in the view query. The simplest way to construct a PredicateType object is to construct a Predicate, and then use the method Predicate.getPredicateType() to obtain the PredicateType object that represents the Predicate.
    • viewOrdering Note that if a Presentation is associated with the view, this field will be ignored. TaskOrderingType specifies how the Tasks or Process Instances selected by the view should be ordered. The TaskOrderingType object contains a List of OrderingClauseType objects. OrderingClauseTypes can be added to the TaskOrderingType by calling the method TaskOrderingType.getClause().add(OrderingClauseType clause). Each OrderingClauseType specifies a single ordering clause, using the following properties:
    • chart ChartType A client application may use this property to define how task counts should be aggregated when using the method ITaskQueryService.queryViewAggregatedTasks(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String, oracle.bpel.services.workflow.repos.Predicate, oracle.bpel.services.workflow.repos.Column, boolean, boolean). ChartType has the following properties:
      • groupByColumn String The name of the column the task counts should be grouped by.
      • selectValues ChartType.SelectValuesType optionally specifies a list of values from the groupByColumn that should be selected for aggregation. If no selectValues are selected, then all agregation is over all values of the groupBy column
      • orderByCount boolean if true, results will be ordered by the counts, if false, results will be ordered by the values of the group by column.
      • ascendingOrder boolean if true, results will be in ascending order, otherwise results will be in descending order.
    • grantees ViewGranteeListType A view can be granted to other users, allowing the grantee users to query tasks using the view. Depending on the grant type specified, grantees will either query data as the view owner (seeing the same data as the view owner sees), or query their own data, filteted by the view. Grantees are able to query, but not update the view definition. ViewGranteeListType contains a List of ViewGranteeType objects. ViewGranteeType objects can be added to the ViewGranteeListType using the method ViewGranteeListType.getGrantee().add(ViewGranteeType grantee). Each ViewGranteeType defines the grant of the view to another user, and has the following properties:
      • grantType String
        • Specifies the type of view grant, and determines whether the grantee will see their own data, or the view owner's data when using the view. Must be set to one of the toString values of the IUserMetadataService.UserTaskViewGrantType enumeration ("DATA" or "DEFINITION").
      • name String the name of the grantee.
      • realm String the name of the IdentityService realm the grantee belongs to, if the grantee is a USER or a GROUP.
      • applicationContext String the name of the Application the grantee belongs to, if the grantee is an APPROLE.
      • type String currently unused. The type of grantee ("USER", "GROUP", or "APPROLE"). Granting of views to groups is not currently supported.
    Parameters:
    ctx - authenticated IWorkflowContext for user.
    view - UserViewDetail that defines view to be created.
    Returns:
    UserViewDetail that was created, with viewId populated.
    Throws:
    WorkflowException - if non-admin user attempts to create a view belonging to another user, or some other error condition occurs.

  • deleteUserTaskView

    void deleteUserTaskView(IWorkflowContext ctx,
                        java.lang.String viewId)
                 throws WorkflowException
    Deletes an existing view identifies by its viewId.
    Parameters:
    ctx - authenticated IWorkflowContext for user.
    viewId - String unique identifier for view.
    Throws:
    WorkflowException - if non-admin user attempts to delete a view belonging to another user, or some other error condition occurs.

  • updateGrantedTaskView

    ViewGrant updateGrantedTaskView(IWorkflowContext ctx,
                                ViewGrant grant)
                         throws WorkflowException
    Allows a grantee to update certain information on a view that has been granted to them. The grantee of a view may update certain properties on the ViewGrant, which affect how the view is displayed to them. They may not update the definition of the view itself. The properties they may update are:
  • grantedName String grantee may choose to use a different name for the view to the one chosen by the view's owner.
  • grantedDescription String grantee may choose to use a different description for the view to the one chosen by the view's owner.
  • hidden boolean Can be used by UI to determine how to display the view. In the sample worklist application, granted views marked as "hidden" are not displayed in the list of views in the user's task listing page.
    • Parameters:
    ctx - authenticated IWorkflowContext for user.
    grant - ViewGrant object containing updated properties.
    Returns:
    The updated ViewGrant object.
    Throws:
    WorkflowException - if non-admin user attempts to update a view grant granted to another user, or some other error condition occurs.

  • getUserPreferences

    UserPreferences getUserPreferences(IWorkflowContext ctx,
                                   Participant user)
                            throws WorkflowException
    Gets the user preferences for the specified user as a UserPreferences object.

    User preferences are a set of name value pairs, stored against a specfic user. They can be used by client programs for implementing user-specific preferences. The sample worklist application uses user preferences for storing such information as what size the main application window should be, and how many rows should be returned in paging queries.

    The UserPreferences object contains a List of UserPreferenceType objects, each of which represents a name value pair. The properties of UserPreferenceType are:

  • user PrincipleRefType The user who set this preference.
  • name String The name of this preference.
  • value String The value of this preference.

    • Parameters:
    ctx - authenticated IWorkflowContext for user.
    user - Participant user to get preferences for.
    Returns:
    UserPreferences list of UserPreferenceType objects.
    Throws:
    WorkflowException - if non-admin user attempts to query the preferences for another user, or some other error condition occurs.

  • setUserPreferences

    UserPreferences setUserPreferences(IWorkflowContext ctx,
                                   UserPreferences prefs)
                            throws WorkflowException
    Sets the user preferences for the specified from a UserPreferences object.

    User preferences are a set of name value pairs, stored against a specfic user. They can be used by client programs for implementing user-specific preferences. The sample worklist application uses user preferences for storing such information as what size the main application window should be, and how many rows should be returned in paging queries.

    The UserPreferences object contains a List of UserPreferenceType objects, each of which represents a name value pair. The properties of UserPreferenceType are:

  • user PrincipleRefType The user who set this preference.
  • name String The name of this preference.
  • value String The value of this preference.

    • Parameters:
    ctx - authenticated IWorkflowContext for user.
    prefs - UserPreferences list of UserPreferenceType objects.
    Returns:
    UserPreferences the updated User Preferences.
    Throws:
    WorkflowException - if non-admin user attempts to update the preferences for another user, or some other error condition occurs.

  • getPublicPreferences

    UserPreferences getPublicPreferences(IWorkflowContext ctx,
                                     Participant user)
                              throws WorkflowException
    Gets 'public' preferences for specified user. Public preferences are preferences that can be read by any user, but can only be updated by the owning user, or an admin. Public preferences are useful for specifying application preferences that apply to all users of a custom client. These custom client application preferences could be created and maintained by an admin user, and be queried by all users, using the admin user's username.
    Parameters:
    ctx - authenticated IWorkflowContext for user.
    user - Participant user to get public preferences for.
    Returns:
    UserPreferences list of UserPreferenceType objects.
    Throws:
    WorkflowException - if some error condition occurs.

  • createUserApplicationData

    UserApplicationDataType createUserApplicationData(IWorkflowContext ctx,
                                                  UserApplicationDataType applicationData)
                                           throws WorkflowException
    FOR FUTURE USE ONLY. This method is intended for use in the BPM product. Creates an instance of a UserApplicationDataType object for a user. UserApplicationData is used to store application-specific data for a particular user. The actual data can be of any format.

    Only the owning user or an admin can create, update or delete their application data, but a user can choose to grant read-only access to application data to other users, groups, or application roles.

    The UserMetadataService is entirely agnostic to the actual application data being stored. All parsing,validation and processing must be performed by the client.

    The properties of a UserApplicationData object are as follows:

    • id String globally unique identifier for UserApplicationData, automatically populated by API on creation.
    • name String Name identifying the application data. The combination of owner, applicationDataType and name must be unique.
    • applicationDataType String string identifying the type of data being stored, for example "LAYOUT" or "BAMDASHBOARD". This can be any value - it is up to API clients to define the types of data.
    • owner String the username of the user that owns this data. If this field is not populated, it will be defaulted to the name of the context user. Only the owner or an admin may create, update or delete application data belonging to the owner.
    • identityContext String the IdentityService realm to which the owner belongs. If left null, it will be defaulted to the realm of the context user.
    • data String Actual data that is stored by API. This is text of unlimited length, and can be any format (XML, CSV etc.). The UserMetadataService is entirely agnostic to the content of this field. All parsing, validation and processing must be performed by the client.
    • grantees A PrincipleListType object containing a List of PrincipleRefType objects identifying the users, groups or application roles that this application data has been shared with. Grantees get read-only access to the application data.
    • createdDate Calendar Date this application data entry was created. Automatically populated by UserMetadataService API.
    • updatedDate Calendar Date this application data entry was last updated. Automatically populated by UserMetadataService API.
    Parameters:
    ctx - authenticated IWorkflowContext for user.
    applicationData - the UserApplicationDataType object to create.
    Returns:
    the UserApplicationDataType object that was created, with automatically maintained fields populated.
    Throws:
    WorkflowException

  • deleteUserApplicationData

    void deleteUserApplicationData(IWorkflowContext ctx,
                               java.lang.String applicationDataId)
                        throws WorkflowException
    FOR FUTURE USE ONLY. This method is intended for use in the BPM product. Deletes a UserApplicationDataType object. Application data can only be deleted by the owner or an admin.
    Parameters:
    ctx - authenticated IWorkflowContext for user.
    applicationDataId - String unique identifier of the user applicaiton data to be deleted.
    Throws:
    WorkflowException

  • getUserApplicationData

    UserApplicationDataType getUserApplicationData(IWorkflowContext ctx,
                                               java.lang.String applicationDataId)
                                        throws WorkflowException
    FOR FUTURE USE ONLY. This method is intended for use in the BPM product. Gets the UserApplicationData object with the specified id. Only the owner, a grantee or an admin can query a UserApplicationData object.
    Parameters:
    ctx - authenticated IWorkflowContext for user.
    applicationDataId - String unique identifier of the user applicaiton data to be deleted.
    Returns:
    a UserApplicationDataType object.
    Throws:
    WorkflowException

  • listGrantedUserApplicationData

    java.util.List<UserApplicationDataType> listGrantedUserApplicationData(IWorkflowContext ctx,
                                                                       java.lang.String dataType,
                                                                       PrincipleRefType grantee,
                                                                       boolean directOnly)
                                                                throws WorkflowException
    FOR FUTURE USE ONLY. This method is intended for use in the BPM product. Gets a list of UserApplicationData objects of the specified type, granted to the specified grantee (which may be a user, group or application role).

    If no dataType is specfied, then all the ApplicationData granted to the specified grantee are returned, regardless of type.

    If no grantee is specified, then the method will use the context user as the grantee.

    If directOnly is set to true, then only ApplicationData granted directly to the specified grantee will be returned. Otherwise ApplicationData granted directly to the grantee, and ApplicationData granted to any groups or application roles the grantee is a member of will be returned

    Only an admin can query the application data granted to another user. Only an admin, a group or application role owner, or a member of the group or application role can query application data granted to a group or application role.

    This method returns only application data granted to the specified grantee. To get application data owned by a user, the method listUserApplicationData(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String, java.lang.String) should be used instead.

    For a description of the UserApplicationDataType object, refer to the documentation for the method createUserApplicationData(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.user.model.UserApplicationDataType)

    Parameters:
    ctx - authenticated IWorkflowContext for user.
    dataType - String the type of application data to return. If null, all UserApplicationData for the specified grantee will be returned.
    grantee - PrincipleRefType identifying the grantee of the application data to return. If no grantee is specfied, then the context user is used as the grantee.
    directOnly - if true, then only the ApplicationData directly granted to the grantee will be listed. Otherwise, ApplicationData granted to groups or application roles the grantee is a member of will also be listed.
    Returns:
    a List of UserApplicationDataType objects.
    Throws:
    WorkflowException

  • createPresentation

    PresentationType createPresentation(IWorkflowContext ctx,
                                    PresentationType presentation)
                             throws WorkflowException
    FOR FUTURE USE ONLY. This method is intended for use in the BPM product. Creates a new Presentation object. Presentations are meta-data that describe how query results should be presented - which columns, how the column data should be formatted, how the results should be sorted, and any additional data that should be fetched.

    Presentations are owned by a specific user, and only the owning user or an admin can create, update or delete presentations, but a user can choose to grant read-only access to application data to other users, groups, or application roles.

    Presentations can be associated with one or more views, and provide a way of defining a standard presentation of data that can be shared amongst multiple views.

    The properties of the PresentationType object are:

    • id A String globally unique idenitier for the Presentation. Automatically assigned by the API when Presentation is created.
    • presentationDataType A String identifying the type of data this presentation is intended to format - "TASK" or "PROCESS". If no value is specified, the presentationDataType will default to "TASK".
    • nameString Name for this presentation - must be unique to the set of presentations belonging to the same owner. The combinition of name and owner must be unique.
    • owner String the username of the user that owns this Presentation. If this field is not populated, it will be defaulted to the name of the context user. Only the owner or an admin may create, update or delete Presentations belonging to the owner.
    • identityContext String the IdentityService realm to which the owner belongs. If left null, it will be defaulted to the realm of the context user.
    • columns ColumnListType specifies which task columns should be retrieved by the view. The ColumnListType object should be populated with ColumnType objects. ColumnType objects can be added to the ColumnListType by calling the method ColumnListType.getColumn().add(ColumnType column). ColumnType has the following properties:
    • optionalInfo TaskOptionalInfoType specifies additional information that the view query will return in addtion to that which can be queried directly from task columns. The TaskOptionalInfoType object contains a List of String values, that should correspond to values determined from the ITaskQueryService.OptionalInfo enum. Values can be added to the TaskOptionalInfoType by calling the method TaskOptionalInfoType.getTaskOptionalInfo().add(String value).
    • orderingTaskOrderingType specifies how the Tasks or Process Instances selected by the view should be ordered. The TaskOrderingType object contains a List of OrderingClauseType objects. OrderingClauseTypes can be added to the TaskOrderingType by calling the method TaskOrderingType.getClause().add(OrderingClauseType clause). Each OrderingClauseType specifies a single ordering clause, using the following properties:
    • grantees A PrincipleListType object containing a List of PrincipleRefType objects identifying the users, groups or application roles that this Presentation has been shared with. Grantees get read-only access to the Presentation.
    • createdDate Calendar Date this Presentation was created. Automatically populated by UserMetadataService API.
    • createdDate Calendar Date this Presentation was last updated. Automatically populated by UserMetadataService API.
    Parameters:
    ctx - authenticated IWorkflowContext for user.
    presentation - PresentationType object representing the presentation to create.
    Returns:
    the created PresentationType, with API maintained properties populated.
    Throws:
    WorkflowException

  • deletePresentation

    void deletePresentation(IWorkflowContext ctx,
                        java.lang.String presentationId)
                 throws WorkflowException
    FOR FUTURE USE ONLY. This method is intended for use in the BPM product. Deletes the specified Presentation. Only the owner of the Presentation, or an admin can delete it.
    Parameters:
    ctx - authenticated IWorkflowContext for user.
    presentationId - String unique identifier for the Presentation to be deleted.
    Throws:
    WorkflowException
Skip navigation links
Oracle Fusion Middleware
Workflow Services Java API Reference for Oracle SOA Suite
12c Release 22 (12.2.1.2.0)
E67161-01

Copyright © 2009, 2016, Oracle and/or its affiliates. All rights reserved.