001: /**********************************************************************************
002: * $URL: https://source.sakaiproject.org/svn/profile/tags/sakai_2-4-1/edu-person-api/src/java/org/sakaiproject/api/common/edu/person/OrganizationalPerson.java $
003: * $Id: OrganizationalPerson.java 8424 2006-04-27 20:23:44Z ggolden@umich.edu $
004: ***********************************************************************************
005: *
006: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
007: *
008: * Licensed under the Educational Community License, Version 1.0 (the "License");
009: * you may not use this file except in compliance with the License.
010: * You may obtain a copy of the License at
011: *
012: * http://www.opensource.org/licenses/ecl1.php
013: *
014: * Unless required by applicable law or agreed to in writing, software
015: * distributed under the License is distributed on an "AS IS" BASIS,
016: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017: * See the License for the specific language governing permissions and
018: * limitations under the License.
019: *
020: **********************************************************************************/package org.sakaiproject.api.common.edu.person;
021:
022: /**
023: * See ITU X.521 spec.
024: *
025: * @author <a href="mailto:lance@indiana.edu">Lance Speelmon </a>
026: */
027: public interface OrganizationalPerson extends Person {
028: /**
029: * A fax number for the directory entry. Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."
030: *
031: * @return
032: */
033: public String getFacsimileTelephoneNumber();
034:
035: /**
036: * A fax number for the directory entry. Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."
037: *
038: * @return
039: */
040: public void setFacsimileTelephoneNumber(
041: String facsimileTelephoneNumber);
042:
043: /**
044: * According to RFC 2256, "This attribute contains the name of a locality, such as a city, county or other geographic region (localityName)."
045: * <p>
046: * 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
047: * some other important way.”
048: *
049: * @return
050: */
051: public String getLocalityName();
052:
053: /**
054: * According to RFC 2256, "This attribute contains the name of a locality, such as a city, county or other geographic region (localityName)."
055: * <p>
056: * 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
057: * some other important way.”
058: *
059: * @return
060: */
061: public void setLocalityName(String localityName);
062:
063: /**
064: * Abbreviation for state or province name.
065: * <p>
066: * 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.
067: * <p>
068: * According to RFC 2256, "This attribute contains the full name of a state or province (stateOrProvinceName)."
069: * <p>
070: * Permissible values (if controlled)
071: * <p>
072: * For states in the United States, U.S. Postal Service set of two-letter state name abbreviations.
073: *
074: * @return
075: */
076: public String getStateOrProvinceName();
077:
078: /**
079: * Abbreviation for state or province name.
080: * <p>
081: * 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.
082: * <p>
083: * According to RFC 2256, "This attribute contains the full name of a state or province (stateOrProvinceName)."
084: * <p>
085: * Permissible values (if controlled)
086: * <p>
087: * For states in the United States, U.S. Postal Service set of two-letter state name abbreviations.
088: *
089: * @return
090: */
091: public void setStateOrProvinceName(String stateOrProvinceName);
092:
093: /**
094: * 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.
095: *
096: * @return
097: */
098: public String getPostalCode();
099:
100: /**
101: * 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.
102: *
103: * @return
104: */
105: public void setPostalCode(String postalCode);
106:
107: /**
108: * 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."
109: *
110: * @return
111: */
112: public String getPostOfficeBox();
113:
114: /**
115: * 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."
116: *
117: * @return
118: */
119: public void setPostOfficeBox(String postOfficeBox);
120:
121: /**
122: * From X.521 spec: LocaleAttributeSet, PostalAttributeSet
123: *
124: * @return
125: */
126: public String getStreetAddress();
127:
128: /**
129: * From X.521 spec: LocaleAttributeSet, PostalAttributeSet
130: */
131: public void setStreetAddress(String streetAddress);
132:
133: /**
134: * From X.521 spec: PostalAttributeSet
135: *
136: * @return
137: */
138: public String getPhysicalDeliveryOfficeName();
139:
140: /**
141: * From X.521 spec: PostalAttributeSet
142: */
143: public void setPhysicalDeliveryOfficeName(
144: String physicalDeliveryOfficeName);
145:
146: /**
147: * From X.521 spec: PostalAttributeSet
148: * <p>
149: * 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."
150: *
151: * @return
152: */
153: public String getPostalAddress();
154:
155: /**
156: * From X.521 spec: PostalAttributeSet
157: * <p>
158: * 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."
159: *
160: * @return
161: */
162: public void setPostalAddress(String postalAddress);
163:
164: /**
165: * Follow X.520(2001): "The Title attribute type specifies the designated position or function of the object within an organization."
166: *
167: * @return
168: */
169: public String getTitle();
170:
171: /**
172: * Follow X.520(2001): "The Title attribute type specifies the designated position or function of the object within an organization."
173: *
174: * @return
175: */
176: public void setTitle(String title);
177:
178: /**
179: * 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
180: * affiliated.
181: * <p>
182: * 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
183: * OrganizationName [o] attribute.
184: * <p>
185: * An attribute value for Organizational Unit Name is a string chosen by the organization of which it is a part."
186: *
187: * @return
188: */
189: public String getOrganizationalUnit();
190:
191: /**
192: * 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
193: * affiliated.
194: * <p>
195: * 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
196: * OrganizationName [o] attribute.
197: * <p>
198: * An attribute value for Organizational Unit Name is a string chosen by the organization of which it is a part."
199: *
200: * @return
201: */
202: public void setOrganizationalUnit(String organizationalUnit);
203: }
|