Skip navigation links

oracle.tip.pc.services.identity
Interface BPMUser

All Superinterfaces:

BPMIdentity, BPMPrincipal, java.security.Principal

public interface BPMUser

extends BPMIdentity

BPMUser interface defines BPEL Process Manager User

Method Summary

java.lang.String	getCountry() Gets user's location, country based on user's locale
java.lang.String	getFax() Gets fax number for this BPMUser It can return null if person does not have fax number.
java.lang.String	getFirstName() Gets first user name
java.util.Set<BPMPosition>	getGrantedPositions() Gets positions assigned to the user.
java.lang.String	getHomePhone() Gets home phone number for this BPMUser
java.lang.String	getLanguage() Gets user's language based on user's locale
java.lang.String	getLanguagePreference() Gets user's language preference
java.lang.String	getLastName() Gets last name for this BPMUser
java.util.Locale	getLocale() Gets user's java locale, based on language preference.
java.util.List	getManagementChain() Gets chain of managers for this BPMUser.
java.util.List	getManagementChain(BPMUser upToUser) Gets chain of managers for this BPMUser up to given user.
java.util.List	getManagementChain(int max) Gets chain of managers for this BPMUser up given max amount of managers.
java.util.List	getManagementChain(int max, java.lang.String upToManagerName, java.lang.String upToTitle) 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
java.util.List	getManagementChain(java.lang.String title) Gets chain of managers for this BPMUser up to given manager title.
BPMUser	getManager() Gets manager this BPMUser.
java.lang.String	getManagerName() Gets manager's name this BPMUser.
java.lang.String	getMiddleName() Gets middle name for this BPMUser
java.lang.String	getMobile() Gets mobile phone number for this BPMUser It can return null if person does not have mobile phone.
java.util.List	getNotificationPreferences() Deprecated. since 11. The method returns empty list.
java.lang.String	getPager() Gets pager number for this BPMUser It can return null if person does not have pager.
java.security.PermissionCollection	getPermissions() Gets the permissions associated with the User
java.security.PermissionCollection	getPermissions(java.lang.String appId) Gets the permissions associated with the User for a given application
java.util.List	getReportees(int maxReporteeLevel) Gets reportees for the user up to given level in the hierarchical structure
java.lang.String	getTenantID() Gets Tenant ID in which this user is seeded.
java.lang.String	getTenantName() Gets Tenant Name in which this user is seeded.
java.util.TimeZone	getTimeZone() Gets user's time zone
java.lang.String	getTitle() Gets user's title
java.lang.String	getWorkPhone() Gets work phone number for this BPMUser
boolean	hasPermission(java.security.Permission perm, java.lang.String appId) Checks whether the user has specify permission

Methods inherited from interface oracle.tip.pc.services.identity.BPMIdentity

getActions, getAppRoles, getAppRoles, getEmail, getGrantedRoles, getGrantedRoles, getGroups, getIdentityType, getManagedRoles, getOwnedRoles, getRoles, isInRole, isInRole, isOwner

Methods inherited from interface oracle.tip.pc.services.identity.BPMPrincipal

getAttribute, getAttributes, getDescription, getDisplayName, getDisplayName, getFullName, getGuid, getRealmName, getUniqueName, toNode

Methods inherited from interface java.security.Principal

equals, getName, hashCode, toString

Method Detail

getFirstName

java.lang.String getFirstName()
                              throws BPMIdentityException

Gets first user name

Returns:

String

Throws:

BPMIdentityException - if error occurs

getMiddleName

java.lang.String getMiddleName()
                               throws BPMIdentityException

Gets middle name for this BPMUser

Returns:

String

Throws:

BPMIdentityException - if error occurs

getLastName

java.lang.String getLastName()
                             throws BPMIdentityException

Gets last name for this BPMUser

Returns:

String

Throws:

BPMIdentityException - if error occurs

getWorkPhone

java.lang.String getWorkPhone()
                              throws BPMIdentityException

Gets work phone number for this BPMUser

Returns:

work phone number or null

Throws:

BPMIdentityException - if error occurs

getHomePhone

java.lang.String getHomePhone()
                              throws BPMIdentityException

Gets home phone number for this BPMUser

Returns:

home phone number or null

Throws:

BPMIdentityException - if error occurs

getMobile

java.lang.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

java.lang.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

java.lang.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

java.lang.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

java.util.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

java.util.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

java.lang.String getLanguagePreference()
                                       throws BPMIdentityException

Gets user's language preference

Returns:

language preference

Throws:

BPMIdentityException - if error occurs

getLanguage

java.lang.String getLanguage()
                             throws BPMIdentityException

Gets user's language based on user's locale

Returns:

language

Throws:

BPMIdentityException - if error occurs

getCountry

java.lang.String getCountry()
                            throws BPMIdentityException

Gets user's location, country based on user's locale

Returns:

country

Throws:

BPMIdentityException - if error occurs

getLocale

java.util.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

java.util.TimeZone getTimeZone()
                               throws BPMIdentityException

Gets user's time zone

Returns:

time zone

Throws:

BPMIdentityException - if error occurs

getTitle

java.lang.String getTitle()
                          throws BPMIdentityException

Gets user's title

Returns:

title

Throws:

BPMIdentityException - if error occurs

getManagementChain

java.util.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

java.util.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

java.util.List getManagementChain(java.lang.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

java.util.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

java.util.List getManagementChain(int max,
                                  java.lang.String upToManagerName,
                                  java.lang.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(java.security.Permission perm,
                      java.lang.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

java.security.PermissionCollection getPermissions()
                                                  throws BPMIdentityException

Gets the permissions associated with the User

Returns:

PermissionCollection

Throws:

BPMIdentityException - if error occurs

getPermissions

java.security.PermissionCollection getPermissions(java.lang.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

java.util.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

java.lang.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

java.lang.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

Skip navigation links