InetOrgPerson (Sakai Common EduPerson API 10.0 API)

All Superinterfaces:

OrganizationalPerson, Persistable, Person

All Known Subinterfaces:

EduPerson, SakaiPerson
```
public interface InetOrgPerson
extends OrganizationalPerson
```
See RFC 2798.

Author:

Lance Speelmon

Method Summary

Methods
Modifier and Type	Method and Description
`BufferedInputStream`	`getAudio()` RFC 1274 notes that the proprietary format they recommend is "interim" only.
`String`	`getBusinessCategory()` RFC 2798
`String`	`getCarLicense()` RFC 2798 This multivalued field is used to record the values of the license or registration plate associated with an individual.
`String`	`getDepartmentNumber()` RFC 2798 Code for department to which a person belongs.
`String`	`getDisplayName()` The name(s) that should appear in white-pages-like applications for this person.
`String`	`getEmployeeNumber()` RFC 2798 Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization.
`String`	`getEmployeeType()` RFC 2798 Used to identify the employer to employee relationship.
`String`	`getGivenName()` From RFC 2256 description:" The givenName attribute is used to hold the part of a person's name which is not their surname nor middle name."
`String`	`getHomePhone()` From RFC 1274 description: "The [homePhone] attribute type specifies a home telephone number associated with a person.� Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."
`String`	`getHomePostalAddress()` From RFC 1274 description: "The Home postal address attribute type specifies a home postal address for an object.
`String`	`getInitials()` From RFC 2256 description: "The initials attribute contains the initials of some or all of an individuals names, but not the surname(s)."
`byte[]`	`getJpegPhoto()` Follow inetOrgPerson definition of RFC 2798: "Used to store one or more images of a person using the JPEG File Interchange Format [JFIF]."
`String`	`getLabeledURI()` Follow inetOrgPerson definition of RFC 2079: "Uniform Resource Identifier with optional label."
`String`	`getMail()` Follow inetOrgPerson definition of RFC 1274: "The [mail] attribute type specifies an electronic mailbox attribute following the syntax specified in RFC 822.
`String`	`getManager()` Follow inetOrgPerson definition which refers to RFC 1274: "The manager attribute type specifies the manager of an object represented by an entry."
`String`	`getMobile()` Follow inetOrgPerson definition of RFC 1274: "The [mobile] attribute type specifies a mobile telephone number associated with a person.
`String`	`getOrganization()` Standard name of the top-level organization (institution) with which this person is associated.
`String`	`getPager()` Follow inetOrgPerson definition of RFC 1274: "The [pager] attribute type specifies a pager telephone number for an object.
`String`	`getPreferredLanguage()` Follow inetOrgPerson definition of RFC 2798: "preferred written or spoken language for a person.
`String`	`getRoomNumber()` RFC 2798
`String`	`getSecretary()` RFC 2798
`String`	`getUid()` Follow inetOrgPerson definition of RFC 1274: "The [uid] attribute type specifies a computer system login name."
`byte[]`	`getUserCertificate()` A user's X.509 certificate
`byte[]`	`getUserPKCS12()` PKCS #12 [PKCS12] provides a format for exchange of personal identity information.
`byte[]`	`getUserSMIMECertificate()` An X.509 certificate specifically for use in S/MIME applications (see RFCs 2632, 2633 and 2634).
`String`	`getX500UniqueIdentifier()` RFC 2798 - Likely to change if directory is reloaded with data.
`void`	`setAudio(BufferedOutputStream audio)` RFC 1274 notes that the proprietary format they recommend is "interim" only.
`void`	`setBusinessCategory(String businessCategory)` RFC 2798
`void`	`setCarLicense(String carLicense)` RFC 2798 This multivalued field is used to record the values of the license or registration plate associated with an individual.
`void`	`setDepartmentNumber(String departmentNumber)` RFC 2798 Code for department to which a person belongs.
`void`	`setDisplayName(String displayName)` The name(s) that should appear in white-pages-like applications for this person.
`void`	`setEmployeeNumber(String employeeNumber)` RFC 2798 Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization.
`void`	`setEmployeeType(String employeeType)` RFC 2798 Used to identify the employer to employee relationship.
`void`	`setGivenName(String givenName)` From RFC 2256 description:" The givenName attribute is used to hold the part of a person's name which is not their surname nor middle name."
`void`	`setHomePhone(String homePhone)` From RFC 1274 description: "The [homePhone] attribute type specifies a home telephone number associated with a person.� Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."
`void`	`setHomePostalAddress(String homePostalAddress)` From RFC 1274 description: "The Home postal address attribute type specifies a home postal address for an object.
`void`	`setInitials(String initials)` From RFC 2256 description: "The initials attribute contains the initials of some or all of an individuals names, but not the surname(s)."
`void`	`setJpegPhoto(byte[] jpegPhoto)` Follow inetOrgPerson definition of RFC 2798: "Used to store one or more images of a person using the JPEG File Interchange Format [JFIF]."
`void`	`setLabeledURI(String labeledURI)` Follow inetOrgPerson definition of RFC 2079: "Uniform Resource Identifier with optional label."
`void`	`setMail(String mail)` Follow inetOrgPerson definition of RFC 1274: "The [mail] attribute type specifies an electronic mailbox attribute following the syntax specified in RFC 822.
`void`	`setManager(String manager)` Follow inetOrgPerson definition which refers to RFC 1274: "The manager attribute type specifies the manager of an object represented by an entry."
`void`	`setMobile(String mobile)` Follow inetOrgPerson definition of RFC 1274: "The [mobile] attribute type specifies a mobile telephone number associated with a person.
`void`	`setOrganization(String organization)` Standard name of the top-level organization (institution) with which this person is associated.
`void`	`setPager(String pager)` Follow inetOrgPerson definition of RFC 1274: "The [pager] attribute type specifies a pager telephone number for an object.
`void`	`setPreferredLanguage(String preferredLanguage)` Follow inetOrgPerson definition of RFC 2798: "preferred written or spoken language for a person.� See RFC2068 and ISO 639 for allowable values in this field.
`void`	`setRoomNumber(String roomNumber)` RFC 2798
`void`	`setSecretary(String secretary)` RFC 2798
`void`	`setUid(String uid)` Follow inetOrgPerson definition of RFC 1274: "The [uid] attribute type specifies a computer system login name."
`void`	`setUserCertificate(byte[] userCertificate)` A user's X.509 certificate
`void`	`setUserPKCS12(byte[] userPKCS12)` PKCS #12 [PKCS12] provides a format for exchange of personal identity information.
`void`	`setUserSMIMECertificate(byte[] userSMIMECertificate)` An X.509 certificate specifically for use in S/MIME applications (see RFCs 2632, 2633 and 2634).
`void`	`setX500UniqueIdentifier(String uniqueIdentifier)` RFC 2798 - Likely to change if directory is reloaded with data.

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
  - getAudio
