org.sakaiproject.component.common.edu.person
Class EduPersonImpl

java.lang.Object
  extended byorg.sakaiproject.component.common.manager.PersistableImpl
      extended byorg.sakaiproject.component.common.edu.person.PersonImpl
          extended byorg.sakaiproject.component.common.edu.person.OrganizationalPersonImpl
              extended byorg.sakaiproject.component.common.edu.person.InetOrgPersonImpl
                  extended byorg.sakaiproject.component.common.edu.person.EduPersonImpl
All Implemented Interfaces:
EduPerson, InetOrgPerson, OrganizationalPerson, Persistable, Person
Direct Known Subclasses:
SakaiPersonImpl

public class EduPersonImpl
extends InetOrgPersonImpl
implements Person, OrganizationalPerson, InetOrgPerson, EduPerson

Version:
$Id: EduPersonImpl.java 632 2005-07-14 21:22:50Z janderse@umich.edu $
Author:
Lance Speelmon

Field Summary
protected  String affiliation
           
protected  String entitlement
           
protected  String nickname
           
protected  String orgDn
           
protected  String orgUnitDn
           
protected  String primaryAffiliation
           
protected  String primaryOrgUnitDn
           
protected  String principalName
           
 
Fields inherited from class org.sakaiproject.component.common.edu.person.InetOrgPersonImpl
businessCategory, carLicense, departmentNumber, displayName, employeeNumber, employeeType, givenName, homePhone, homePostalAddress, initials, jpegPhoto, labeledURI, mail, manager, mobile, organization, pager, preferredLanguage, roomNumber, secretary, uid, userCertificate, userPKCS12, userSMIMECertificate, x500UniqueIdentifier
 
Fields inherited from class org.sakaiproject.component.common.edu.person.OrganizationalPersonImpl
facsimileTelephoneNumber, localityName, organizationalUnit, physicalDeliveryOfficeName, postalAddress, postalCode, postOfficeBox, stateOrProvinceName, streetAddress, title
 
Fields inherited from class org.sakaiproject.component.common.edu.person.PersonImpl
agentUuid, commonName, description, seeAlso, street, surname, telephoneNumber, typeUuid
 
Fields inherited from class org.sakaiproject.component.common.manager.PersistableImpl
createdBy, createdDate, id, lastModifiedBy, lastModifiedDate, uuid, version
 
Constructor Summary
EduPersonImpl()
           
 
Method Summary
 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 class org.sakaiproject.component.common.edu.person.InetOrgPersonImpl
getAudio, getBlobImage, 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, setBlobImage, 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 class org.sakaiproject.component.common.edu.person.OrganizationalPersonImpl
getFacsimileTelephoneNumber, getLocalityName, getOrganizationalUnit, getPhysicalDeliveryOfficeName, getPostalAddress, getPostalCode, getPostOfficeBox, getStateOrProvinceName, getStreetAddress, getTitle, setFacsimileTelephoneNumber, setLocalityName, setOrganizationalUnit, setPhysicalDeliveryOfficeName, setPostalAddress, setPostalCode, setPostOfficeBox, setStateOrProvinceName, setStreetAddress, setTitle
 
Methods inherited from class org.sakaiproject.component.common.edu.person.PersonImpl
businessKey, equals, getAgentUuid, getCommonName, getDescription, getSeeAlso, getStreet, getSurname, getTelephoneNumber, getTypeUuid, hashCode, setAgentUuid, setCommonName, setDescription, setSeeAlso, setStreet, setSurname, setTelephoneNumber, setTypeUuid, toString
 
Methods inherited from class org.sakaiproject.component.common.manager.PersistableImpl
getCreatedBy, getCreatedDate, getId, getLastModifiedBy, getLastModifiedDate, getUuid, getVersion, setCreatedBy, setCreatedDate, setId, setLastModifiedBy, setLastModifiedDate, setUuid, setVersion
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
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
 
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.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
 

Field Detail

affiliation

protected String affiliation

entitlement

protected String entitlement

nickname

protected String nickname

orgDn

protected String orgDn

orgUnitDn

protected String orgUnitDn

primaryAffiliation

protected String primaryAffiliation

primaryOrgUnitDn

protected String primaryOrgUnitDn

principalName

protected String principalName
Constructor Detail

EduPersonImpl

public EduPersonImpl()
Method Detail

getAffiliation

public String getAffiliation()
Description copied from interface: EduPerson
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.

