org.sakaiproject.api.common.edu.person

Interface Person

All Superinterfaces:

Persistable

All Known Subinterfaces:

EduPerson, InetOrgPerson, OrganizationalPerson, SakaiPerson

public interface Person
extends Persistable

See ITU X.521 spec.

Author:

Lance Speelmon

Method Summary

Modifier and Type	Method and Description
String	getAgentUuid()
String	getCommonName() Common name.
String	getDescription() Open-ended; whatever the person or the directory manager puts here.
String	getSeeAlso() Follow person object class definition: Identifies (by DN) another directory server entry that may contain information related to this entry.
String	getStreet() According to RFC 2256, "This attribute contains the physical address of the object to which the entry corresponds, such as an address for package delivery (streetAddress)."
String	getSurname() Surname or family name.
String	getTelephoneNumber() Office/campus phone number.
String	getTypeUuid()
void	setAgentUuid(String agentUuid)
void	setCommonName(String commonName) Common name.
void	setDescription(String description) Open-ended; whatever the person or the directory manager puts here.
void	setSeeAlso(String seeAlso) Follow person object class definition: Identifies (by DN) another directory server entry that may contain information related to this entry.
void	setStreet(String street) According to RFC 2256, "This attribute contains the physical address of the object to which the entry corresponds, such as an address for package delivery (streetAddress)."
void	setSurname(String surname) Surname or family name.
void	setTelephoneNumber(String telephoneNumber) Office/campus phone number.
void	setTypeUuid(String typeUuid)

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

getCreatedBy, getCreatedDate, getLastModifiedBy, getLastModifiedDate, getUuid

Method Detail

getAgentUuid

String getAgentUuid()

Returns:

The UUID of the Agent for which this record describes.

setAgentUuid

void setAgentUuid(String agentUuid)

Parameters:

agentUuid - The UUID of the Agent for which this record describes.

getTypeUuid

String getTypeUuid()

Returns:

setTypeUuid

void setTypeUuid(String typeUuid)

Parameters:

typeUuid -

getCommonName

String getCommonName()

Common name. According to RFC 2256, "This is the X.500 commonName attribute, which contains a name of an object. If the object corresponds to a person, it is typically the person's full name.

Returns:

setCommonName

void setCommonName(String commonName)

Common name. According to RFC 2256, "This is the X.500 commonName attribute, which contains a name of an object. If the object corresponds to a person, it is typically the person's full name.

getDescription

String getDescription()

Open-ended; whatever the person or the directory manager puts here. According to RFC 2256, "This attribute contains a human-readable description of the object."

Returns:

setDescription

void setDescription(String description)

Open-ended; whatever the person or the directory manager puts here. According to RFC 2256, "This attribute contains a human-readable description of the object."

getSeeAlso

String getSeeAlso()

Follow person object class definition: Identifies (by DN) another directory server entry that may contain information related to this entry.

According to X.520(2000), "The See Also attribute type specifies names of other Directory objects which may be other aspects (in some sense) of the same real world object."

Returns:

setSeeAlso

void setSeeAlso(String seeAlso)

Follow person object class definition: Identifies (by DN) another directory server entry that may contain information related to this entry.

According to X.520(2000), "The See Also attribute type specifies names of other Directory objects which may be other aspects (in some sense) of the same real world object."

getSurname

String getSurname()

Surname or family name. According to RFC 2256, "This is the X.500 surname attribute, which contains the family name of a person."

Returns:

setSurname

void setSurname(String surname)

Surname or family name. According to RFC 2256, "This is the X.500 surname attribute, which contains the family name of a person."

getStreet

String getStreet()

According to RFC 2256, "This attribute contains the physical address of the object to which the entry corresponds, such as an address for package delivery (streetAddress)."

Returns:

setStreet

void setStreet(String street)

According to RFC 2256, "This attribute contains the physical address of the object to which the entry corresponds, such as an address for package delivery (streetAddress)."

getTelephoneNumber

String getTelephoneNumber()

Office/campus phone number. Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."

Returns:

setTelephoneNumber

void setTelephoneNumber(String telephoneNumber)

Office/campus phone number. Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."