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
Interface WCUserProfile

All Known Implementing Classes:
WCUserProfileWrapper

public interface WCUserProfile

Nested Class Summary
static class WCUserProfile.PhotoSize
           

 

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 all the reportees of 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)
           

 

Method Detail

getID

java.lang.String getID()
                       throws ProfileException
Throws:
ProfileException

getGuid

java.lang.String getGuid()
                         throws ProfileException
Throws:
ProfileException

getUserName

java.lang.String getUserName()
                             throws ProfileException
Throws:
ProfileException

getManager

java.lang.String getManager()
                            throws ProfileException
Returns:
the user ID of the manager for this user.
Throws:
ProfileException

getManagerDisplayName

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.
Returns:
the Display name of the manager for this user.
Throws:
ProfileException

getEmployeeNumber

java.lang.String getEmployeeNumber()
                                   throws ProfileException
Throws:
ProfileException

getBusinessPOBox

java.lang.String getBusinessPOBox()
                                  throws ProfileException
Throws:
ProfileException

getTimeZone

java.lang.String getTimeZone()
                             throws ProfileException
Throws:
ProfileException

getTimeZoneAsObject

java.util.TimeZone getTimeZoneAsObject()
                                       throws ProfileException
Throws:
ProfileException

getDescription

java.lang.String getDescription()
                                throws ProfileException
Throws:
ProfileException

getDepartment

java.lang.String getDepartment()
                               throws ProfileException
Throws:
ProfileException

getBusinessPager

java.lang.String getBusinessPager()
                                  throws ProfileException
Throws:
ProfileException

getBusinessCity

java.lang.String getBusinessCity()
                                 throws ProfileException
Throws:
ProfileException

getMaidenName

java.lang.String getMaidenName()
                               throws ProfileException
Throws:
ProfileException

getBusinessFax

java.lang.String getBusinessFax()
                                throws ProfileException
Throws:
ProfileException

getDateofHire

java.lang.String getDateofHire()
                               throws ProfileException
Throws:
ProfileException

getNameSuffix

java.lang.String getNameSuffix()
                               throws ProfileException
Throws:
ProfileException

getMiddleName

java.lang.String getMiddleName()
                               throws ProfileException
Throws:
ProfileException

getHomePhone

java.lang.String getHomePhone()
                              throws ProfileException
Throws:
ProfileException

getEmployeeType

java.lang.String getEmployeeType()
                                 throws ProfileException
Throws:
ProfileException

getLastName

java.lang.String getLastName()
                             throws ProfileException
Throws:
ProfileException

getDateofBirth

java.lang.String getDateofBirth()
                                throws ProfileException
Throws:
ProfileException

getBusinessState

java.lang.String getBusinessState()
                                  throws ProfileException
Throws:
ProfileException

getHomeAddress

java.lang.String getHomeAddress()
                                throws ProfileException
Throws:
ProfileException

getBusinessStreet

java.lang.String getBusinessStreet()
                                   throws ProfileException
Throws:
ProfileException

getBusinessPostalCode

java.lang.String getBusinessPostalCode()
                                       throws ProfileException
Throws:
ProfileException

getInitials

java.lang.String getInitials()
                             throws ProfileException
Throws:
ProfileException

getFirstName

java.lang.String getFirstName()
                              throws ProfileException
Throws:
ProfileException

getDefaultGroup

java.lang.String getDefaultGroup()
                                 throws ProfileException
Throws:
ProfileException

getOrganizationalUnit

java.lang.String getOrganizationalUnit()
                                       throws ProfileException
Throws:
ProfileException

getWirelessAcctNumber

java.lang.String getWirelessAcctNumber()
                                       throws ProfileException
Throws:
ProfileException

getBusinessPhone

java.lang.String getBusinessPhone()
                                  throws ProfileException
Throws:
ProfileException

getBusinessCountry

java.lang.String getBusinessCountry()
                                    throws ProfileException
Throws:
ProfileException

getPreferredLanguage

java.lang.String getPreferredLanguage()
                                      throws ProfileException
Throws:
ProfileException

getDisplayName

java.lang.String getDisplayName()
                                throws ProfileException
Throws:
ProfileException

getName

java.lang.String getName()
                         throws ProfileException
Throws:
ProfileException

getTitle

java.lang.String getTitle()
                          throws ProfileException
Throws:
ProfileException

getBusinessEmail

java.lang.String getBusinessEmail()
                                  throws ProfileException
Throws:
ProfileException

getOrganization

java.lang.String getOrganization()
                                 throws ProfileException
Throws:
ProfileException

getBusinessMobile

java.lang.String getBusinessMobile()
                                   throws ProfileException
Throws:
ProfileException

getExpertise

java.lang.String getExpertise()
                              throws ProfileException
Throws:
ProfileException

getUpdateDate

java.sql.Timestamp getUpdateDate()
                                 throws ProfileException