Specified by:
getAffiliation in interface EduPerson
Returns:
See Also:
org.sakaiproject.service.profile.EduPerson#getAffiliation()

setAffiliation

public void setAffiliation(String affiliation)
Description copied from interface: EduPerson
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.

Specified by:
setAffiliation in interface EduPerson
Parameters:
affiliation - The affiliation to set.
Returns:

getEntitlement

public String getEntitlement()
Description copied from interface: EduPerson
URI (either URN or URL) that indicates a set of rights to specific resources.

Specified by:
getEntitlement in interface EduPerson
Returns:
See Also:
org.sakaiproject.service.profile.EduPerson#getEntitlement()

setEntitlement

public void setEntitlement(String entitlement)
Description copied from interface: EduPerson
URI (either URN or URL) that indicates a set of rights to specific resources.

Specified by:
setEntitlement in interface EduPerson
Parameters:
entitlement - The entitlement to set.

getNickname

public String getNickname()
Description copied from interface: EduPerson
Person's nickname, or the informal name by which they are accustomed to be hailed.

Specified by:
getNickname in interface EduPerson
Returns:
See Also:
org.sakaiproject.service.profile.EduPerson#getNickname()

setNickname

public void setNickname(String nickname)
Description copied from interface: EduPerson
Person's nickname, or the informal name by which they are accustomed to be hailed.

Specified by:
setNickname in interface EduPerson
Parameters:
nickname - The nickname to set.

getOrgDn

public String getOrgDn()
Description copied from interface: EduPerson
The distinguished name (DN) of the of the directory entry representing the institution with which the person is associated.

Specified by:
getOrgDn in interface EduPerson
Returns:
See Also:
org.sakaiproject.service.profile.EduPerson#getOrgDn()

setOrgDn

public void setOrgDn(String orgDn)
Description copied from interface: EduPerson
The distinguished name (DN) of the of the directory entry representing the institution with which the person is associated.

Specified by:
setOrgDn in interface EduPerson
Parameters:
orgDn - The orgDn to set.

getOrgUnitDn

public String getOrgUnitDn()
Description copied from interface: EduPerson
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.

Specified by:
getOrgUnitDn in interface EduPerson
Returns:
See Also:
org.sakaiproject.service.profile.EduPerson#getOrgUnitDn()

setOrgUnitDn

public void setOrgUnitDn(String orgUnitDn)
Description copied from interface: EduPerson
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.

Specified by:
setOrgUnitDn in interface EduPerson
Parameters:
orgUnitDn - The orgUnitDn to set.
Returns:

getPrimaryAffiliation

public String getPrimaryAffiliation()
Description copied from interface: EduPerson
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.

Specified by:
getPrimaryAffiliation in interface EduPerson
Returns:
See Also:
org.sakaiproject.service.profile.EduPerson#getPrimaryAffiliation()

setPrimaryAffiliation

public void setPrimaryAffiliation(String primaryAffiliation)
Description copied from interface: EduPerson
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.

Specified by:
setPrimaryAffiliation in interface EduPerson
Parameters:
primaryAffiliation - The primaryAffiliation to set.
Returns:

getPrimaryOrgUnitDn

public String getPrimaryOrgUnitDn()
Description copied from interface: EduPerson
The distinguished name (DN) of the directory entry representing the person's primary Organizational Unit(s).

Specified by:
getPrimaryOrgUnitDn in interface EduPerson
Returns:
See Also:
org.sakaiproject.service.profile.EduPerson#getPrimaryOrgUnitDn()

setPrimaryOrgUnitDn

public void setPrimaryOrgUnitDn(String primaryOrgUnitDn)
Description copied from interface: EduPerson
The distinguished name (DN) of the directory entry representing the person's primary Organizational Unit(s).

Specified by:
setPrimaryOrgUnitDn in interface EduPerson
Parameters:
primaryOrgUnitDn - The primaryOrgUnitDn to set.

getPrincipalName

public String getPrincipalName()
Description copied from interface: EduPerson
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.

Specified by:
getPrincipalName in interface EduPerson
Returns:
See Also:
org.sakaiproject.service.profile.EduPerson#getPrincipalName()

setPrincipalName

public void setPrincipalName(String principalName)
Description copied from interface: EduPerson
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.

Specified by:
setPrincipalName in interface EduPerson
Parameters:
principalName - The principalName to set.
Returns: