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

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

All Implemented Interfaces:

Serializable, HasAttributes, HasTypeState, Idable

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

Detailed information about a person to person relationship.

See Also:

Serialized Form

Field Summary

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

Constructor Summary

PersonRelationInfo()

Method Summary

Map<String,String>	getAttributes() List of key/value pairs, typically used for dynamic attributes.
Date	getEffectiveDate() Date and time that this person to person relationship became effective.
Date	getExpirationDate() Date and time that this person to person relationship expires.
String	getId() Unique identifier for a person to person relationship.
MetaInfo	getMetaInfo() Create and last update info for the structure.
String	getPersonId() Unique identifier for a person record.
String	getRelatedPersonId() Unique identifier for a person record.
String	getState() The current status of the relationship.
String	getType() Identifier for a person to person relationship type.
void	setAttributes(Map<String,String> attributes)
void	setEffectiveDate(Date effectiveDate)
void	setExpirationDate(Date expirationDate)
void	setId(String id)
void	setMetaInfo(MetaInfo metaInfo)
void	setPersonId(String personId)
void	setRelatedPersonId(String relatedPersonId)
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

relatedPersonId

private String relatedPersonId

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

PersonRelationInfo

public PersonRelationInfo()

Method Detail

getPersonId

public String getPersonId()

Unique identifier for a person record.

setPersonId

public void setPersonId(String personId)

getRelatedPersonId

public String getRelatedPersonId()

Unique identifier for a person record.

setRelatedPersonId

public void setRelatedPersonId(String relatedPersonId)

getEffectiveDate

public Date getEffectiveDate()

Date and time that this person to person relationship 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 to person relationship 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()

Identifier for a person to person relationship 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 relationship. The values for this field are constrained to those in the personRelationState 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 a person to person relationship. This is optional, due to the identifier being set at the time of creation. Once the relation has been created, this should be seen as required.

Specified by:

getId in interface Idable

setId

public void setId(String id)

Specified by:

setId in interface Idable