Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.7.0)
E15995-06


oracle.webcenter.peopleconnections.profile
Class WCUserProfileWrapper

java.lang.Object
  extended by oracle.webcenter.peopleconnections.profile.WCUserProfileWrapper

All Implemented Interfaces:
WCUserProfile

public class WCUserProfileWrapper
extends java.lang.Object
implements WCUserProfile

Nested Class Summary

 

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

 

Constructor Summary
WCUserProfileWrapper(WCUserProfile userProfile)
           

 

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

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

WCUserProfileWrapper

public WCUserProfileWrapper(WCUserProfile userProfile)

Method Detail

getID

public java.lang.String getID()
                       throws ProfileException
Specified by:
getID in interface WCUserProfile
Throws:
ProfileException

getGuid

public java.lang.String getGuid()
                         throws ProfileException
Specified by:
getGuid in interface WCUserProfile
Throws:
ProfileException

getUserName

public java.lang.String getUserName()
                             throws ProfileException
Specified by:
getUserName in interface WCUserProfile
Throws:
ProfileException

getUpdateDate

public java.sql.Timestamp getUpdateDate()
                                 throws ProfileException
Specified by:
getUpdateDate in interface WCUserProfile
Throws:
ProfileException

getManager

public java.lang.String getManager()
                            throws ProfileException
Specified by:
getManager in interface WCUserProfile
Returns:
the user ID of the manager for this user.
Throws:
ProfileException

getManagerDisplayName

public java.lang.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 java.lang.String getEmployeeNumber()
                                   throws ProfileException
Specified by:
getEmployeeNumber in interface WCUserProfile
Throws:
ProfileException

getBusinessPOBox

public java.lang.String getBusinessPOBox()
                                  throws ProfileException
Specified by:
getBusinessPOBox in interface WCUserProfile
Throws:
ProfileException

getTimeZone

public java.lang.String getTimeZone()
                             throws ProfileException
Specified by:
getTimeZone in interface WCUserProfile
Throws:
ProfileException

getTimeZoneAsObject

public java.util.TimeZone getTimeZoneAsObject()
                                       throws ProfileException
Specified by:
getTimeZoneAsObject in interface WCUserProfile
Throws:
ProfileException

getDescription

public java.lang.String getDescription()
                                throws ProfileException
Specified by:
getDescription in interface WCUserProfile
Throws:
ProfileException

getDepartment

public java.lang.String getDepartment()
                               throws ProfileException
Specified by:
getDepartment in interface WCUserProfile
Throws:
ProfileException

getBusinessPager

public java.lang.String getBusinessPager()
                                  throws ProfileException
Specified by:
getBusinessPager in interface WCUserProfile
Throws:
ProfileException

getBusinessCity

public java.lang.String getBusinessCity()
                                 throws ProfileException
Specified by:
getBusinessCity in interface WCUserProfile
Throws:
ProfileException

getMaidenName

public java.lang.String getMaidenName()
                               throws ProfileException
Specified by:
getMaidenName in interface WCUserProfile
Throws:
ProfileException

getBusinessFax

public java.lang.String getBusinessFax()
                                throws ProfileException
Specified by:
getBusinessFax in interface WCUserProfile
Throws:
ProfileException

getDateofHire

public java.lang.String getDateofHire()
                               throws ProfileException
Specified by:
getDateofHire in interface WCUserProfile
Throws:
ProfileException

getNameSuffix

public java.lang.String getNameSuffix()
                               throws ProfileException
Specified by:
getNameSuffix in interface WCUserProfile
Throws:
ProfileException

getMiddleName

public java.lang.String getMiddleName()
                               throws ProfileException
Specified by:
getMiddleName in interface WCUserProfile
Throws:
ProfileException

getHomePhone

public java.lang.String getHomePhone()
                              throws ProfileException
Specified by:
getHomePhone in interface WCUserProfile
Throws:
ProfileException

getEmployeeType

public java.lang.String getEmployeeType()
                                 throws ProfileException
Specified by:
getEmployeeType in interface WCUserProfile
Throws:
ProfileException

getLastName

public java.lang.String getLastName()
                             throws ProfileException
Specified by:
getLastName in interface WCUserProfile
Throws:
ProfileException

getDateofBirth

public java.lang.String getDateofBirth()
                                throws ProfileException
Specified by:
getDateofBirth in interface WCUserProfile
Throws:
ProfileException

getBusinessState

public java.lang.String getBusinessState()
                                  throws ProfileException
