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

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

All Implemented Interfaces:

Serializable, HasAttributes, HasTypeState, Idable

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

Detailed information about a student's residency.

See Also:

Serialized Form

Field Summary

private Map<String,String>	attributes
private String	determinationMethod
private Date	effectiveDate
private Date	expirationDate
private String	id
private String	inStateFlag
private MetaInfo	metaInfo
private String	personId
private static long	serialVersionUID
private String	state
private String	type

Constructor Summary

PersonResidencyInfo()

Method Summary

Map<String,String>	getAttributes() List of key/value pairs, typically used for dynamic attributes.
String	getDeterminationMethod() Source or proof to determine residency.
Date	getEffectiveDate() Date and time that this residency record became effective.
Date	getExpirationDate() Date and time that this residency record expires.
String	getId() Unique identifier for the residency record.
String	getInStateFlag() Flag indicates whether a student is considered to reside in state.
MetaInfo	getMetaInfo() Create and last update info for the structure.
String	getPersonId() Unique identifier for a person record.
String	getState() The current status of the residency record.
String	getType() Key code for the residency type.
void	setAttributes(Map<String,String> attributes)
void	setDeterminationMethod(String determinationMethod)
void	setEffectiveDate(Date effectiveDate)
void	setExpirationDate(Date expirationDate)
void	setId(String id)
void	setInStateFlag(String inStateFlag)
void	setMetaInfo(MetaInfo metaInfo)
void	setPersonId(String personId)
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

personId

private String personId

determinationMethod

private String determinationMethod

inStateFlag

private String inStateFlag

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

PersonResidencyInfo

public PersonResidencyInfo()

Method Detail

getPersonId

public String getPersonId()

Unique identifier for a person record. This is optional, due to the identifier being set at the time of creation of the person. Once the person has been created, this should be seen as required.

setPersonId

public void setPersonId(String personId)

getDeterminationMethod

public String getDeterminationMethod()

Source or proof to determine residency.

setDeterminationMethod

public void setDeterminationMethod(String determinationMethod)

getInStateFlag

public String getInStateFlag()

Flag indicates whether a student is considered to reside in state.

setInStateFlag

public void setInStateFlag(String inStateFlag)

getEffectiveDate

public Date getEffectiveDate()

Date and time that this residency record 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 residency record expires. This is a similar concept to the expiration date on enumerated values. If specified, this must 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. This is optional and treated as read only since the data is set by the internals of the service during maintenance operations.

setMetaInfo

public void setMetaInfo(MetaInfo metaInfo)

getType

public String getType()

Key code for the residency type.

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 residency record. The values for this field are constrained to those in the personResidencyState 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()

Unique identifier for the residency record. This is set by the service to be able to determine changes and alterations to the structure as well as provides a handle for searches. This structure is not accessible through unique operations, and it is strongly recommended that no external references to this particular identifier be maintained. Once this identifier is set by the service, it should be seen as required and readonly.

Specified by:

getId in interface Idable

setId

public void setId(String id)

Specified by:

setId in interface Idable