org.sakaiproject.api.common.edu.person

Interface OrganizationalPerson

All Superinterfaces:

Persistable, Person

All Known Subinterfaces:

EduPerson, InetOrgPerson, SakaiPerson

public interface OrganizationalPerson
extends Person

See ITU X.521 spec.

Author:

Lance Speelmon

Method Summary

Modifier and Type	Method and Description
String	getFacsimileTelephoneNumber() A fax number for the directory entry.
String	getLocalityName() According to RFC 2256, "This attribute contains the name of a locality, such as a city, county or other geographic region (localityName)."
String	getOrganizationalUnit() Organizational unit(s).
String	getPhysicalDeliveryOfficeName() From X.521 spec: PostalAttributeSet
String	getPostalAddress() From X.521 spec: PostalAttributeSet Campus or office address. inetOrgPerson has a homePostalAddress that complements this attribute.
String	getPostalCode() Follow X.500(2001): "The postal code attribute type specifies the postal code of the named object.
String	getPostOfficeBox() Follow X.500(2001): "The Post Office Box attribute type specifies the Postal Office Box by which the object will receive physical postal delivery.
String	getStateOrProvinceName() Abbreviation for state or province name.
String	getStreetAddress() From X.521 spec: LocaleAttributeSet, PostalAttributeSet
String	getTitle() Follow X.520(2001): "The Title attribute type specifies the designated position or function of the object within an organization."
void	setFacsimileTelephoneNumber(String facsimileTelephoneNumber) A fax number for the directory entry.
void	setLocalityName(String localityName) According to RFC 2256, "This attribute contains the name of a locality, such as a city, county or other geographic region (localityName)."
void	setOrganizationalUnit(String organizationalUnit) Organizational unit(s).
void	setPhysicalDeliveryOfficeName(String physicalDeliveryOfficeName) From X.521 spec: PostalAttributeSet
void	setPostalAddress(String postalAddress) From X.521 spec: PostalAttributeSet Campus or office address. inetOrgPerson has a homePostalAddress that complements this attribute.
void	setPostalCode(String postalCode) Follow X.500(2001): "The postal code attribute type specifies the postal code of the named object.
void	setPostOfficeBox(String postOfficeBox) Follow X.500(2001): "The Post Office Box attribute type specifies the Postal Office Box by which the object will receive physical postal delivery.
void	setStateOrProvinceName(String stateOrProvinceName) Abbreviation for state or province name.
void	setStreetAddress(String streetAddress) From X.521 spec: LocaleAttributeSet, PostalAttributeSet
void	setTitle(String title) Follow X.520(2001): "The Title attribute type specifies the designated position or function of the object within an organization."

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

getFacsimileTelephoneNumber

String getFacsimileTelephoneNumber()

A fax number for the directory entry. Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."

Returns:

setFacsimileTelephoneNumber

void setFacsimileTelephoneNumber(String facsimileTelephoneNumber)

A fax number for the directory entry. Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."

getLocalityName

String getLocalityName()

According to RFC 2256, "This attribute contains the name of a locality, such as a city, county or other geographic region (localityName)."

X.520(2000) reads: "The Locality Name attribute type specifies a locality. When used as a component of a directory name, it identifies a geographical area or locality in which the named object is physically located or with which it is associated in some other important way.

Returns:

setLocalityName

void setLocalityName(String localityName)

According to RFC 2256, "This attribute contains the name of a locality, such as a city, county or other geographic region (localityName)."

X.520(2000) reads: "The Locality Name attribute type specifies a locality. When used as a component of a directory name, it identifies a geographical area or locality in which the named object is physically located or with which it is associated in some other important way.

getStateOrProvinceName

String getStateOrProvinceName()

Abbreviation for state or province name.

Format: The values should be coordinated on a national level and if well-known shortcuts exist - like the two-letter state abbreviations in the US these abbreviations are preferred over longer full names.

According to RFC 2256, "This attribute contains the full name of a state or province (stateOrProvinceName)."

Permissible values (if controlled)