```
BufferedInputStream getAudio()
```
    RFC 1274 notes that the proprietary format they recommend is "interim" only.
    
    Returns:
  - setAudio
```
void setAudio(BufferedOutputStream audio)
```
    RFC 1274 notes that the proprietary format they recommend is "interim" only.
  - getDisplayName
```
String getDisplayName()
```
    The name(s) that should appear in white-pages-like applications for this person. From RFC 2798 description: "preferred name of a person to be used when displaying entries."
    
    Returns:
  - setDisplayName
```
void setDisplayName(String displayName)
```
    The name(s) that should appear in white-pages-like applications for this person. From RFC 2798 description: "preferred name of a person to be used when displaying entries."
  - getGivenName
```
String getGivenName()
```
    From RFC 2256 description:" The givenName attribute is used to hold the part of a person's name which is not their surname nor middle name."
    
    Returns:
  - setGivenName
```
void setGivenName(String givenName)
```
    From RFC 2256 description:" The givenName attribute is used to hold the part of a person's name which is not their surname nor middle name."
  - getHomePhone
```
String getHomePhone()
```
    From RFC 1274 description: "The [homePhone] attribute type specifies a home telephone number associated with a person.� Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."
    
    Returns:
  - setHomePhone
```
void setHomePhone(String homePhone)
```
    From RFC 1274 description: "The [homePhone] attribute type specifies a home telephone number associated with a person.� Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."
  - getHomePostalAddress
```
String getHomePostalAddress()
```
    From RFC 1274 description: "The Home postal address attribute type specifies a home postal address for an object. This should be limited to up to 6 lines of 30 characters each."
    
    Returns:
  - setHomePostalAddress
```
void setHomePostalAddress(String homePostalAddress)
```
    From RFC 1274 description: "The Home postal address attribute type specifies a home postal address for an object. This should be limited to up to 6 lines of 30 characters each."
  - getInitials
```
String getInitials()
```
    From RFC 2256 description: "The initials attribute contains the initials of some or all of an individuals names, but not the surname(s)."
    
    Returns:
  - setInitials
```
void setInitials(String initials)
```
    From RFC 2256 description: "The initials attribute contains the initials of some or all of an individuals names, but not the surname(s)."
  - getJpegPhoto
