org.kuali.student.core.enumerationmanagement.dto
Class EnumeratedValueInfo

java.lang.Object
  org.kuali.student.core.enumerationmanagement.dto.EnumeratedValueInfo

All Implemented Interfaces:

Serializable

public class EnumeratedValueInfo
extends Object
implements Serializable

Value associated with a particular enumeration.

See Also:

Serialized Form

Field Summary

private String	abbrevValue
private String	code
private List<EnumContextValueInfo>	contexts
private Date	effectiveDate
private String	enumerationKey
private Date	expirationDate
private static long	serialVersionUID
private String	sortKey
private String	value

Constructor Summary

EnumeratedValueInfo()

Method Summary

String	getAbbrevValue() Typically coincides with a shortened name.
String	getCode() Typically coincides with a code representation.
List<EnumContextValueInfo>	getContexts() Indicates which context types and values this particular enumerated value participates in.
Date	getEffectiveDate() Date that this enumerated value became effective.
String	getEnumerationKey()
Date	getExpirationDate() Date that this enumerated value expires.
String	getSortKey() Default position for the enumerated value.
String	getValue() Typically coincides with a name for display.
void	setAbbrevValue(String abbrevValue)
void	setCode(String code)
void	setContexts(List<EnumContextValueInfo> contexts)
void	setEffectiveDate(Date effectiveDate)
void	setEnumerationKey(String enumerationKey)
void	setExpirationDate(Date expirationDate)
void	setSortKey(String sortKey)
void	setValue(String value)

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

code

private String code

abbrevValue

private String abbrevValue

value

private String value

effectiveDate

private Date effectiveDate

expirationDate

private Date expirationDate

sortKey

private String sortKey

contexts

private List<EnumContextValueInfo> contexts

enumerationKey

private String enumerationKey

Constructor Detail

EnumeratedValueInfo

public EnumeratedValueInfo()

Method Detail

getCode

public String getCode()

Typically coincides with a code representation. Likely the key if this is a reference to another object.

setCode

public void setCode(String code)

getAbbrevValue

public String getAbbrevValue()

Typically coincides with a shortened name. May be equal to the code or value fields.

setAbbrevValue

public void setAbbrevValue(String abbrevValue)

getValue

public String getValue()

Typically coincides with a name for display.

setValue

public void setValue(String value)

getEffectiveDate

public Date getEffectiveDate()

Date that this enumerated value became effective. If referring to another object, this may correspond with the effective date, created date, date of a state transition, or some arbitrarily defined date. For code/value pairs with no dates, the current date may be returned.

setEffectiveDate

public void setEffectiveDate(Date effectiveDate)

getExpirationDate

public Date getExpirationDate()

Date that this enumerated value expires. If referring to another object, this may correspond with the expiration date, date of a state transition, or some arbitrarily defined date. If this field is not specified, then no expiration date has been currently defined. For code/value pairs with no dates, this date may not be specified.

setExpirationDate

public void setExpirationDate(Date expirationDate)

getSortKey

public String getSortKey()

Default position for the enumerated value. This might or might not exist, particularly in cases where the enumeration consists solely of a view.

setSortKey

public void setSortKey(String sortKey)

getContexts

public List<EnumContextValueInfo> getContexts()

Indicates which context types and values this particular enumerated value participates in.

setContexts

public void setContexts(List<EnumContextValueInfo> contexts)

getEnumerationKey

public String getEnumerationKey()

setEnumerationKey

public void setEnumerationKey(String enumerationKey)