edu.vt.middleware.ed
Class PersonAttribute

java.lang.Object
  edu.vt.middleware.ed.AbstractDataType
      edu.vt.middleware.ed.AbstractAttribute
          edu.vt.middleware.ed.PersonAttribute

All Implemented Interfaces:

Attribute, DataType, Serializable, Comparable<DataType>

public class PersonAttribute
extends AbstractAttribute
implements Serializable

Contains person attribute data.

Version:

$Revision: 8027 $

Author:

Daniel Fisher

See Also:

Serialized Form

Field Summary

static PersonAttribute	ACCOUNT_CREATION_DATE accountCreationDate
static PersonAttribute	ACCOUNT_EXPIRATION_DATE accountExpirationDate
static PersonAttribute	ACCOUNT_SHELVE_DATE accountShelveDate
static PersonAttribute	ACCOUNT_STATE accountState
static PersonAttribute	ADDRESS address
static DataType[]	ALL_TYPES all types
static PersonAttribute	AUTH_ID authId
static PersonAttribute	BANNER_PIDM bannerPIDM
static PersonAttribute	BASE_DN baseDn
static PersonAttribute	C c
static PersonAttribute	CAMPUS campus
static PersonAttribute	CHAP_SECRET chapSecret
static PersonAttribute	CLASS_LEVEL classLevel
static PersonAttribute	CLASS_LEVEL_CODE classLevelCode
static PersonAttribute	CN cn
static PersonAttribute	CREATION_DATE creationDate
static PersonAttribute	DATE_OF_BIRTH dateOfBirth
static PersonAttribute	DEGREE_TYPE degreeType
static PersonAttribute	DEPARTMENT department
static PersonAttribute	DEPARTMENT_NUMBER departmentNumber
static PersonAttribute	DISPLAY_NAME displayName
static PersonAttribute	EDU_PERSON_AFFILIATION eduPersonAffiliation
static PersonAttribute	EDU_PERSON_PRIMARY_AFFILIATION eduPersonPrimaryAffiliation
static PersonAttribute	EDU_PERSON_PRINCIPAL_NAME eduPersonPrincipalName
static PersonAttribute	EXPIRATION_DATE expirationDate
static PersonAttribute	FACSIMILE_TELEPHONE_NUMBER facsimileTelephoneNumber
static PersonAttribute	GIVEN_NAME givenName
static PersonAttribute	GROUP_ADD_DATE groupAddDate
static PersonAttribute	GROUP_EXPIRE_DATE groupExpireDate
static PersonAttribute	GROUP_MEMBERSHIP groupMembership
static PersonAttribute	GUEST_ID guestId
static PersonAttribute	HOME_FAX homeFax
static PersonAttribute	HOME_MOBILE homeMobile
static PersonAttribute	HOME_PAGER homePager
static PersonAttribute	HOME_PHONE homePhone
static PersonAttribute	HOME_POSTAL_ADDRESS homePostalAddress
static PersonAttribute	INITIALS initials
static PersonAttribute	INSTANT_MESSAGING_ID instantMessagingID
static PersonAttribute	JPEG_PHOTO jpegPhoto
static PersonAttribute	L l
static PersonAttribute	LABELED_URI labeledURI
static PersonAttribute	LAST_ENROLLMENT_TERM lastEnrollmentTerm
static PersonAttribute	LAST_ENROLLMENT_TERM_CODE lastEnrollmentTermCode
static PersonAttribute	LEGAL_NAME legalName
static PersonAttribute	LOCAL_FAX localFAX
static PersonAttribute	LOCAL_MOBILE localMobile
static PersonAttribute	LOCAL_PAGER localPager
static PersonAttribute	LOCAL_PHONE localPhone
static PersonAttribute	LOCAL_POSTAL_ADDRESS localPostalAddress
static PersonAttribute	MAIL mail
static PersonAttribute	MAIL_ACCOUNT mailAccount
static PersonAttribute	MAIL_ALIAS mailAlias
static PersonAttribute	MAIL_FORWARDING_ADDRESS mailForwardingAddress
static PersonAttribute	MAIL_PREFERRED_ADDRESS mailPreferredAddress
static PersonAttribute	MAIL_STOP mailStop
static PersonAttribute	MAJOR major
static PersonAttribute	MAJOR_CODE majorCode
static PersonAttribute	MIDDLE_NAME middleName
static PersonAttribute	MOBILE mobile
static PersonAttribute	NEXT_ENROLLMENT_TERM nextEnrollmentTerm
static PersonAttribute	NEXT_ENROLLMENT_TERM_CODE nextEnrollmentTermCode
static DataType[]	NON_VIEWABLE_TYPES all non-viewable types
static PersonAttribute	OBJECT_CLASS objectClass
static PersonAttribute	PAGER pager
static PersonAttribute	PASSWORD_STATE passwordState
static PersonAttribute	PERSON_DATA personData
static PersonAttribute	PERSON_TYPE personType
static PersonAttribute	POST_OFFICE_BOX postOfficeBox
static PersonAttribute	POSTAL_ADDRESS postalAddress
static PersonAttribute	POSTAL_CODE postalCode
static PersonAttribute	PREFERRED_LANGUAGE preferredLanguage
static PersonAttribute	PUBLIC_KEY publicKey
static PersonAttribute	RESPONSIBLE_PERSON responsiblePerson
private static long	serialVersionUID serial version UID
static PersonAttribute	SN sn
static PersonAttribute	ST st
static PersonAttribute	STREET street
static PersonAttribute	SUPPRESS_DISPLAY suppressDisplay
static PersonAttribute	SUPPRESS_EMPLOYEE_DISPLAY suppressEmployeeDisplay
static PersonAttribute	SUPPRESSED_ATTRIBUTE suppressedAttribute
static PersonAttribute	TELEPHONE_NUMBER telephoneNumber
static PersonAttribute	TITLE title
static PersonAttribute	UID uid
static PersonAttribute	UNDERGRADUATE_LEVEL undergraduateLevel
static PersonAttribute	USER_CERTIFICATE userCertificate
static PersonAttribute	USER_PASSWORD userCertificate
static PersonAttribute	USER_SMIME_CERTIFICATE userSMIMECertificate
static PersonAttribute	UUPID uupid
static DataType[]	VIEWABLE_TYPES all viewable types
static PersonAttribute	VIRGNIA_TECH_ID virginiaTechID