```
byte[] getJpegPhoto()
```
    Follow inetOrgPerson definition of RFC 2798: "Used to store one or more images of a person using the JPEG File Interchange Format [JFIF]."
    
    Returns:
  - setJpegPhoto
```
void setJpegPhoto(byte[] jpegPhoto)
```
    Follow inetOrgPerson definition of RFC 2798: "Used to store one or more images of a person using the JPEG File Interchange Format [JFIF]."
  - getLabeledURI
```
String getLabeledURI()
```
    Follow inetOrgPerson definition of RFC 2079: "Uniform Resource Identifier with optional label."
    Most commonly a URL for a web site associated with this person.
    
    Returns:
  - setLabeledURI
```
void setLabeledURI(String labeledURI)
```
    Follow inetOrgPerson definition of RFC 2079: "Uniform Resource Identifier with optional label."
    Most commonly a URL for a web site associated with this person.
  - getMail
```
String getMail()
```
    Follow inetOrgPerson definition of RFC 1274: "The [mail] attribute type specifies an electronic mailbox attribute following the syntax specified in RFC 822. Note that this attribute should not be used for greybook or other non-Internet order mailboxes."
    
    Returns:
  - setMail
```
void setMail(String mail)
```
    Follow inetOrgPerson definition of RFC 1274: "The [mail] attribute type specifies an electronic mailbox attribute following the syntax specified in RFC 822. Note that this attribute should not be used for greybook or other non-Internet order mailboxes."
  - getManager
```
String getManager()
```
    Follow inetOrgPerson definition which refers to RFC 1274: "The manager attribute type specifies the manager of an object represented by an entry." The value is a DN.
    
    Returns:
  - setManager
```
void setManager(String manager)
```
    Follow inetOrgPerson definition which refers to RFC 1274: "The manager attribute type specifies the manager of an object represented by an entry." The value is a DN.
  - getMobile
```
String getMobile()
```
    Follow inetOrgPerson definition of RFC 1274: "The [mobile] attribute type specifies a mobile telephone number associated with a person. Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."
    
    Returns:
  - setMobile
```
void setMobile(String mobile)
```
    Follow inetOrgPerson definition of RFC 1274: "The [mobile] attribute type specifies a mobile telephone number associated with a person. Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."
  - getOrganization
```
String getOrganization()
```
    Standard name of the top-level organization (institution) with which this person is associated.
    
    Returns:
  - setOrganization
```
void setOrganization(String organization)
```
    Standard name of the top-level organization (institution) with which this person is associated.
  - getPager
```
String getPager()
```
    Follow inetOrgPerson definition of RFC 1274: "The [pager] attribute type specifies a pager telephone number for an object. Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."
    
    Returns:
  - setPager
```
void setPager(String pager)
```
    Follow inetOrgPerson definition of RFC 1274: "The [pager] attribute type specifies a pager telephone number for an object. Attribute values should follow the agreed format for international telephone numbers: i.e., "+44 71 123 4567."
  - getPreferredLanguage
```
String getPreferredLanguage()
```
    Follow inetOrgPerson definition of RFC 2798: "preferred written or spoken language for a person.
    See RFC2068 and ISO 639 for allowable values in this field. Esperanto, for example is EO in ISO 639, and RFC2068 would allow a value of en-US for US English.
    
    Returns:
  - setPreferredLanguage
```
void setPreferredLanguage(String preferredLanguage)
```
    Follow inetOrgPerson definition of RFC 2798: "preferred written or spoken language for a person.�
    See RFC2068 and ISO 639 for allowable values in this field. Esperanto, for example is EO in ISO 639, and RFC2068 would allow a value of en-US for US English.
  - getUid
```
String getUid()
```
    Follow inetOrgPerson definition of RFC 1274: "The [uid] attribute type specifies a computer system login name."
    
    Returns:
  - setUid
```
void setUid(String uid)
```
    Follow inetOrgPerson definition of RFC 1274: "The [uid] attribute type specifies a computer system login name."
  - getUserCertificate
```
byte[] getUserCertificate()
```
    A user's X.509 certificate
    
    Returns:
  - setUserCertificate
```
void setUserCertificate(byte[] userCertificate)
```
    A user's X.509 certificate
  - getUserSMIMECertificate
```
byte[] getUserSMIMECertificate()
```
    An X.509 certificate specifically for use in S/MIME applications (see RFCs 2632, 2633 and 2634).
    
    Returns:
  - setUserSMIMECertificate
