Package oracle.webcenter.peopleconnections.profile

Class WCUserProfileWrapper

java.lang.Object

oracle.webcenter.peopleconnections.profile.WCUserProfileWrapper

All Implemented Interfaces:

WCUserProfile

@Exported
public class WCUserProfileWrapper
extends Object
implements WCUserProfile

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.webcenter.peopleconnections.profile.WCUserProfile

WCUserProfile.PhotoSize

Constructor Summary

Constructors

Constructor	Description
WCUserProfileWrapper(WCUserProfile userProfile)

Method Summary

Modifier and Type	Method	Description
String	getBusinessCity()
String	getBusinessCountry()
String	getBusinessEmail()
String	getBusinessFax()
String	getBusinessLocationMapURL()
String	getBusinessMobile()
String	getBusinessPager()
String	getBusinessPhone()
String	getBusinessPOBox()
String	getBusinessPostalCode()
String	getBusinessState()
String	getBusinessStreet()
String	getDateofBirth()
String	getDateofHire()
String	getDefaultGroup()
String	getDepartment()
String	getDescription()
String	getDisplayName()
String	getEmployeeNumber()
String	getEmployeeType()
String	getExpertise()
String	getFirstName()
String	getGuid()
String	getHomeAddress()
String	getHomePhone()
String	getID()
String	getInitials()
String	getLastName()
Map<String,String>	getLocalizedDisplayNames()	Returns all the display names of the user in various locales.
String	getMaidenName()
String	getManager()
String	getManagerDisplayName()	Returns the Display Name of the manager for this user, if the Display Name is available.
String	getMiddleName()
String	getName()
String	getNameSuffix()
String	getOrganization()
String	getOrganizationalUnit()
byte[]	getOriginalPhoto()	Method to return the 'original' (unscaled) photo of the user.
String	getPersonalStatusNote()
byte[]	getPhoto(WCUserProfile.PhotoSize size)	Returns a photo of specified size for this user profile, looking it up in a system cache if possible.
String	getPhotoUID()	Returns an identifier for the photo, that is guaranteed to be unique for this user profile.
String	getPreferredLanguage()
List<String>	getReporteeDisplayNames()	This method returns a list of the reportee user names for this user.
List<Reportee>	getReporteeList()	This method returns a list of the reportee this user.
List<WCUserProfile>	getReporteeProfiles()	Returns the profiles of the reportees for this user.
List<String>	getReportees()
String	getTimeZone()
TimeZone	getTimeZoneAsObject()
String	getTitle()
Timestamp	getUpdateDate()
String	getUserName()
String	getWirelessAcctNumber()
void	invalidatePhotoCache()	Invalidates any photo images that may have been cached for this user profile.
void	save()
void	setBusinessCity(String busCity)
void	setBusinessCountry(String busCountry)
void	setBusinessEmail(String email)
void	setBusinessFax(String busFax)
void	setBusinessMobile(String busMobile)
void	setBusinessPager(String busPager)
void	setBusinessPhone(String busPhone)
void	setBusinessPOBox(String poBox)
void	setBusinessPostalCode(String poCode)
void	setBusinessState(String busState)
void	setBusinessStreet(String busStreet)
void	setDateofBirth(String dob)
void	setDateofHire(String doh)
void	setDefaultGroup(String defGrp)
void	setDepartment(String dept)
void	setDescription(String aboutMe)
void	setDisplayName(String dispName)
void	setEmployeeNumber(String empNo)
void	setEmployeeType(String empType)
void	setExpertise(String expertise)
void	setFirstName(String firstName)
void	setHomeAddress(String homeAddress)
void	setHomePhone(String homePhone)
void	setInitials(String initals)
void	setJPEGPhoto(String imagePath)	Stores a specified image into this user profile to serve as the 'original' (unscaled) photo for the user.
void	setLastName(String lastName)
void	setMaidenName(String maidenName)
void	setManager(String manager)
void	setMiddleName(String midName)
void	setName(String name)
void	setNameSuffix(String nameSuf)
void	setOrganization(String org)
void	setOrganizationalUnit(String orgUnit)
void	setPersonalStatusNote(String note)
void	setPreferredLanguage(String prefLang)
void	setTimeZone(String tz)
void	setTitle(String title)
void	setWirelessAcctNumber(String wirelessActNo)
void	updatePhoto(byte[] photo)	Clears the original photo that might have been stored in the application for this user profile, updates it with the specified image, and invalidates all cached images for this user profile.
void	writeVCardTo(OutputStream out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WCUserProfileWrapper

public WCUserProfileWrapper(WCUserProfile userProfile)

Method Details

getID

public String getID()
             throws ProfileException

Specified by:

getID in interface WCUserProfile

Throws:

ProfileException

getGuid

public String getGuid()
               throws ProfileException

Specified by:

getGuid in interface WCUserProfile

Throws:

ProfileException

getUserName

public String getUserName()
                   throws ProfileException

Specified by:

getUserName in interface WCUserProfile

Throws:

ProfileException

getUpdateDate

public Timestamp getUpdateDate()
                        throws ProfileException

Specified by:

getUpdateDate in interface WCUserProfile

Throws:

ProfileException

getManager

public String getManager()
                  throws ProfileException

Specified by:

getManager in interface WCUserProfile

Returns:

the user ID of the manager for this user.

Throws:

ProfileException

getManagerDisplayName

public String getManagerDisplayName()
                             throws ProfileException

Returns the Display Name of the manager for this user, if the Display Name is available. Otherwise it will return the user ID.

Specified by:

getManagerDisplayName in interface WCUserProfile

Returns:

the Display name of the manager for this user.

Throws:

ProfileException

getEmployeeNumber

public String getEmployeeNumber()
                         throws ProfileException

Specified by:

getEmployeeNumber in interface WCUserProfile

Throws:

ProfileException

getBusinessPOBox

public String getBusinessPOBox()
                        throws ProfileException

Specified by:

getBusinessPOBox in interface WCUserProfile

Throws:

ProfileException

getTimeZone

public String getTimeZone()
                   throws ProfileException

Specified by:

getTimeZone in interface WCUserProfile

Throws:

ProfileException

getTimeZoneAsObject

public TimeZone getTimeZoneAsObject()
                             throws ProfileException

Specified by:

getTimeZoneAsObject in interface WCUserProfile

Throws:

ProfileException

getDescription

public String getDescription()
                      throws ProfileException

Specified by:

getDescription in interface WCUserProfile

Throws:

ProfileException

getDepartment

public String getDepartment()
                     throws ProfileException

Specified by:

getDepartment in interface WCUserProfile

Throws:

ProfileException

getBusinessPager

public String getBusinessPager()
                        throws ProfileException

Specified by:

getBusinessPager in interface WCUserProfile

Throws:

ProfileException

getBusinessCity

public String getBusinessCity()
                       throws ProfileException

Specified by:

getBusinessCity in interface WCUserProfile

Throws:

ProfileException

getMaidenName

public String getMaidenName()
                     throws ProfileException

Specified by:

getMaidenName in interface WCUserProfile

Throws:

ProfileException

getBusinessFax

public String getBusinessFax()
                      throws ProfileException

Specified by:

getBusinessFax in interface WCUserProfile

Throws:

ProfileException

getDateofHire

public String getDateofHire()
                     throws ProfileException

Specified by:

getDateofHire in interface WCUserProfile

Throws:

ProfileException

getNameSuffix

public String getNameSuffix()
                     throws ProfileException

Specified by:

getNameSuffix in interface WCUserProfile

Throws:

ProfileException

getMiddleName

public String getMiddleName()
                     throws ProfileException

Specified by:

getMiddleName in interface WCUserProfile

Throws:

ProfileException

getHomePhone

public String getHomePhone()
                    throws ProfileException

Specified by:

getHomePhone in interface WCUserProfile

Throws:

ProfileException

getEmployeeType

public String getEmployeeType()
                       throws ProfileException

Specified by:

getEmployeeType in interface WCUserProfile

Throws:

ProfileException

getLastName

public String getLastName()
                   throws ProfileException

Specified by:

getLastName in interface WCUserProfile

Throws:

ProfileException

getDateofBirth

public String getDateofBirth()
                      throws ProfileException

Specified by:

getDateofBirth in interface WCUserProfile

Throws:

ProfileException

getBusinessState

public String getBusinessState()
                        throws ProfileException

Specified by:

getBusinessState in interface WCUserProfile

Throws:

ProfileException

getHomeAddress

public String getHomeAddress()
                      throws ProfileException

Specified by:

getHomeAddress in interface WCUserProfile

Throws:

ProfileException

getBusinessStreet

public String getBusinessStreet()
                         throws ProfileException

Specified by:

getBusinessStreet in interface WCUserProfile

Throws:

ProfileException

getBusinessPostalCode

public String getBusinessPostalCode()
                             throws ProfileException

Specified by:

getBusinessPostalCode in interface WCUserProfile

Throws:

ProfileException

getInitials

public String getInitials()
                   throws ProfileException

Specified by:

getInitials in interface WCUserProfile

Throws:

ProfileException

getFirstName

public String getFirstName()
                    throws ProfileException

Specified by:

getFirstName in interface WCUserProfile

Throws:

ProfileException

getDefaultGroup

public String getDefaultGroup()
                       throws ProfileException

Specified by:

getDefaultGroup in interface WCUserProfile

Throws:

ProfileException

getOrganizationalUnit

public String getOrganizationalUnit()
                             throws ProfileException

Specified by:

getOrganizationalUnit in interface WCUserProfile

Throws:

ProfileException

getWirelessAcctNumber

public String getWirelessAcctNumber()
                             throws ProfileException

Specified by:

getWirelessAcctNumber in interface WCUserProfile

Throws:

ProfileException

getBusinessPhone

public String getBusinessPhone()
                        throws ProfileException

Specified by:

getBusinessPhone in interface WCUserProfile

Throws:

ProfileException

getBusinessCountry

public String getBusinessCountry()
                          throws ProfileException

Specified by:

getBusinessCountry in interface WCUserProfile

Throws:

ProfileException

getPreferredLanguage

public String getPreferredLanguage()
                            throws ProfileException

Specified by:

getPreferredLanguage in interface WCUserProfile

Throws:

ProfileException

getDisplayName

public String getDisplayName()
                      throws ProfileException

Specified by:

getDisplayName in interface WCUserProfile

Throws:

ProfileException

getLocalizedDisplayNames

public Map<String,String> getLocalizedDisplayNames()
                                            throws ProfileException

Description copied from interface: WCUserProfile

Returns all the display names of the user in various locales.

Specified by:

getLocalizedDisplayNames in interface WCUserProfile

Returns:

Map of display names of the user keyed by locale (and with key "*" pointing to the default, non-locale-specific, display name).

Throws:

ProfileException - if any problem occurs retrieving the display names

getName

public String getName()
               throws ProfileException

Specified by:

getName in interface WCUserProfile

Throws:

ProfileException

getTitle

public String getTitle()
                throws ProfileException

Specified by:

getTitle in interface WCUserProfile

Throws:

ProfileException

getBusinessEmail

public String getBusinessEmail()
                        throws ProfileException

Specified by:

getBusinessEmail in interface WCUserProfile

Throws:

ProfileException

getOrganization

public String getOrganization()
                       throws ProfileException

Specified by:

getOrganization in interface WCUserProfile

Throws:

ProfileException

getBusinessMobile

public String getBusinessMobile()
                         throws ProfileException

Specified by:

getBusinessMobile in interface WCUserProfile

Throws:

ProfileException

getExpertise

public String getExpertise()
                    throws ProfileException

Specified by:

getExpertise in interface WCUserProfile

Throws:

ProfileException

getReportees

public List<String> getReportees()
                          throws ProfileException

Specified by:

getReportees in interface WCUserProfile

Returns:

a list of the reportee user IDs for this user.

Throws:

ProfileException

getReporteeList

public List<Reportee> getReporteeList()
                               throws ProfileException

Description copied from interface: WCUserProfile

This method returns a list of the reportee this user.

Specified by:

getReporteeList in interface WCUserProfile

Returns:

a list of the reportee for this user.

Throws:

ProfileException

getReporteeProfiles

public List<WCUserProfile> getReporteeProfiles()
                                        throws ProfileException

Returns the profiles of the reportees for this user.

Specified by:

getReporteeProfiles in interface WCUserProfile

Returns:

- list of reportee profiles for this user

Throws:

ProfileException

getReporteeDisplayNames

public List<String> getReporteeDisplayNames()
                                     throws ProfileException

This method returns a list of the reportee user names for this user. If the reportees have Display Names, those will be used. If not, the user ID will be returned.

Specified by:

getReporteeDisplayNames in interface WCUserProfile

Returns:

a list of the reportee user names for this user.

Throws:

ProfileException

getPersonalStatusNote

public String getPersonalStatusNote()
                             throws ProfileException

Specified by:

getPersonalStatusNote in interface WCUserProfile

Throws:

ProfileException

setPersonalStatusNote

public void setPersonalStatusNote(String note)
                           throws ProfileException

Specified by:

setPersonalStatusNote in interface WCUserProfile

Throws:

ProfileException

setExpertise

public void setExpertise(String expertise)
                  throws ProfileException

Specified by:

setExpertise in interface WCUserProfile

Throws:

ProfileException

setHomePhone

public void setHomePhone(String homePhone)

Specified by:

setHomePhone in interface WCUserProfile

setHomeAddress

public void setHomeAddress(String homeAddress)

Specified by:

setHomeAddress in interface WCUserProfile

setDescription

public void setDescription(String aboutMe)

Specified by:

setDescription in interface WCUserProfile

setManager

public void setManager(String manager)

Specified by:

setManager in interface WCUserProfile

setEmployeeNumber

public void setEmployeeNumber(String empNo)

Specified by:

setEmployeeNumber in interface WCUserProfile

setBusinessPOBox

public void setBusinessPOBox(String poBox)

Specified by:

setBusinessPOBox in interface WCUserProfile

setTimeZone

public void setTimeZone(String tz)

Specified by:

setTimeZone in interface WCUserProfile

setDepartment

public void setDepartment(String dept)

Specified by:

setDepartment in interface WCUserProfile

setBusinessPager

public void setBusinessPager(String busPager)

Specified by:

setBusinessPager in interface WCUserProfile

setBusinessCity

public void setBusinessCity(String busCity)

Specified by:

setBusinessCity in interface WCUserProfile

setMaidenName

public void setMaidenName(String maidenName)

Specified by:

setMaidenName in interface WCUserProfile

setBusinessFax

public void setBusinessFax(String busFax)

Specified by:

setBusinessFax in interface WCUserProfile

setDateofHire

public void setDateofHire(String doh)

Specified by:

setDateofHire in interface WCUserProfile

setNameSuffix

public void setNameSuffix(String nameSuf)

Specified by:

setNameSuffix in interface WCUserProfile

setMiddleName

public void setMiddleName(String midName)

Specified by:

setMiddleName in interface WCUserProfile

setEmployeeType

public void setEmployeeType(String empType)

Specified by:

setEmployeeType in interface WCUserProfile

setLastName

public void setLastName(String lastName)

Specified by:

setLastName in interface WCUserProfile

setDateofBirth

public void setDateofBirth(String dob)

Specified by:

setDateofBirth in interface WCUserProfile

setBusinessState

public void setBusinessState(String busState)

Specified by:

setBusinessState in interface WCUserProfile

setBusinessStreet

public void setBusinessStreet(String busStreet)

Specified by:

setBusinessStreet in interface WCUserProfile

setBusinessPostalCode

public void setBusinessPostalCode(String poCode)

Specified by:

setBusinessPostalCode in interface WCUserProfile

setInitials

public void setInitials(String initals)

Specified by:

setInitials in interface WCUserProfile

setFirstName

public void setFirstName(String firstName)

Specified by:

setFirstName in interface WCUserProfile

setDefaultGroup

public void setDefaultGroup(String defGrp)

Specified by:

setDefaultGroup in interface WCUserProfile

setOrganizationalUnit

public void setOrganizationalUnit(String orgUnit)

Specified by:

setOrganizationalUnit in interface WCUserProfile

setWirelessAcctNumber

public void setWirelessAcctNumber(String wirelessActNo)

Specified by:

setWirelessAcctNumber in interface WCUserProfile

setBusinessPhone

public void setBusinessPhone(String busPhone)

Specified by:

setBusinessPhone in interface WCUserProfile

setBusinessCountry

public void setBusinessCountry(String busCountry)

Specified by:

setBusinessCountry in interface WCUserProfile

setPreferredLanguage

public void setPreferredLanguage(String prefLang)

Specified by:

setPreferredLanguage in interface WCUserProfile

setDisplayName

public void setDisplayName(String dispName)

Specified by:

setDisplayName in interface WCUserProfile

setName

public void setName(String name)

Specified by:

setName in interface WCUserProfile

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface WCUserProfile

setBusinessEmail

public void setBusinessEmail(String email)

Specified by:

setBusinessEmail in interface WCUserProfile

setOrganization

public void setOrganization(String org)

Specified by:

setOrganization in interface WCUserProfile

setBusinessMobile

public void setBusinessMobile(String busMobile)

Specified by:

setBusinessMobile in interface WCUserProfile

save

public void save()
          throws ProfileException

Specified by:

save in interface WCUserProfile

Throws:

ProfileException

getPhoto

public byte[] getPhoto(WCUserProfile.PhotoSize size)
                throws ProfileException

Returns a photo of specified size for this user profile, looking it up in a system cache if possible.

Specified by:

getPhoto in interface WCUserProfile

Parameters:

size - the size of the photo to be returned

Returns:

binary contents of an image representing a photo of the user

Throws:

ProfileException - if any error occurs while retrieving the photo

getOriginalPhoto

public byte[] getOriginalPhoto()
                        throws ProfileException

Description copied from interface: WCUserProfile

Method to return the 'original' (unscaled) photo of the user.

Specified by:

getOriginalPhoto in interface WCUserProfile

Returns:

binary contents of the image representing the unscaled photo of the user, or null if none could be found

Throws:

ProfileException - if any error occurs while retrieving the photo

See Also:

• WCUserProfile.setJPEGPhoto(java.lang.String)

setJPEGPhoto

public void setJPEGPhoto(String imagePath)
                  throws ProfileException

Stores a specified image into this user profile to serve as the 'original' (unscaled) photo for the user.

Specified by:

setJPEGPhoto in interface WCUserProfile

Parameters:

imagePath - path of an image file to be read and stored as the photo

Throws:

ProfileException - if any errors while storing the photo

invalidatePhotoCache

public void invalidatePhotoCache()
                          throws ProfileException

Invalidates any photo images that may have been cached for this user profile.

Specified by:

invalidatePhotoCache in interface WCUserProfile

Throws:

ProfileException - if any error occurs while clearing the cache.

updatePhoto

public void updatePhoto(byte[] photo)
                 throws ProfileException

Description copied from interface: WCUserProfile

Clears the original photo that might have been stored in the application for this user profile, updates it with the specified image, and invalidates all cached images for this user profile.

A typical use of this method is for sync'ing the application-stored photo for this user with whatever is stored in some other backend. For instance, a consumer can choose to call this method passing in the value returned by WCUserProfile.getOriginalPhoto() if it determines that photo in the consumer backend has changed since the last time WCUserProfile.getOriginalPhoto() for this user.

Specified by:

updatePhoto in interface WCUserProfile

Throws:

ProfileException - if any error occurs in the above process

getPhotoUID

public String getPhotoUID()
                   throws ProfileException

Returns an identifier for the photo, that is guaranteed to be unique for this user profile.

Specified by:

getPhotoUID in interface WCUserProfile

Returns:

A unique string associated with the photo, such that for a given user profile, successive calls to this method would return the same value only if the contents of the 'original' photo associated with the user profile have not changed.

Throws:

ProfileException - if any error occurs while retrieving identifier

getBusinessLocationMapURL

public String getBusinessLocationMapURL()
                                 throws ProfileException

Specified by:

getBusinessLocationMapURL in interface WCUserProfile

Throws:

ProfileException

writeVCardTo

public void writeVCardTo(OutputStream out)
                  throws ProfileException

Specified by:

writeVCardTo in interface WCUserProfile

Throws:

ProfileException