Fields inherited from class edu.vt.middleware.ed.AbstractDataType

HASH_CODE_SEED

Constructor Summary

protected	PersonAttribute() Default constructor.
protected	PersonAttribute(String name, String description) This creates a PersonAttribute with the supplied name and description.

Method Summary

String	getAttributeDescription() This returns the attribute description.
String	getAttributeName() This returns the attribute name.
static PersonAttribute	getDataType(String typeCode) This returns the person attribute type for the supplied type code.

Methods inherited from class edu.vt.middleware.ed.AbstractAttribute

setAttributeDescription, setAttributeName

Methods inherited from class edu.vt.middleware.ed.AbstractDataType

compareTo, equals, getDataType, getTypeCode, getTypeName, hashCode, setTypeCode, setTypeName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

BASE_DN

public static final PersonAttribute BASE_DN

baseDn

OBJECT_CLASS

public static final PersonAttribute OBJECT_CLASS

objectClass

ACCOUNT_CREATION_DATE

public static final PersonAttribute ACCOUNT_CREATION_DATE

accountCreationDate

ACCOUNT_EXPIRATION_DATE

public static final PersonAttribute ACCOUNT_EXPIRATION_DATE

accountExpirationDate

ACCOUNT_SHELVE_DATE

public static final PersonAttribute ACCOUNT_SHELVE_DATE

accountShelveDate

ACCOUNT_STATE

public static final PersonAttribute ACCOUNT_STATE

accountState

ADDRESS

public static final PersonAttribute ADDRESS

address

AUTH_ID

public static final PersonAttribute AUTH_ID

authId

BANNER_PIDM

public static final PersonAttribute BANNER_PIDM

bannerPIDM

C

public static final PersonAttribute C

c

CAMPUS

public static final PersonAttribute CAMPUS

campus

CHAP_SECRET

public static final PersonAttribute CHAP_SECRET

chapSecret

CLASS_LEVEL

public static final PersonAttribute CLASS_LEVEL

classLevel

CLASS_LEVEL_CODE

public static final PersonAttribute CLASS_LEVEL_CODE

classLevelCode

CN