```
void setUserSMIMECertificate(byte[] userSMIMECertificate)
```
    An X.509 certificate specifically for use in S/MIME applications (see RFCs 2632, 2633 and 2634).
  - getCarLicense
```
String getCarLicense()
```
    RFC 2798
    This multivalued field is used to record the values of the license or registration plate associated with an individual.
    
    Returns:
  - setCarLicense
```
void setCarLicense(String carLicense)
```
    RFC 2798
    This multivalued field is used to record the values of the license or registration plate associated with an individual.
  - getDepartmentNumber
```
String getDepartmentNumber()
```
    RFC 2798
    Code for department to which a person belongs. This can also be strictly numeric (e.g., 1234) or alphanumeric (e.g., ABC/123).
    
    Returns:
  - setDepartmentNumber
```
void setDepartmentNumber(String departmentNumber)
```
    RFC 2798
    Code for department to which a person belongs. This can also be strictly numeric (e.g., 1234) or alphanumeric (e.g., ABC/123).
  - getEmployeeNumber
```
String getEmployeeNumber()
```
    RFC 2798
    Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization. Single valued.
    
    Returns:
  - setEmployeeNumber
```
void setEmployeeNumber(String employeeNumber)
```
    RFC 2798
    Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization. Single valued.
  - getEmployeeType
```
String getEmployeeType()
```
    RFC 2798
    Used to identify the employer to employee relationship. Typical values used will be "Contractor", "Employee", "Intern", "Temp", "External", and "Unknown" but any value may be used.
    
    Returns:
  - setEmployeeType
```
void setEmployeeType(String employeeType)
```
    RFC 2798
    Used to identify the employer to employee relationship. Typical values used will be "Contractor", "Employee", "Intern", "Temp", "External", and "Unknown" but any value may be used.
  - getUserPKCS12
```
byte[] getUserPKCS12()
```
    PKCS #12 [PKCS12] provides a format for exchange of personal identity information. When such information is stored in a directory service, the userPKCS12 attribute should be used. This attribute is to be stored and requested in binary form, as 'userPKCS12;binary'. The attribute values are PFX PDUs stored as binary data.
    
    Returns:
  - setUserPKCS12
```
void setUserPKCS12(byte[] userPKCS12)
```
    PKCS #12 [PKCS12] provides a format for exchange of personal identity information. When such information is stored in a directory service, the userPKCS12 attribute should be used. This attribute is to be stored and requested in binary form, as 'userPKCS12;binary'. The attribute values are PFX PDUs stored as binary data.
  - getBusinessCategory
```
String getBusinessCategory()
```
    RFC 2798
    
    Returns:
  - setBusinessCategory
```
void setBusinessCategory(String businessCategory)
```
    RFC 2798
  - getX500UniqueIdentifier
```
String getX500UniqueIdentifier()
```
    RFC 2798 - Likely to change if directory is reloaded with data.
    
    Returns:
  - setX500UniqueIdentifier
```
void setX500UniqueIdentifier(String uniqueIdentifier)
```
    RFC 2798 - Likely to change if directory is reloaded with data.
  - getRoomNumber
```
String getRoomNumber()
```
    RFC 2798
    
    Returns:
  - setRoomNumber
```
void setRoomNumber(String roomNumber)
```
    RFC 2798
  - getSecretary
```
String getSecretary()
```
    RFC 2798
    
    Returns:
  - setSecretary
```
void setSecretary(String secretary)
```
    RFC 2798

Interface InetOrgPerson

Method Summary

Methods inherited from interface org.sakaiproject.api.common.edu.person.OrganizationalPerson

Methods inherited from interface org.sakaiproject.api.common.edu.person.Person

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

Method Detail

getAudio

setAudio

getDisplayName

setDisplayName

getGivenName

setGivenName

getHomePhone

setHomePhone

getHomePostalAddress

setHomePostalAddress

getInitials

setInitials

getJpegPhoto

setJpegPhoto

getLabeledURI

setLabeledURI

getMail

setMail

getManager

setManager

getMobile

setMobile

getOrganization

setOrganization

getPager

setPager

getPreferredLanguage

setPreferredLanguage

getUid

setUid

getUserCertificate

setUserCertificate

getUserSMIMECertificate

setUserSMIMECertificate

getCarLicense

setCarLicense

getDepartmentNumber

setDepartmentNumber

getEmployeeNumber

setEmployeeNumber

getEmployeeType

setEmployeeType

getUserPKCS12

setUserPKCS12

getBusinessCategory

setBusinessCategory

getX500UniqueIdentifier

setX500UniqueIdentifier

getRoomNumber

setRoomNumber

getSecretary

setSecretary