Specified by:
getBusinessState in interface WCUserProfile
Throws:
ProfileException

getHomeAddress

public java.lang.String getHomeAddress()
                                throws ProfileException
Specified by:
getHomeAddress in interface WCUserProfile
Throws:
ProfileException

getBusinessStreet

public java.lang.String getBusinessStreet()
                                   throws ProfileException
Specified by:
getBusinessStreet in interface WCUserProfile
Throws:
ProfileException

getBusinessPostalCode

public java.lang.String getBusinessPostalCode()
                                       throws ProfileException
Specified by:
getBusinessPostalCode in interface WCUserProfile
Throws:
ProfileException

getInitials

public java.lang.String getInitials()
                             throws ProfileException
Specified by:
getInitials in interface WCUserProfile
Throws:
ProfileException

getFirstName

public java.lang.String getFirstName()
                              throws ProfileException
Specified by:
getFirstName in interface WCUserProfile
Throws:
ProfileException

getDefaultGroup

public java.lang.String getDefaultGroup()
                                 throws ProfileException
Specified by:
getDefaultGroup in interface WCUserProfile
Throws:
ProfileException

getOrganizationalUnit

public java.lang.String getOrganizationalUnit()
                                       throws ProfileException
Specified by:
getOrganizationalUnit in interface WCUserProfile
Throws:
ProfileException

getWirelessAcctNumber

public java.lang.String getWirelessAcctNumber()
                                       throws ProfileException
Specified by:
getWirelessAcctNumber in interface WCUserProfile
Throws:
ProfileException

getBusinessPhone

public java.lang.String getBusinessPhone()
                                  throws ProfileException
Specified by:
getBusinessPhone in interface WCUserProfile
Throws:
ProfileException

getBusinessCountry

public java.lang.String getBusinessCountry()
                                    throws ProfileException
Specified by:
getBusinessCountry in interface WCUserProfile
Throws:
ProfileException

getPreferredLanguage

public java.lang.String getPreferredLanguage()
                                      throws ProfileException
Specified by:
getPreferredLanguage in interface WCUserProfile
Throws:
ProfileException

getDisplayName

public java.lang.String getDisplayName()
                                throws ProfileException
Specified by:
getDisplayName in interface WCUserProfile
Throws:
ProfileException

getLocalizedDisplayNames

public java.util.Map<java.lang.String,java.lang.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 java.lang.String getName()
                         throws ProfileException
Specified by:
getName in interface WCUserProfile
Throws:
ProfileException

getTitle

public java.lang.String getTitle()
                          throws ProfileException
Specified by:
getTitle in interface WCUserProfile
Throws:
ProfileException

getBusinessEmail

public java.lang.String getBusinessEmail()
                                  throws ProfileException
Specified by:
getBusinessEmail in interface WCUserProfile
Throws:
ProfileException

getOrganization

public java.lang.String getOrganization()
                                 throws ProfileException
Specified by:
getOrganization in interface WCUserProfile
Throws:
ProfileException

getBusinessMobile

public java.lang.String getBusinessMobile()
                                   throws ProfileException
Specified by:
getBusinessMobile in interface WCUserProfile
Throws:
ProfileException

getExpertise

public java.lang.String getExpertise()
                              throws ProfileException
Specified by:
getExpertise in interface WCUserProfile
Throws:
ProfileException

getReportees

public java.util.List<java.lang.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 java.util.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 java.util.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 java.util.List<java.lang.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 java.lang.String getPersonalStatusNote()
                                       throws ProfileException
Specified by:
getPersonalStatusNote in interface WCUserProfile
Throws:
ProfileException

setPersonalStatusNote

public void setPersonalStatusNote(java.lang.String note)
                           throws ProfileException
Specified by:
setPersonalStatusNote in interface WCUserProfile
Throws:
ProfileException

setExpertise

public void setExpertise(java.lang.String expertise)
                  throws ProfileException
Specified by:
setExpertise in interface WCUserProfile
Throws:
ProfileException

setHomePhone

public void setHomePhone(java.lang.String homePhone)
Specified by:
setHomePhone in interface WCUserProfile

setHomeAddress

public void setHomeAddress(java.lang.String homeAddress)
Specified by:
setHomeAddress in interface WCUserProfile

setDescription

public void setDescription(java.lang.String aboutMe)
Specified by:
setDescription in interface WCUserProfile

setManager

public void setManager(java.lang.String manager)
Specified by:
setManager in interface WCUserProfile

