org.kuali.student.contract.model.test.source
Class RelationshipInfo

java.lang.Object
  org.kuali.student.contract.model.test.source.HasAttributesInfo
      org.kuali.student.contract.model.test.source.HasAttributesAndMetaInfo
          org.kuali.student.contract.model.test.source.RelationshipInfo

All Implemented Interfaces:

Serializable, HasAttributes, HasAttributesAndMeta, HasEffectiveDates, HasId, HasMeta, HasPrimaryKey, HasState, HasType, Relationship

Direct Known Subclasses:

LprInfo

public abstract class RelationshipInfo
extends HasAttributesAndMetaInfo
implements Relationship, Serializable

Information about a Relationship.

See Also:

Serialized Form

Nested Class Summary

static class

RelationshipInfo.Builder

Field Summary

private Date	effectiveDate
private Date	expirationDate
private String	id
private String	stateKey
private String	typeKey

Fields inherited from class org.kuali.student.contract.model.test.source.HasAttributesInfo

attributes

Constructor Summary

protected	RelationshipInfo()
protected	RelationshipInfo(Relationship builder)

Method Summary

Date	getEffectiveDate() Name:Effective Date Date/time this object became effective.
Date	getExpirationDate() Name: Expiration Date Date/time this relationship is no longer effective.
String	getId() The system assigned unique id to identify this Object.
String	getStateKey() Name: State Key Unique identifier for the state of this object.
String	getTypeKey() Unique key for the type of this object.

Methods inherited from class org.kuali.student.contract.model.test.source.HasAttributesAndMetaInfo

getMeta

Methods inherited from class org.kuali.student.contract.model.test.source.HasAttributesInfo

getAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.student.contract.model.test.source.HasAttributes

getAttributes

Methods inherited from interface org.kuali.student.contract.model.test.source.HasMeta

getMeta

Field Detail

id

private String id

typeKey

private String typeKey

stateKey

private String stateKey

effectiveDate

private final Date effectiveDate

expirationDate

private final Date expirationDate

Constructor Detail

RelationshipInfo

protected RelationshipInfo()

RelationshipInfo

protected RelationshipInfo(Relationship builder)

Method Detail

getId

public String getId()

Description copied from interface: HasId

The system assigned unique id to identify this Object. Could be implemented as as sequence number or as a UUID. Attempts to set this value on creates should result in a ReadOnlyException being thrown An Id:

• An id is used when the actual value is unimportant and can therefore be a large hex value for example
• An id value might be 23b9ca9bd203df902
• An Id is never intended to be used directly by an end user.
• Ids are assumed to be of different values in different KS implementations
• Id values are generated by the service implementations
• Id values are never expected to be used in Configuration or Application code

Specified by:

getId in interface HasId

getTypeKey

public String getTypeKey()

Description copied from interface: HasType

Unique key for the type of this object. This key must exist in the list returned by the getTypes () method for this service.

Specified by:

getTypeKey in interface HasType

getStateKey

public String getStateKey()

Description copied from interface: HasState

Name: State Key Unique identifier for the state of this object.

Specified by:

getStateKey in interface HasState

Returns:

the state

getEffectiveDate

public Date getEffectiveDate()

Description copied from interface: HasEffectiveDates

Name:Effective Date Date/time this object became effective. Must be less than or equal to the expirationDate specified.

Specified by:

getEffectiveDate in interface HasEffectiveDates

getExpirationDate

public Date getExpirationDate()

Description copied from interface: HasEffectiveDates

Name: Expiration Date Date/time this relationship is no longer effective. Must be greater than or equal to the effectiveDate specified.

Specified by:

getExpirationDate in interface HasEffectiveDates