org.kuali.student.r2.common.infc

Interface HasKey

All Superinterfaces:

HasPrimaryKey

All Known Subinterfaces:

Enumeration, Fee, GradeValuesGroup, KeyEntity, KeyNamelessEntity, Lifecycle, LoRepository, OrgCode, Process, ResultScale, ResultValue, ResultValuesGroup, State, StateProcess, Type

All Known Implementing Classes:

EnumerationInfo, FeeInfo, GradeValuesGroupInfo, KeyEntityInfo, KeyNamelessEntityInfo, LifecycleInfo, LoRepositoryInfo, OrgCodeInfo, ProcessInfo, ResultScaleInfo, ResultValueInfo, ResultValuesGroupInfo, StateInfo, TypeInfo

public interface HasKey
extends HasPrimaryKey

Common service pattern for entities. This interface is applied to entites that are identified by a Key.

Author:

nwright

Method Summary

Methods

Modifier and Type	Method and Description
String	getKey() Unique key to this object.

Method Detail

getKey

String getKey()

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.