oracle.tip.pc.services.identity
Interface BPMUser

All Superinterfaces:

BPMIdentity, BPMPrincipal, java.security.Principal, java.io.Serializable

public interface BPMUser

extends BPMIdentity, java.io.Serializable

BPMUser interface defines BPEL Process Manager User

Method Summary

java.lang.String	getCountry() Gets user's location, country
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.lang.String	getHomePhone() Gets home phone number for this BPMUser
java.lang.String	getLanguage() Gets user's language preference
java.lang.String	getLastName() Gets last name for this BPMUser
java.util.Locale	getLocale() Gets user's preferred java locale
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() Gets list of preferences, Channel objects for notification.
java.lang.String	getPager() Gets pager number for this BPMUser It can return null if person does not have pager.
java.util.List	getReportees(boolean direct) Gets reportees for this user
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
org.w3c.dom.Node	toNode() Create a DOM Node from the BPMUser object

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

getActions, getAppRoles, getEmail, getGroups, getRoles, isInRole, isInRole

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

getAttribute, getAttributes, getDescription, getDisplayName, getFullName, getGuid

Methods inherited from interface java.security.Principal

equals, getName, hashCode, toString

Method Detail

getFirstName

public java.lang.String getFirstName()

Gets first user name

Returns:

String

getMiddleName

public java.lang.String getMiddleName()

Gets middle name for this BPMUser

Returns:

String

getLastName

public java.lang.String getLastName()

Gets last name for this BPMUser

Returns:

String

getWorkPhone

public java.lang.String getWorkPhone()

Gets work phone number for this BPMUser

Returns:

work phone number or null

getHomePhone

public java.lang.String getHomePhone()

Gets home phone number for this BPMUser

Returns:

home phone number or null

getMobile

public java.lang.String getMobile()

Gets mobile phone number for this BPMUser It can return null if person does not have mobile phone.

Returns:

mobile phone number or null

getFax

public java.lang.String getFax()

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

getPager

public java.lang.String getPager()

Gets pager number for this BPMUser It can return null if person does not have pager.

Returns:

pager number or null

getManager

public BPMUser getManager()
                   throws 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

getManagerName

public java.lang.String getManagerName()

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:

BPMIdentityNotFoundException - if manager is not found in system

getReportees

public java.util.List getReportees(boolean direct)
                            throws BPMIdentityException

Gets reportees for this user

Parameters:

direct - - boolean flag. If itis true method returns direct reportee, else return all direct and inderect reportee

Returns:

List of reportees, BPMUsers.

Throws:

BPMIdentityException - if error occurs

getNotificationPreferences

public java.util.List getNotificationPreferences()

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

getLanguage

public java.lang.String getLanguage()

Gets user's language preference

Returns:

language preference

getCountry

public java.lang.String getCountry()

Gets user's location, country

Returns:

country

getLocale

public java.util.Locale getLocale()

Gets user's preferred java locale

Returns:

Locale

getTimeZone

public java.util.TimeZone getTimeZone()

Gets user's time zone

Returns:

time zone

getTitle

public java.lang.String getTitle()

Gets user's title

Returns:

title

getManagementChain

public 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

public 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

Returns:

List of BPMUser objects which composing manager chain for this person

Throws:

BPMIdentityException - if error occurs

getManagementChain

public 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

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

public 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

Parameters:

upToUser -

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

public 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

upToManagerName - a manager name

upToTitle - a manager title

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

toNode

public org.w3c.dom.Node toNode()

Create a DOM Node from the BPMUser object

Returns:

Node DOM Node representing the BPMUser