For states in the United States, U.S. Postal Service set of two-letter state name abbreviations.

Returns:

setStateOrProvinceName

void setStateOrProvinceName(String stateOrProvinceName)

Abbreviation for state or province name.

Format: The values should be coordinated on a national level and if well-known shortcuts exist - like the two-letter state abbreviations in the US these abbreviations are preferred over longer full names.

According to RFC 2256, "This attribute contains the full name of a state or province (stateOrProvinceName)."

Permissible values (if controlled)

For states in the United States, U.S. Postal Service set of two-letter state name abbreviations.

getPostalCode

String getPostalCode()

Follow X.500(2001): "The postal code attribute type specifies the postal code of the named object. If this attribute value is present, it will be part of the object's postal address." Zip code in USA, postal code for other countries.

Returns:

setPostalCode

void setPostalCode(String postalCode)

Follow X.500(2001): "The postal code attribute type specifies the postal code of the named object. If this attribute value is present, it will be part of the object's postal address." Zip code in USA, postal code for other countries.

getPostOfficeBox

String getPostOfficeBox()

Follow X.500(2001): "The Post Office Box attribute type specifies the Postal Office Box by which the object will receive physical postal delivery. If present, the attribute value is part of the object's postal address."

setPostOfficeBox

void setPostOfficeBox(String postOfficeBox)

Follow X.500(2001): "The Post Office Box attribute type specifies the Postal Office Box by which the object will receive physical postal delivery. If present, the attribute value is part of the object's postal address."

getStreetAddress

String getStreetAddress()

From X.521 spec: LocaleAttributeSet, PostalAttributeSet

Returns:

setStreetAddress

void setStreetAddress(String streetAddress)

From X.521 spec: LocaleAttributeSet, PostalAttributeSet

getPhysicalDeliveryOfficeName

String getPhysicalDeliveryOfficeName()

From X.521 spec: PostalAttributeSet

Returns:

setPhysicalDeliveryOfficeName

void setPhysicalDeliveryOfficeName(String physicalDeliveryOfficeName)

From X.521 spec: PostalAttributeSet

getPostalAddress

String getPostalAddress()

From X.521 spec: PostalAttributeSet

Campus or office address. inetOrgPerson has a homePostalAddress that complements this attribute. X.520(2000) reads: "The Postal Address attribute type specifies the address information required for the physical postal delivery to an object."

Returns:

setPostalAddress

void setPostalAddress(String postalAddress)

From X.521 spec: PostalAttributeSet

Campus or office address. inetOrgPerson has a homePostalAddress that complements this attribute. X.520(2000) reads: "The Postal Address attribute type specifies the address information required for the physical postal delivery to an object."

getTitle

String getTitle()

Follow X.520(2001): "The Title attribute type specifies the designated position or function of the object within an organization."

Returns:

setTitle

void setTitle(String title)

Follow X.520(2001): "The Title attribute type specifies the designated position or function of the object within an organization."

getOrganizationalUnit

String getOrganizationalUnit()

Organizational unit(s). According to X.520(2000), "The Organizational Unit Name attribute type specifies an organizational unit. When used as a component of a directory name it identifies an organizational unit with which the named object is affiliated.

The designated organizational unit is understood to be part of an organization designated by an OrganizationName [o] attribute. It follows that if an Organizational Unit Name attribute is used in a directory name, it must be associated with an OrganizationName [o] attribute.

An attribute value for Organizational Unit Name is a string chosen by the organization of which it is a part."

Returns:

setOrganizationalUnit

void setOrganizationalUnit(String organizationalUnit)

Organizational unit(s). According to X.520(2000), "The Organizational Unit Name attribute type specifies an organizational unit. When used as a component of a directory name it identifies an organizational unit with which the named object is affiliated.

The designated organizational unit is understood to be part of an organization designated by an OrganizationName [o] attribute. It follows that if an Organizational Unit Name attribute is used in a directory name, it must be associated with an OrganizationName [o] attribute.

An attribute value for Organizational Unit Name is a string chosen by the organization of which it is a part."