org.kuali.student.common.dto
Class KeyEntityInfo

java.lang.Object
  org.kuali.student.common.dto.HasAttributesInfo
      org.kuali.student.common.dto.HasAttributesAndMetaInfo
          org.kuali.student.common.dto.EntityInfo
              org.kuali.student.common.dto.KeyEntityInfo

All Implemented Interfaces:

Serializable, Entity, HasAttributes, HasAttributesAndMeta, HasKey, HasMeta, HasPrimaryKey, HasState, HasType, KeyEntity

Direct Known Subclasses:

AcademicCalendarInfo, AtpInfo, CampusCalendarInfo, HolidayInfo, KeyDateInfo, MilestoneInfo, TermInfo, TypeTypeRelationInfo

public abstract class KeyEntityInfo
extends EntityInfo
implements KeyEntity, Serializable

See Also:

Serialized Form

Nested Class Summary

static class

KeyEntityInfo.Builder The builder class for this abstract EntityInfo.

Field Summary

private String

key

Fields inherited from class org.kuali.student.common.dto.HasAttributesInfo

attributes

Constructor Summary

protected	KeyEntityInfo()
protected	KeyEntityInfo(KeyEntity builder)

Method Summary

String

getKey() Name: Key Unique key to this object.

Methods inherited from class org.kuali.student.common.dto.EntityInfo

getDescr, getName, getStateKey, getTypeKey

Methods inherited from class org.kuali.student.common.dto.HasAttributesAndMetaInfo

getMetaInfo

Methods inherited from class org.kuali.student.common.dto.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.common.infc.Entity

getDescr, getName

Methods inherited from interface org.kuali.student.common.infc.HasType

getTypeKey

Methods inherited from interface org.kuali.student.common.infc.HasState

getStateKey

Methods inherited from interface org.kuali.student.common.infc.HasAttributes

getAttributes

Methods inherited from interface org.kuali.student.common.infc.HasMeta

getMetaInfo

Field Detail

key

private String key

Constructor Detail

KeyEntityInfo

protected KeyEntityInfo()

KeyEntityInfo

protected KeyEntityInfo(KeyEntity builder)

Method Detail

getKey

public String getKey()

Description copied from interface: HasKey

Name: Key Unique key to this object. Unlike an Id this key can be explicitly set by the application and is intended to be "somewhat" readable by a human. A Key:

• A Key is used when the actual value is important
• A Key value might be kuali.org.School
• A Key on occasion may be used or seen by an end user.
• Keys are assumed to have the same values in different KS implementations
• Key values are defined in configuration
• Key values have significance in that they are referenced in Configuration
• Key values are expected to be occasionally used in application code

Specified by:

getKey in interface HasKey