Package oracle.tip.pc.services.identity

Interface BPMUser

All Superinterfaces:
BPMIdentity, BPMPrincipal, Principal
public interface BPMUser extends BPMIdentity
BPMUser interface defines BPEL Process Manager User

  • Method Details

    • getFirstName

      String getFirstName() throws BPMIdentityException
      Gets first user name
      Returns:
      String
      Throws:
      BPMIdentityException - if error occurs

    • getMiddleName

      String getMiddleName() throws BPMIdentityException
      Gets middle name for this BPMUser
      Returns:
      String
      Throws:
      BPMIdentityException - if error occurs

    • getLastName

      String getLastName() throws BPMIdentityException
      Gets last name for this BPMUser
      Returns:
      String
      Throws:
      BPMIdentityException - if error occurs

    • getWorkPhone

      String getWorkPhone() throws BPMIdentityException
      Gets work phone number for this BPMUser
      Returns:
      work phone number or null
      Throws:
      BPMIdentityException - if error occurs

    • getHomePhone

      String getHomePhone() throws BPMIdentityException
      Gets home phone number for this BPMUser
      Returns:
      home phone number or null
      Throws:
      BPMIdentityException - if error occurs

    • getMobile

      String getMobile() throws BPMIdentityException
      Gets mobile phone number for this BPMUser It can return null if person does not have mobile phone.
      Returns:
      mobile phone number or null
      Throws:
      BPMIdentityException - if error occurs

    • getFax

      String getFax() throws BPMIdentityException
      Gets fax number for this BPMUser It can return null if person does not have fax number.
      Returns:
      fax is a fax number or null
      Throws:
      BPMIdentityException - if error occurs

    • getPager

      String getPager() throws BPMIdentityException
      Gets pager number for this BPMUser It can return null if person does not have pager.
      Returns:
      pager number or null
      Throws:
      BPMIdentityException - if error occurs

    • getManager

      BPMUser getManager() throws BPMIdentityException, BPMIdentityNotFoundException
      Gets manager this BPMUser. It can return null object if person does not have a manager.
      Returns:
      BPMUser a mananer to this user.
      Throws:
      BPMIdentityNotFoundException - if manager is not found in system
      BPMIdentityException - if error occurs

    • getManagerName

      String getManagerName() throws BPMIdentityException
      Gets manager's name this BPMUser. It can return null object if person does not have a manager.
      Returns:
      name of a mananer to this user.
      Throws:
      BPMIdentityException - if error occurs

    • getReportees

      List getReportees(int maxReporteeLevel) throws BPMIdentityException
      Gets reportees for the user up to given level in the hierarchical structure
      Parameters:
      maxReporteeLevel - - reportees included into result up to maxReporteeLevel from the manager in hierarchical structure If level equals 1, method returns only one level of reportesfor the user; if level equals 2, method return only two levels of reportees for the user; if level equals 3, method returns only treee levels reportees for the user; etc; if 0 or any negative specify , it assumes all reportees
      Returns:
      List of reportees, BPMUsers.
      Throws:
      BPMIdentityException - if error occurs

    • getNotificationPreferences

      List getNotificationPreferences() throws BPMIdentityException
      Deprecated.
      since 11. The method returns empty list.
      Gets list of preferences, Channel objects for notification. Each Channel in list has preference over next for given person List could be empty if no preferences were specified
      Returns:
      list of Channel
      Throws:
      BPMIdentityException - if error occurs

    • getLanguagePreference

      String getLanguagePreference() throws BPMIdentityException
      Gets user's language preference
      Returns:
      language preference
      Throws:
      BPMIdentityException - if error occurs

    • getLanguage

      String getLanguage() throws BPMIdentityException
      Gets user's language based on user's locale
      Returns:
      language
      Throws:
      BPMIdentityException - if error occurs

    • getCountry

      String getCountry() throws BPMIdentityException
      Gets user's location, country based on user's locale
      Returns:
      country
      Throws:
      BPMIdentityException - if error occurs

    • getLocale

      Locale getLocale() throws BPMIdentityException
      Gets user's java locale, based on language preference. if language preference isnot defined, default locale is returned
      Returns:
      Locale
      Throws:
      BPMIdentityException - if error occurs

    • getTimeZone

      TimeZone getTimeZone() throws BPMIdentityException
      Gets user's time zone
      Returns:
      time zone
      Throws:
      BPMIdentityException - if error occurs

    • getTitle

      String getTitle() throws BPMIdentityException
      Gets user's title
      Returns:
      title
      Throws:
      BPMIdentityException - if error occurs

    • getManagementChain

      List getManagementChain() throws BPMIdentityException
      Gets chain of managers for this BPMUser. Method can return empty list if the user does not have manager
      Returns:
      List of BPMUser objects which composing manager chain for this person.
      Throws:
      BPMIdentityException - if error occurs

    • getManagementChain

      List getManagementChain(int max) throws BPMIdentityException
      Gets chain of managers for this BPMUser up given max amount of managers. Method can return empty list if user does not have manager or less then given max amount if person does not have more managers obove him in his hierarchical structure
      Parameters:
      max - a maximum anount of managers to look up in management chain If this is 0, then an empty list is returned. If it is negative, then the chain till the top of the hierarchy is returned.
      Returns:
      List of BPMUser objects which composing manager chain for this person
      Throws:
      BPMIdentityException - if error occurs

    • getManagementChain

      List getManagementChain(String title) throws BPMIdentityException, BPMIdentityNotFoundException
      Gets chain of managers for this BPMUser up to given manager title. Method can return empty list if user does not have manager
      Parameters:
      title - a manager title. If this is the same as the title of the current user, then an empty list is returned. Otherwise, the chain till this specified user is returned.
      Returns:
      List of BPMUser objects which composing manager chain for this person from company hierarchical structure
      Throws:
      BPMIdentityNotFoundException - if no manager with specified title is found for this person from hierarchical organization structure
      BPMIdentityException - if error occurs

    • getManagementChain

      List getManagementChain(BPMUser upToUser) throws BPMIdentityException, BPMIdentityNotFoundException
      Gets chain of managers for this BPMUser up to given user. Method can return empty list if user does not have manager or upToUser is the same user
      Parameters:
      upToUser - is a last user included into the manangent chain result. If this is the same as the current user, then an empty list is returned. Otherwise, the chain till this specified user is returned.
      Returns:
      List of BPMUser objects which composing manager chain for this person from company hierarchical structure
      Throws:
      BPMIdentityNotFoundException - if no manager with specified upToUser BPMUser is found for this person from hierarchical organization structure
      BPMIdentityException - if error occurs

    • getManagementChain

      List getManagementChain(int max, String upToManagerName, String upToTitle) throws BPMIdentityException, BPMIdentityNotFoundException
      Gets chain of managers for this BPMUser up to given manager title or manager name Method can return empty list if user does not have manager
      Parameters:
      max - a maximum anount of managers to look up in management chain If this is 0, then an empty list is returned. If it is negative, then the chain till the top of the hierarchy is returned. Otherwise, the chain till this specified limit is returned.
      upToManagerName - a manager name. If this is the same as the name of the current user, an empty list is returned.
      upToTitle - a manager title. If this is the same as the title of the current user, then an empty list is returned. Otherwise, the chain till this specified user is returned.
      Returns:
      List of BPMUser objects which composing manager chain for this person from company hierarchical structure throws BPMIdentityNotFoundException if no manager with specified title or with specified upToUser BPMUser is found for this person from hierarchical organization structure
      Throws:
      BPMIdentityException - if error occurs
      BPMIdentityNotFoundException

    • hasPermission

      boolean hasPermission(Permission perm, String appId) throws BPMIdentityException
      Checks whether the user has specify permission
      Parameters:
      perm - a Permission object
      appId - a application Id
      Returns:
      true if user has specified permission, else false
      Throws:
      BPMIdentityException - if error occurs

    • getPermissions

      PermissionCollection getPermissions() throws BPMIdentityException
      Gets the permissions associated with the User
      Returns:
      PermissionCollection
      Throws:
      BPMIdentityException - if error occurs

    • getPermissions

      PermissionCollection getPermissions(String appId) throws BPMIdentityException
      Gets the permissions associated with the User for a given application
      Parameters:
      appId - a application Id
      Returns:
      PermissionCollection
      Throws:
      BPMIdentityException - if error occurs

    • getGrantedPositions

      Set<BPMPosition> getGrantedPositions() throws BPMIdentityException
      Gets positions assigned to the user. This API is based on PositionLookup provider configuration. If the position lookup provider is configured in indentity configurations, the API queries to the provider and retunrs the list of BPMPositions. If no provider is specified, empty list is returned.
      Returns:
      Throws:
      BPMIdentityException - if error occurs

    • getTenantID

      String getTenantID() throws BPMIdentityException
      Gets Tenant ID in which this user is seeded. This API is applicable only for multi-tenant environments configured with Oracle Internet Directory.
      Returns:
      Tenant ID of the user
      Throws:
      BPMIdentityException - if error occurs

    • getTenantName

      String getTenantName() throws BPMIdentityException
      Gets Tenant Name in which this user is seeded. This API is applicable only for multi-tenant environments configured with Oracle Internet Directory.
      Returns:
      Tenant Name of the user
      Throws:
      BPMIdentityException - if error occurs

    • isManager

      boolean isManager() throws BPMIdentityException
      Check is current user is a manager who has at least one reportee
      Returns:
      isManager, true or false
      Throws:
      BPMIdentityException - if error occurs