public static final PersonAttribute CN

cn

CREATION_DATE

public static final PersonAttribute CREATION_DATE

creationDate

DATE_OF_BIRTH

public static final PersonAttribute DATE_OF_BIRTH

dateOfBirth

DEGREE_TYPE

public static final PersonAttribute DEGREE_TYPE

degreeType

DEPARTMENT

public static final PersonAttribute DEPARTMENT

department

DEPARTMENT_NUMBER

public static final PersonAttribute DEPARTMENT_NUMBER

departmentNumber

DISPLAY_NAME

public static final PersonAttribute DISPLAY_NAME

displayName

EDU_PERSON_AFFILIATION

public static final PersonAttribute EDU_PERSON_AFFILIATION

eduPersonAffiliation

EDU_PERSON_PRIMARY_AFFILIATION

public static final PersonAttribute EDU_PERSON_PRIMARY_AFFILIATION

eduPersonPrimaryAffiliation

EDU_PERSON_PRINCIPAL_NAME

public static final PersonAttribute EDU_PERSON_PRINCIPAL_NAME

eduPersonPrincipalName

EXPIRATION_DATE

public static final PersonAttribute EXPIRATION_DATE

expirationDate

FACSIMILE_TELEPHONE_NUMBER

public static final PersonAttribute FACSIMILE_TELEPHONE_NUMBER

facsimileTelephoneNumber

GIVEN_NAME

public static final PersonAttribute GIVEN_NAME

givenName

GROUP_ADD_DATE

public static final PersonAttribute GROUP_ADD_DATE

groupAddDate

GROUP_EXPIRE_DATE

public static final PersonAttribute GROUP_EXPIRE_DATE

groupExpireDate

GROUP_MEMBERSHIP

public static final PersonAttribute GROUP_MEMBERSHIP

groupMembership

GUEST_ID

public static final PersonAttribute GUEST_ID

guestId

HOME_FAX

public static final PersonAttribute HOME_FAX

homeFax

HOME_MOBILE

public static final PersonAttribute HOME_MOBILE

homeMobile

HOME_PAGER

public static final PersonAttribute HOME_PAGER

homePager

HOME_PHONE

public static final PersonAttribute HOME_PHONE

homePhone

HOME_POSTAL_ADDRESS

public static final PersonAttribute HOME_POSTAL_ADDRESS

homePostalAddress

INITIALS

public static final PersonAttribute INITIALS

initials

INSTANT_MESSAGING_ID

public static final PersonAttribute INSTANT_MESSAGING_ID

instantMessagingID

JPEG_PHOTO

public static final PersonAttribute JPEG_PHOTO

jpegPhoto

L

public static final PersonAttribute L

l

LABELED_URI

public static final PersonAttribute LABELED_URI

labeledURI

LAST_ENROLLMENT_TERM

public static final PersonAttribute LAST_ENROLLMENT_TERM

lastEnrollmentTerm

LAST_ENROLLMENT_TERM_CODE

public static final PersonAttribute LAST_ENROLLMENT_TERM_CODE

lastEnrollmentTermCode

LEGAL_NAME

public static final PersonAttribute LEGAL_NAME

legalName

LOCAL_FAX

public static final PersonAttribute LOCAL_FAX

localFAX

LOCAL_MOBILE

public static final PersonAttribute LOCAL_MOBILE

localMobile

LOCAL_PAGER

public static final PersonAttribute LOCAL_PAGER

localPager

LOCAL_PHONE

public static final PersonAttribute LOCAL_PHONE

localPhone

LOCAL_POSTAL_ADDRESS

public static final PersonAttribute LOCAL_POSTAL_ADDRESS

localPostalAddress

MAIL

public static final PersonAttribute MAIL

mail

MAIL_ACCOUNT

public static final PersonAttribute MAIL_ACCOUNT

mailAccount

MAIL_ALIAS

public static final PersonAttribute MAIL_ALIAS

mailAlias

MAIL_FORWARDING_ADDRESS

public static final PersonAttribute MAIL_FORWARDING_ADDRESS

mailForwardingAddress

MAIL_PREFERRED_ADDRESS

public static final PersonAttribute MAIL_PREFERRED_ADDRESS

mailPreferredAddress

MAIL_STOP

public static final PersonAttribute MAIL_STOP