setEmployeeNumber

public void setEmployeeNumber(java.lang.String empNo)
Specified by:
setEmployeeNumber in interface WCUserProfile

setBusinessPOBox

public void setBusinessPOBox(java.lang.String poBox)
Specified by:
setBusinessPOBox in interface WCUserProfile

setTimeZone

public void setTimeZone(java.lang.String tz)
Specified by:
setTimeZone in interface WCUserProfile

setDepartment

public void setDepartment(java.lang.String dept)
Specified by:
setDepartment in interface WCUserProfile

setBusinessPager

public void setBusinessPager(java.lang.String busPager)
Specified by:
setBusinessPager in interface WCUserProfile

setBusinessCity

public void setBusinessCity(java.lang.String busCity)
Specified by:
setBusinessCity in interface WCUserProfile

setMaidenName

public void setMaidenName(java.lang.String maidenName)
Specified by:
setMaidenName in interface WCUserProfile

setBusinessFax

public void setBusinessFax(java.lang.String busFax)
Specified by:
setBusinessFax in interface WCUserProfile

setDateofHire

public void setDateofHire(java.lang.String doh)
Specified by:
setDateofHire in interface WCUserProfile

setNameSuffix

public void setNameSuffix(java.lang.String nameSuf)
Specified by:
setNameSuffix in interface WCUserProfile

setMiddleName

public void setMiddleName(java.lang.String midName)
Specified by:
setMiddleName in interface WCUserProfile

setEmployeeType

public void setEmployeeType(java.lang.String empType)
Specified by:
setEmployeeType in interface WCUserProfile

setLastName

public void setLastName(java.lang.String lastName)
Specified by:
setLastName in interface WCUserProfile

setDateofBirth

public void setDateofBirth(java.lang.String dob)
Specified by:
setDateofBirth in interface WCUserProfile

setBusinessState

public void setBusinessState(java.lang.String busState)
Specified by:
setBusinessState in interface WCUserProfile

setBusinessStreet

public void setBusinessStreet(java.lang.String busStreet)
Specified by:
setBusinessStreet in interface WCUserProfile

setBusinessPostalCode

public void setBusinessPostalCode(java.lang.String poCode)
Specified by:
setBusinessPostalCode in interface WCUserProfile

setInitials

public void setInitials(java.lang.String initals)
Specified by:
setInitials in interface WCUserProfile

setFirstName

public void setFirstName(java.lang.String firstName)
Specified by:
setFirstName in interface WCUserProfile

setDefaultGroup

public void setDefaultGroup(java.lang.String defGrp)
Specified by:
setDefaultGroup in interface WCUserProfile

setOrganizationalUnit

public void setOrganizationalUnit(java.lang.String orgUnit)
Specified by:
setOrganizationalUnit in interface WCUserProfile

setWirelessAcctNumber

public void setWirelessAcctNumber(java.lang.String wirelessActNo)
Specified by:
setWirelessAcctNumber in interface WCUserProfile

setBusinessPhone

public void setBusinessPhone(java.lang.String busPhone)
Specified by:
setBusinessPhone in interface WCUserProfile

setBusinessCountry

public void setBusinessCountry(java.lang.String busCountry)
Specified by:
setBusinessCountry in interface WCUserProfile

setPreferredLanguage

public void setPreferredLanguage(java.lang.String prefLang)
Specified by:
setPreferredLanguage in interface WCUserProfile

setDisplayName

public void setDisplayName(java.lang.String dispName)
Specified by:
setDisplayName in interface WCUserProfile

setName

public void setName(java.lang.String name)
Specified by:
setName in interface WCUserProfile

setTitle

public void setTitle(java.lang.String title)
Specified by:
setTitle in interface WCUserProfile

setBusinessEmail

public void setBusinessEmail(java.lang.String email)
Specified by:
setBusinessEmail in interface WCUserProfile

setOrganization

public void setOrganization(java.lang.String org)
Specified by:
setOrganization in interface WCUserProfile

setBusinessMobile

public void setBusinessMobile(java.lang.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(java.lang.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 java.lang.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 java.lang.String getBusinessLocationMapURL()
                                           throws ProfileException
Specified by:
getBusinessLocationMapURL in interface WCUserProfile
Throws:
ProfileException

writeVCardTo

public void writeVCardTo(java.io.OutputStream out)
                  throws ProfileException
Specified by:
writeVCardTo in interface WCUserProfile
Throws:
ProfileException

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.7.0)
E15995-06


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