org.kuali.student.r2.common.dto
Class KeyEntityInfo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DocumentCategoryInfo, EnumerationInfo, GradeValuesGroupInfo, LoRepositoryInfo, ProcessInfo, ResultScaleInfo, ResultValueInfo, ResultValuesGroupInfo

public abstract class KeyEntityInfo
extends EntityInfo
implements KeyEntity, Serializable

Provides basic method for entities identified by a key.

Author:

tom

See Also:

Serialized Form

Constructor Summary

KeyEntityInfo()
Constructs a new KeyEntityInfo.

KeyEntityInfo(KeyEntity keyEntity)
Constructs a new KeyEntityInfo from another KeyEntity.

Method Summary

String	getKey() Unique key to this object.
void	setKey(String key)

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

getDescr, getName, setDescr, setName

Methods inherited from class org.kuali.student.r2.common.dto.TypeStateEntityInfo

getState, getStateKey, getType, getTypeKey, setState, setStateKey, setType, setTypeKey

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

getMeta, setMeta

Methods inherited from class org.kuali.student.r2.common.dto.HasAttributesInfo

getAttributes, getAttributeValue, getAttributeValueList, setAttributes

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.r2.common.infc.Entity

getDescr, getName

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

getType, getTypeKey

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

getState, getStateKey

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

getAttributes

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

getMeta

Constructor Detail

KeyEntityInfo

public KeyEntityInfo()

Constructs a new KeyEntityInfo.

KeyEntityInfo

public KeyEntityInfo(KeyEntity keyEntity)

Constructs a new KeyEntityInfo from another KeyEntity.

Parameters:

keyEntity - the KeyEntity to copy

Method Detail

getKey

public String getKey()

Description copied from interface: HasKey

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

Once an object is created with the specified key it cannot be changed. Instead the object must be deleted or in-activated and a new object created with the right key.

Specified by:

getKey in interface HasKey

setKey

public void setKey(String key)