mailStop

MAJOR

public static final PersonAttribute MAJOR

major

MAJOR_CODE

public static final PersonAttribute MAJOR_CODE

majorCode

MIDDLE_NAME

public static final PersonAttribute MIDDLE_NAME

middleName

MOBILE

public static final PersonAttribute MOBILE

mobile

NEXT_ENROLLMENT_TERM

public static final PersonAttribute NEXT_ENROLLMENT_TERM

nextEnrollmentTerm

NEXT_ENROLLMENT_TERM_CODE

public static final PersonAttribute NEXT_ENROLLMENT_TERM_CODE

nextEnrollmentTermCode

PAGER

public static final PersonAttribute PAGER

pager

PASSWORD_STATE

public static final PersonAttribute PASSWORD_STATE

passwordState

PERSON_DATA

public static final PersonAttribute PERSON_DATA

personData

PERSON_TYPE

public static final PersonAttribute PERSON_TYPE

personType

POSTAL_ADDRESS

public static final PersonAttribute POSTAL_ADDRESS

postalAddress

POSTAL_CODE

public static final PersonAttribute POSTAL_CODE

postalCode

POST_OFFICE_BOX

public static final PersonAttribute POST_OFFICE_BOX

postOfficeBox

PREFERRED_LANGUAGE

public static final PersonAttribute PREFERRED_LANGUAGE

preferredLanguage

PUBLIC_KEY

public static final PersonAttribute PUBLIC_KEY

publicKey

RESPONSIBLE_PERSON

public static final PersonAttribute RESPONSIBLE_PERSON

responsiblePerson

SN

public static final PersonAttribute SN

sn

ST

public static final PersonAttribute ST

st

STREET

public static final PersonAttribute STREET

street

SUPPRESS_DISPLAY

public static final PersonAttribute SUPPRESS_DISPLAY

suppressDisplay

SUPPRESSED_ATTRIBUTE

public static final PersonAttribute SUPPRESSED_ATTRIBUTE

suppressedAttribute

SUPPRESS_EMPLOYEE_DISPLAY

public static final PersonAttribute SUPPRESS_EMPLOYEE_DISPLAY

suppressEmployeeDisplay

TELEPHONE_NUMBER

public static final PersonAttribute TELEPHONE_NUMBER

telephoneNumber

TITLE

public static final PersonAttribute TITLE

title

UID

public static final PersonAttribute UID

uid

UNDERGRADUATE_LEVEL

public static final PersonAttribute UNDERGRADUATE_LEVEL

undergraduateLevel

USER_CERTIFICATE

public static final PersonAttribute USER_CERTIFICATE

userCertificate

USER_PASSWORD

public static final PersonAttribute USER_PASSWORD

userCertificate

USER_SMIME_CERTIFICATE

public static final PersonAttribute USER_SMIME_CERTIFICATE

userSMIMECertificate

UUPID

public static final PersonAttribute UUPID

uupid

VIRGNIA_TECH_ID

public static final PersonAttribute VIRGNIA_TECH_ID

virginiaTechID

NON_VIEWABLE_TYPES

public static final DataType[] NON_VIEWABLE_TYPES

all non-viewable types

VIEWABLE_TYPES

public static final DataType[] VIEWABLE_TYPES

all viewable types

ALL_TYPES

public static final DataType[] ALL_TYPES

all types

serialVersionUID

private static final long serialVersionUID

serial version UID

See Also:

Constant Field Values

Constructor Detail

PersonAttribute

protected PersonAttribute()

Default constructor.

PersonAttribute

protected PersonAttribute(String name,
                          String description)

This creates a PersonAttribute with the supplied name and description.

Parameters:

name - String

description - String

Method Detail

getDataType

public static PersonAttribute getDataType(String typeCode)

This returns the person attribute type for the supplied type code.

Parameters:

typeCode - String

Returns:

PersonAttribute

getAttributeName

public String getAttributeName()

This returns the attribute name.

Specified by:

getAttributeName in interface Attribute

Overrides:

getAttributeName in class AbstractAttribute

Returns:

String - name

getAttributeDescription

public String getAttributeDescription()

This returns the attribute description.

Specified by:

getAttributeDescription in interface Attribute

Overrides:

getAttributeDescription in class AbstractAttribute

Returns:

String - description