Throws:
ProfileException

getLocalizedDisplayNames

java.util.Map<java.lang.String,java.lang.String> getLocalizedDisplayNames()
                                                                          throws ProfileException
Returns all the display names of the user in various locales.
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

getReportees

java.util.List<java.lang.String> getReportees()
                                              throws ProfileException
Returns:
a list of the reportee user IDs for this user.
Throws:
ProfileException

getReporteeDisplayNames

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.
Returns:
a list of the reportee user names for this user.
Throws:
ProfileException

getReporteeList

java.util.List<Reportee> getReporteeList()
                                         throws ProfileException
This method returns a list of the reportee this user.
Returns:
a list of the reportee for this user.
Throws:
ProfileException

getReporteeProfiles

java.util.List<WCUserProfile> getReporteeProfiles()
                                                  throws ProfileException
Returns the profiles of all the reportees of this user.
Returns:
- list of reportee's profiles for this user.
Throws:
ProfileException

getPersonalStatusNote

java.lang.String getPersonalStatusNote()
                                       throws ProfileException
Throws:
ProfileException

setPersonalStatusNote

void setPersonalStatusNote(java.lang.String note)
                           throws ProfileException
Throws:
ProfileException

setExpertise

void setExpertise(java.lang.String expertise)
                  throws ProfileException
Throws:
ProfileException

setHomePhone

void setHomePhone(java.lang.String homePhone)

setHomeAddress

void setHomeAddress(java.lang.String homeAddress)

setDescription

void setDescription(java.lang.String aboutMe)

setManager

void setManager(java.lang.String manager)

setEmployeeNumber

void setEmployeeNumber(java.lang.String empNo)

setBusinessPOBox

void setBusinessPOBox(java.lang.String poBox)

setTimeZone

void setTimeZone(java.lang.String tz)

setDepartment

void setDepartment(java.lang.String dept)

setBusinessPager

void setBusinessPager(java.lang.String busPager)

setBusinessCity

void setBusinessCity(java.lang.String busCity)

setMaidenName

void setMaidenName(java.lang.String maidenName)

setBusinessFax

void setBusinessFax(java.lang.String busFax)

setDateofHire

void setDateofHire(java.lang.String doh)

setNameSuffix

void setNameSuffix(java.lang.String nameSuf)

setMiddleName

void setMiddleName(java.lang.String midName)

setEmployeeType

void setEmployeeType(java.lang.String empType)

setLastName

void setLastName(java.lang.String lastName)

setDateofBirth

void setDateofBirth(java.lang.String dob)

setBusinessState

void setBusinessState(java.lang.String busState)

setBusinessStreet

void setBusinessStreet(java.lang.String busStreet)

setBusinessPostalCode

void setBusinessPostalCode(java.lang.String poCode)

setInitials

void setInitials(java.lang.String initals)

setFirstName

void setFirstName(java.lang.String firstName)

setDefaultGroup

void setDefaultGroup(java.lang.String defGrp)

setOrganizationalUnit

void setOrganizationalUnit(java.lang.String orgUnit)

setWirelessAcctNumber

void setWirelessAcctNumber(java.lang.String wirelessActNo)

setBusinessPhone

void setBusinessPhone(java.lang.String busPhone)

setBusinessCountry

void setBusinessCountry(java.lang.String busCountry)

setPreferredLanguage

void setPreferredLanguage(java.lang.String prefLang)

setDisplayName

void setDisplayName(java.lang.String dispName)

setName

void setName(java.lang.String name)

setTitle

void setTitle(java.lang.String title)

setBusinessEmail

void setBusinessEmail(java.lang.String email)

setOrganization

void setOrganization(java.lang.String org)

setBusinessMobile

void setBusinessMobile(java.lang.String busMobile)

save

void save()
          throws ProfileException
Throws:
ProfileException

getPhoto

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

byte[] getOriginalPhoto()
                        throws ProfileException
Method to return the 'original' (unscaled) photo of the user.
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:
setJPEGPhoto(java.lang.String)

setJPEGPhoto

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

void invalidatePhotoCache()
                          throws ProfileException
Invalidates any photo images that may have been cached for this user profile.
Throws:
ProfileException - if any error occurs while clearing the cache.

updatePhoto

void updatePhoto(byte[] photo)
                 throws ProfileException
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 getOriginalPhoto() if it determines that photo in the consumer backend has changed since the last time getOriginalPhoto() for this user.

Throws:
ProfileException - if any error occurs in the above process

getPhotoUID

java.lang.String getPhotoUID()
                             throws ProfileException
Returns an identifier for the photo, that is guaranteed to be unique for this user profile.
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

java.lang.String getBusinessLocationMapURL()
                                           throws ProfileException
Throws:
ProfileException

writeVCardTo

void writeVCardTo(java.io.OutputStream out)
                  throws ProfileException
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.