org.sakaiproject.api.common.edu.person

Interface EduPerson

All Superinterfaces:

InetOrgPerson, OrganizationalPerson, Persistable, Person

All Known Subinterfaces:

SakaiPerson

public interface EduPerson
extends InetOrgPerson

See Internet2 EduPerson specification.

EduPerson is an auxiliary object class for campus directories designed to facilitate communication among higher education institutions. It consists of a set of data elements or attributes about individuals within higher education, along with recommendations on the syntax and semantics of the data that may be assigned to those attributes.

Author:

Lance Speelmon

Method Summary

Modifier and Type	Method and Description
String	getAffiliation() Specifies the person's relationship(s) to the institution in broad categories such as student, faculty, staff, alum, etc.
String	getEntitlement() URI (either URN or URL) that indicates a set of rights to specific resources.
String	getNickname() Person's nickname, or the informal name by which they are accustomed to be hailed.
String	getOrgDn() The distinguished name (DN) of the of the directory entry representing the institution with which the person is associated.
String	getOrgUnitDn() The distinguished name(s) (DN) of the directory entries representing the person's Organizational Unit(s).
String	getPrimaryAffiliation() Specifies the person's PRIMARY relationship to the institution in broad categories such as student, faculty, staff, alum, etc.
String	getPrimaryOrgUnitDn() The distinguished name (DN) of the directory entry representing the person's primary Organizational Unit(s).
String	getPrincipalName() The "NetID" of the person for the purposes of inter-institutional authentication.
void	setAffiliation(String affiliation) Specifies the person's relationship(s) to the institution in broad categories such as student, faculty, staff, alum, etc.
void	setEntitlement(String entitlement) URI (either URN or URL) that indicates a set of rights to specific resources.
void	setNickname(String nickname) Person's nickname, or the informal name by which they are accustomed to be hailed.
void	setOrgDn(String orgDn) The distinguished name (DN) of the of the directory entry representing the institution with which the person is associated.
void	setOrgUnitDn(String orgUnitDn) The distinguished name(s) (DN) of the directory entries representing the person's Organizational Unit(s).
void	setPrimaryAffiliation(String primaryAffiliation) Specifies the person's PRIMARY relationship to the institution in broad categories such as student, faculty, staff, alum, etc.
void	setPrimaryOrgUnitDn(String primaryOrgUnitDn) The distinguished name (DN) of the directory entry representing the person's primary Organizational Unit(s).
void	setPrincipalName(String principalName) The "NetID" of the person for the purposes of inter-institutional authentication.

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

Method Detail

getAffiliation

String getAffiliation()

Specifies the person's relationship(s) to the institution in broad categories such as student, faculty, staff, alum, etc. (See controlled vocabulary). Permissible values (if controlled) faculty, student, staff, alum, member, affiliate, employee.

Returns:

setAffiliation

void setAffiliation(String affiliation)

Specifies the person's relationship(s) to the institution in broad categories such as student, faculty, staff, alum, etc. (See controlled vocabulary). Permissible values (if controlled) faculty, student, staff, alum, member, affiliate, employee.

getEntitlement

String getEntitlement()

URI (either URN or URL) that indicates a set of rights to specific resources.

Returns:

setEntitlement

void setEntitlement(String entitlement)

URI (either URN or URL) that indicates a set of rights to specific resources.

getNickname

String getNickname()

Person's nickname, or the informal name by which they are accustomed to be hailed.

Returns:

setNickname

void setNickname(String nickname)

Person's nickname, or the informal name by which they are accustomed to be hailed.

getOrgDn

String getOrgDn()

The distinguished name (DN) of the of the directory entry representing the institution with which the person is associated.

Returns:

setOrgDn

void setOrgDn(String orgDn)

The distinguished name (DN) of the of the directory entry representing the institution with which the person is associated.

getOrgUnitDn

String getOrgUnitDn()

The distinguished name(s) (DN) of the directory entries representing the person's Organizational Unit(s). May be multivalued, as for example, in the case of a faculty member with appointments in multiple departments or a person who is a student in one department and an employee in another.

Returns:

setOrgUnitDn

void setOrgUnitDn(String orgUnitDn)

The distinguished name(s) (DN) of the directory entries representing the person's Organizational Unit(s). May be multivalued, as for example, in the case of a faculty member with appointments in multiple departments or a person who is a student in one department and an employee in another.

getPrimaryAffiliation

String getPrimaryAffiliation()

Specifies the person's PRIMARY relationship to the institution in broad categories such as student, faculty, staff, alum, etc. (See controlled vocabulary). Permissible values (if controlled) faculty, student, staff, alum, member, affiliate, employee.

Returns:

setPrimaryAffiliation

void setPrimaryAffiliation(String primaryAffiliation)

Specifies the person's PRIMARY relationship to the institution in broad categories such as student, faculty, staff, alum, etc. (See controlled vocabulary). Permissible values (if controlled) faculty, student, staff, alum, member, affiliate, employee.

getPrimaryOrgUnitDn

String getPrimaryOrgUnitDn()

The distinguished name (DN) of the directory entry representing the person's primary Organizational Unit(s).

Returns:

setPrimaryOrgUnitDn

void setPrimaryOrgUnitDn(String primaryOrgUnitDn)

The distinguished name (DN) of the directory entry representing the person's primary Organizational Unit(s).

getPrincipalName

String getPrincipalName()

The "NetID" of the person for the purposes of inter-institutional authentication. Should be stored in the form of user_at_univ.edu, where univ.edu is the name of the local security domain.

Returns:

setPrincipalName

void setPrincipalName(String principalName)

The "NetID" of the person for the purposes of inter-institutional authentication. Should be stored in the form of user_at_univ.edu, where univ.edu is the name of the local security domain.