org.sakaiproject.api.common.edu.person

Interface SakaiPerson

All Superinterfaces:

EduPerson, InetOrgPerson, OrganizationalPerson, org.sakaiproject.api.common.manager.Persistable, Person

public interface SakaiPerson
extends EduPerson

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROFILE_SAVE_PERMISSION

Method Summary

Methods

Modifier and Type	Method and Description
String	getAcademicProfileUrl() Get academic profile url
String	getBusinessBiography() Get business bio
String	getCampus() Person's campus
Date	getDateOfBirth() get Date of Birth
String	getEducationCourse() Get education course
String	getEducationSubjects() Get education subjects
String	getFavouriteBooks() Get favourite books
String	getFavouriteMovies() Get favourite movies
String	getFavouriteQuotes() Get favourite quotes
String	getFavouriteTvShows() Get favourite TV shows
Boolean	getFerpaEnabled() Has the user invoked their FERPA rights?
Boolean	getHidePrivateInfo() Person's preference to allow read access to private information
Boolean	getHidePublicInfo() Person's preference to allow read access to public information
Boolean	getLocked() Get the locked status
String	getNormalizedMobile() Get the user's normalized mobile number in international format: country code + number, no spaces or punctuation, example: local format for South African number = 083 123 4567, normalized international form = 27831234567
String	getNotes() Other information provided
String	getPictureUrl() Person's pictureUrl, url to user picture provided.
String	getPublications() Get publications
String	getStaffProfile() Get staff profile info
String	getUniversityProfileUrl() Get external profile url
Boolean	isSystemPicturePreferred() Person's preference to display system picture, if the institution provided picture is preferred for display.
void	setAcademicProfileUrl(String academicProfileUrl) Set academic profile url
void	setBusinessBiography(String businessBiography) Set business bio
void	setCampus(String school) Person's campus
void	setDateOfBirth(Date dateOfBirth) Set the users Date of birth
void	setEducationCourse(String educationCourse) Set education course
void	setEducationSubjects(String educationSubjects) Set education subjects
void	setFavouriteBooks(String favouriteBooks) Set favourite books
void	setFavouriteMovies(String favouriteMovies) Set favourite movies
void	setFavouriteQuotes(String favouriteQuotes) Set favourite quotes
void	setFavouriteTvShows(String favouriteTvShows) Set favourite TV shows
void	setFerpaEnabled(Boolean ferpaEnabled)
void	setHidePrivateInfo(Boolean hidePrivateInfo) Person's preference to allow read access to private information
void	setHidePublicInfo(Boolean hidePublicInfo) Person's preference to allow read access to public information
void	setLocked(Boolean locked) Set the lock status
void	setNormalizedMobile(String Number) Set the user's normalized mobile number in international format.
void	setNotes(String notes) Other information provided
void	setPictureUrl(String pictureURL) Person's pictureUrl, url to user picture provided.
void	setPublications(String publications) Set publications
void	setStaffProfile(String staffProfile) Set staff profile info
void	setSystemPicturePreferred(Boolean systemPicturePreferred) Person's preference to display system picture, if the institution provided picture is preferred for display.
void	setUniversityProfileUrl(String universityProfileUrl) Set external profile url

Methods inherited from interface org.sakaiproject.api.common.edu.person.EduPerson

getAffiliation, getEntitlement, getNickname, getOrgDn, getOrgUnitDn, getPrimaryAffiliation, getPrimaryOrgUnitDn, getPrincipalName, setAffiliation, setEntitlement, setNickname, setOrgDn, setOrgUnitDn, setPrimaryAffiliation, setPrimaryOrgUnitDn, setPrincipalName

Methods inherited from interface org.sakaiproject.api.common.edu.person.InetOrgPerson

getAudio, getBusinessCategory, getCarLicense, getDepartmentNumber, getDisplayName, getEmployeeNumber, getEmployeeType, getGivenName, getHomePhone, getHomePostalAddress, getInitials, getJpegPhoto, getLabeledURI, getMail, getManager, getMobile, getOrganization, getPager, getPreferredLanguage, getRoomNumber, getSecretary, getUid, getUserCertificate, getUserPKCS12, getUserSMIMECertificate, getX500UniqueIdentifier, setAudio, setBusinessCategory, setCarLicense, setDepartmentNumber, setDisplayName, setEmployeeNumber, setEmployeeType, setGivenName, setHomePhone, setHomePostalAddress, setInitials, setJpegPhoto, setLabeledURI, setMail, setManager, setMobile, setOrganization, setPager, setPreferredLanguage, setRoomNumber, setSecretary, setUid, setUserCertificate, setUserPKCS12, setUserSMIMECertificate, setX500UniqueIdentifier

Methods inherited from interface org.sakaiproject.api.common.edu.person.OrganizationalPerson

getFacsimileTelephoneNumber, getLocalityName, getOrganizationalUnit, getPhysicalDeliveryOfficeName, getPostalAddress, getPostalCode, getPostOfficeBox, getStateOrProvinceName, getStreetAddress, getTitle, setFacsimileTelephoneNumber, setLocalityName, setOrganizationalUnit, setPhysicalDeliveryOfficeName, setPostalAddress, setPostalCode, setPostOfficeBox, setStateOrProvinceName, setStreetAddress, setTitle

