public interface WCUserProfile
Modifier and Type | Interface and Description |
---|---|
static class |
WCUserProfile.PhotoSize |
Modifier and Type | Method and Description |
---|---|
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) |
java.lang.String getID() throws ProfileException
ProfileException
java.lang.String getGuid() throws ProfileException
ProfileException
java.lang.String getUserName() throws ProfileException
ProfileException
java.lang.String getManager() throws ProfileException
ProfileException
java.lang.String getManagerDisplayName() throws ProfileException
ProfileException
java.lang.String getEmployeeNumber() throws ProfileException
ProfileException
java.lang.String getBusinessPOBox() throws ProfileException
ProfileException
java.lang.String getTimeZone() throws ProfileException
ProfileException
java.util.TimeZone getTimeZoneAsObject() throws ProfileException
ProfileException
java.lang.String getDescription() throws ProfileException
ProfileException
java.lang.String getDepartment() throws ProfileException
ProfileException
java.lang.String getBusinessPager() throws ProfileException
ProfileException
java.lang.String getBusinessCity() throws ProfileException
ProfileException
java.lang.String getMaidenName() throws ProfileException
ProfileException
java.lang.String getBusinessFax() throws ProfileException
ProfileException
java.lang.String getDateofHire() throws ProfileException
ProfileException
java.lang.String getNameSuffix() throws ProfileException
ProfileException
java.lang.String getMiddleName() throws ProfileException
ProfileException
java.lang.String getHomePhone() throws ProfileException
ProfileException
java.lang.String getEmployeeType() throws ProfileException
ProfileException
java.lang.String getLastName() throws ProfileException
ProfileException
java.lang.String getDateofBirth() throws ProfileException
ProfileException
java.lang.String getBusinessState() throws ProfileException
ProfileException
java.lang.String getHomeAddress() throws ProfileException
ProfileException
java.lang.String getBusinessStreet() throws ProfileException
ProfileException
java.lang.String getBusinessPostalCode() throws ProfileException
ProfileException
java.lang.String getInitials() throws ProfileException
ProfileException
java.lang.String getFirstName() throws ProfileException
ProfileException
java.lang.String getDefaultGroup() throws ProfileException
ProfileException
java.lang.String getOrganizationalUnit() throws ProfileException
ProfileException
java.lang.String getWirelessAcctNumber() throws ProfileException
ProfileException
java.lang.String getBusinessPhone() throws ProfileException
ProfileException
java.lang.String getBusinessCountry() throws ProfileException
ProfileException
java.lang.String getPreferredLanguage() throws ProfileException
ProfileException
java.lang.String getDisplayName() throws ProfileException
ProfileException
java.lang.String getName() throws ProfileException
ProfileException
java.lang.String getTitle() throws ProfileException
ProfileException
java.lang.String getBusinessEmail() throws ProfileException
ProfileException
java.lang.String getOrganization() throws ProfileException
ProfileException
java.lang.String getBusinessMobile() throws ProfileException
ProfileException
java.lang.String getExpertise() throws ProfileException
ProfileException
java.sql.Timestamp getUpdateDate() throws ProfileException
ProfileException
java.util.Map<java.lang.String,java.lang.String> getLocalizedDisplayNames() throws ProfileException
ProfileException
- if any problem occurs retrieving the display namesjava.util.List<java.lang.String> getReportees() throws ProfileException
ProfileException
java.util.List<java.lang.String> getReporteeDisplayNames() throws ProfileException
ProfileException
java.util.List<Reportee> getReporteeList() throws ProfileException
ProfileException
java.util.List<WCUserProfile> getReporteeProfiles() throws ProfileException
ProfileException
java.lang.String getPersonalStatusNote() throws ProfileException
ProfileException
void setPersonalStatusNote(java.lang.String note) throws ProfileException
ProfileException
void setExpertise(java.lang.String expertise) throws ProfileException
ProfileException
void setHomePhone(java.lang.String homePhone)
void setHomeAddress(java.lang.String homeAddress)
void setDescription(java.lang.String aboutMe)
void setManager(java.lang.String manager)
void setEmployeeNumber(java.lang.String empNo)
void setBusinessPOBox(java.lang.String poBox)
void setTimeZone(java.lang.String tz)
void setDepartment(java.lang.String dept)
void setBusinessPager(java.lang.String busPager)
void setBusinessCity(java.lang.String busCity)
void setMaidenName(java.lang.String maidenName)
void setBusinessFax(java.lang.String busFax)
void setDateofHire(java.lang.String doh)
void setNameSuffix(java.lang.String nameSuf)
void setMiddleName(java.lang.String midName)
void setEmployeeType(java.lang.String empType)
void setLastName(java.lang.String lastName)
void setDateofBirth(java.lang.String dob)
void setBusinessState(java.lang.String busState)
void setBusinessStreet(java.lang.String busStreet)
void setBusinessPostalCode(java.lang.String poCode)
void setInitials(java.lang.String initals)
void setFirstName(java.lang.String firstName)
void setDefaultGroup(java.lang.String defGrp)
void setOrganizationalUnit(java.lang.String orgUnit)
void setWirelessAcctNumber(java.lang.String wirelessActNo)
void setBusinessPhone(java.lang.String busPhone)
void setBusinessCountry(java.lang.String busCountry)
void setPreferredLanguage(java.lang.String prefLang)
void setDisplayName(java.lang.String dispName)
void setName(java.lang.String name)
void setTitle(java.lang.String title)
void setBusinessEmail(java.lang.String email)
void setOrganization(java.lang.String org)
void setBusinessMobile(java.lang.String busMobile)
void save() throws ProfileException
ProfileException
byte[] getPhoto(WCUserProfile.PhotoSize size) throws ProfileException
size
- the size of the photo to be returnedProfileException
- if any error occurs while retrieving the photobyte[] getOriginalPhoto() throws ProfileException
null
if none could be foundProfileException
- if any error occurs while retrieving the photosetJPEGPhoto(java.lang.String)
void setJPEGPhoto(java.lang.String imagePath) throws ProfileException
imagePath
- path of an image file to be read and stored as the photoProfileException
- if any errors while storing the photovoid invalidatePhotoCache() throws ProfileException
ProfileException
- if any error occurs while clearing the cache.void updatePhoto(byte[] photo) throws ProfileException
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.
ProfileException
- if any error occurs in the above processjava.lang.String getPhotoUID() throws ProfileException
ProfileException
- if any error occurs while retrieving identifierjava.lang.String getBusinessLocationMapURL() throws ProfileException
ProfileException
void writeVCardTo(java.io.OutputStream out) throws ProfileException
ProfileException