org.kuali.student.core.person.dto
Class PersonReferenceIdInfo

java.lang.Object
  org.kuali.student.core.person.dto.PersonReferenceIdInfo

All Implemented Interfaces:

Serializable, HasAttributes, HasTypeState, Idable

public class PersonReferenceIdInfo
extends Object
implements Serializable, Idable, HasTypeState, HasAttributes

Information about an external identifier for a person.

See Also:

Serialized Form

Field Summary

private String	assigningOrg
private Map<String,String>	attributes
private Date	effectiveDate
private Date	expirationDate
private String	id
private MetaInfo	metaInfo
private String	personReferenceId
private static long	serialVersionUID
private String	state
private String	type

Constructor Summary

PersonReferenceIdInfo()

Method Summary

String	getAssigningOrg() Organizational unit that assigned the reference id (e.g.
Map<String,String>	getAttributes() List of key/value pairs, typically used for dynamic attributes.
Date	getEffectiveDate() Date and time that this person reference identifier became effective.
Date	getExpirationDate() Date and time that this person reference identifier expires.
String	getId() The page personReferenceIdId Structure does not exist.
MetaInfo	getMetaInfo() Create and last update info for the structure.
String	getPersonReferenceId() External identifier for a person.
String	getState() The current status of the person reference identifier.
String	getType() Identifier of the type of reference id (e.g.
void	setAssigningOrg(String assigningOrg)
void	setAttributes(Map<String,String> attributes)
void	setEffectiveDate(Date effectiveDate)
void	setExpirationDate(Date expirationDate)
void	setId(String id)
void	setMetaInfo(MetaInfo metaInfo)
void	setPersonReferenceId(String personReferenceId)
void	setState(String state)
void	setType(String type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

personReferenceId

private String personReferenceId

assigningOrg

private String assigningOrg

effectiveDate

private Date effectiveDate

expirationDate

private Date expirationDate

attributes

private Map<String,String> attributes

metaInfo

private MetaInfo metaInfo

type

private String type

state

private String state

id

private String id

Constructor Detail

PersonReferenceIdInfo

public PersonReferenceIdInfo()

Method Detail

getPersonReferenceId

public String getPersonReferenceId()

External identifier for a person.

setPersonReferenceId

public void setPersonReferenceId(String personReferenceId)

getAssigningOrg

public String getAssigningOrg()

Organizational unit that assigned the reference id (e.g. US government for SSNs, institution code for another institution assigning their student number). This might be the actual OrgId, but are making the type loose to avoid coupling

setAssigningOrg

public void setAssigningOrg(String assigningOrg)

getEffectiveDate

public Date getEffectiveDate()

Date and time that this person reference identifier became effective. This is a similar concept to the effective date on enumerated values. When an expiration date has been specified, this field must be less than or equal to the expiration date.

setEffectiveDate

public void setEffectiveDate(Date effectiveDate)

getExpirationDate

public Date getExpirationDate()

Date and time that this person reference identifier expires. This is a similar concept to the expiration date on enumerated values. If specified, this should be greater than or equal to the effective date. If this field is not specified, then no expiration date has been currently defined and should automatically be considered greater than the effective date.

setExpirationDate

public void setExpirationDate(Date expirationDate)

getAttributes

public Map<String,String> getAttributes()

List of key/value pairs, typically used for dynamic attributes.

Specified by:

getAttributes in interface HasAttributes

setAttributes

public void setAttributes(Map<String,String> attributes)

Specified by:

setAttributes in interface HasAttributes

getMetaInfo

public MetaInfo getMetaInfo()

Create and last update info for the structure.

setMetaInfo

public void setMetaInfo(MetaInfo metaInfo)

getType

public String getType()

Identifier of the type of reference id (e.g. SSN, SIN, post secondary institution student number, etc.)

Specified by:

getType in interface HasTypeState

setType

public void setType(String type)

Specified by:

setType in interface HasTypeState

getState

public String getState()

The current status of the person reference identifier. The values for this field are constrained to those in the personReferenceIdState enumeration. A separate setup operation does not exist for retrieval of the meta data around this value.

Specified by:

getState in interface HasTypeState

setState

public void setState(String state)

Specified by:

setState in interface HasTypeState

getId

public String getId()

The page personReferenceIdId Structure does not exist. Optional due to assignment at creation time. Once the person reference has been created, this field should no longer be treated as optional.

Specified by:

getId in interface Idable

setId

public void setId(String id)

Specified by:

setId in interface Idable