Methods inherited from interface org.sakaiproject.api.common.edu.person.Person

getAgentUuid, getCommonName, getDescription, getSeeAlso, getStreet, getSurname, getTelephoneNumber, getTypeUuid, setAgentUuid, setCommonName, setDescription, setSeeAlso, setStreet, setSurname, setTelephoneNumber, setTypeUuid

Methods inherited from interface org.sakaiproject.api.common.manager.Persistable

getCreatedBy, getCreatedDate, getLastModifiedBy, getLastModifiedDate, getUuid

Field Detail

PROFILE_SAVE_PERMISSION

static final String PROFILE_SAVE_PERMISSION

See Also:

Constant Field Values

Method Detail

getPictureUrl

String getPictureUrl()

Person's pictureUrl, url to user picture provided.

Returns:

setPictureUrl

void setPictureUrl(String pictureURL)

Person's pictureUrl, url to user picture provided.

Parameters:

pictureURL -

isSystemPicturePreferred

Boolean isSystemPicturePreferred()

Person's preference to display system picture, if the institution provided picture is preferred for display.

Returns:

setSystemPicturePreferred

void setSystemPicturePreferred(Boolean systemPicturePreferred)

Person's preference to display system picture, if the institution provided picture is preferred for display.

getNotes

String getNotes()

Other information provided

Returns:

setNotes

void setNotes(String notes)

Other information provided

Parameters:

notes - : set other information provided

getCampus

String getCampus()

Person's campus

Returns:

setCampus

void setCampus(String school)

Person's campus

Parameters:

school -

getHidePrivateInfo

Boolean getHidePrivateInfo()

Person's preference to allow read access to private information

Returns:

setHidePrivateInfo

void setHidePrivateInfo(Boolean hidePrivateInfo)

Person's preference to allow read access to private information

Parameters:

hidePrivateInfo -

getHidePublicInfo

Boolean getHidePublicInfo()

Person's preference to allow read access to public information

Returns:

setHidePublicInfo

void setHidePublicInfo(Boolean hidePublicInfo)

Person's preference to allow read access to public information

Parameters:

hidePublicInfo -

getFerpaEnabled

Boolean getFerpaEnabled()

Has the user invoked their FERPA rights?

Returns:

setFerpaEnabled

void setFerpaEnabled(Boolean ferpaEnabled)

Parameters:

ferpaEnabled - TRUE if FERPA rights have been invoked. If FALSE or NULL no FERPA rights have been invoked.

setDateOfBirth

void setDateOfBirth(Date dateOfBirth)

Set the users Date of birth

Parameters:

dateOfBirth - Date of Birth

getDateOfBirth

Date getDateOfBirth()

get Date of Birth

setLocked

void setLocked(Boolean locked)

Set the lock status

getLocked

Boolean getLocked()

Get the locked status

Returns:

setFavouriteBooks

void setFavouriteBooks(String favouriteBooks)

Set favourite books

getFavouriteBooks

String getFavouriteBooks()

Get favourite books

Returns:

setFavouriteTvShows

void setFavouriteTvShows(String favouriteTvShows)

Set favourite TV shows

getFavouriteTvShows

String getFavouriteTvShows()

Get favourite TV shows

Returns:

setFavouriteMovies

void setFavouriteMovies(String favouriteMovies)

Set favourite movies

getFavouriteMovies

String getFavouriteMovies()

Get favourite movies

Returns:

setFavouriteQuotes

void setFavouriteQuotes(String favouriteQuotes)

Set favourite quotes

getFavouriteQuotes

String getFavouriteQuotes()

Get favourite quotes

Returns:

setEducationCourse

void setEducationCourse(String educationCourse)

Set education course

getEducationCourse

String getEducationCourse()

Get education course

Returns:

setEducationSubjects

void setEducationSubjects(String educationSubjects)

Set education subjects

getEducationSubjects

String getEducationSubjects()

Get education subjects

Returns:

getNormalizedMobile

String getNormalizedMobile()

Get the user's normalized mobile number in international format: country code + number, no spaces or punctuation, example: local format for South African number = 083 123 4567, normalized international form = 27831234567

Returns:

setNormalizedMobile

void setNormalizedMobile(String Number)

Set the user's normalized mobile number in international format. Normalize the number before passing it to this method.

Parameters:

the - number

setStaffProfile

void setStaffProfile(String staffProfile)

Set staff profile info

Parameters:

staffProfile -

getStaffProfile

String getStaffProfile()

Get staff profile info

Returns:

setUniversityProfileUrl

void setUniversityProfileUrl(String universityProfileUrl)

Set external profile url

Parameters:

universityProfileUrl -

getUniversityProfileUrl

String getUniversityProfileUrl()

Get external profile url

Returns:

setAcademicProfileUrl

void setAcademicProfileUrl(String academicProfileUrl)

Set academic profile url

Parameters:

academicProfileUrl -

getAcademicProfileUrl

String getAcademicProfileUrl()

Get academic profile url

Returns:

setPublications

void setPublications(String publications)

Set publications

Parameters:

publications -

getPublications

String getPublications()

Get publications

Returns:

setBusinessBiography

void setBusinessBiography(String businessBiography)

Set business bio

Parameters:

businessBiography -

getBusinessBiography

String getBusinessBiography()

Get business bio

Returns: