org.kuali.student.lum.lrc.dto
Class ResultComponentInfo

java.lang.Object
  org.kuali.student.lum.lrc.dto.ResultComponentInfo

All Implemented Interfaces:

Serializable, HasAttributes, HasTypeState, Idable

public class ResultComponentInfo
extends Object
implements Serializable, Idable, HasTypeState, HasAttributes

Detailed information about a result component.

See Also:

Serialized Form

Field Summary

private Map<String,String>	attributes
private RichTextInfo	desc
private Date	effectiveDate
private Date	expirationDate
private String	id
private MetaInfo	metaInfo
private String	name
private List<String>	resultValues
private static long	serialVersionUID
private String	state
private String	type

Constructor Summary

ResultComponentInfo()

Method Summary

Map<String,String>	getAttributes() List of key/value pairs, typically used for dynamic attributes.
RichTextInfo	getDesc() Narrative description of the result component
Date	getEffectiveDate() Date and time that this result component became effective.
Date	getExpirationDate() Date and time that this result component expires.
String	getId() Unique identifier for a result component.
MetaInfo	getMetaInfo() Create and last update info for the structure.
String	getName() Friendly name of the result component
List<String>	getResultValues() List of result values
String	getState() The current status of the result component.
String	getType() Unique identifier for a result component type.
void	setAttributes(Map<String,String> attributes)
void	setDesc(RichTextInfo desc)
void	setEffectiveDate(Date effectiveDate)
void	setExpirationDate(Date expirationDate)
void	setId(String id)
void	setMetaInfo(MetaInfo metaInfo)
void	setName(String name)
void	setResultValues(List<String> resultValues)
void	setState(String state)
void	setType(String type)

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

name

private String name

desc

private RichTextInfo desc

resultValues

private List<String> resultValues

effectiveDate

private Date effectiveDate

expirationDate

private Date expirationDate

attributes

private Map<String,String> attributes

metaInfo

private MetaInfo metaInfo

type

private String type

state

private String state

id

private String id

Constructor Detail

ResultComponentInfo

public ResultComponentInfo()

Method Detail

getName

public String getName()

Friendly name of the result component

setName

public void setName(String name)

getDesc

public RichTextInfo getDesc()

Narrative description of the result component

setDesc

public void setDesc(RichTextInfo desc)

getResultValues

public List<String> getResultValues()

List of result values

setResultValues

public void setResultValues(List<String> resultValues)

getEffectiveDate

public Date getEffectiveDate()

Date and time that this result component became effective. This is a similar concept to the effective date on enumerated values. When an expiration date has been specified, this field must be less than or equal to the expiration date.

setEffectiveDate

public void setEffectiveDate(Date effectiveDate)

getExpirationDate

public Date getExpirationDate()

Date and time that this result component expires. This is a similar concept to the expiration date on enumerated values. If specified, this should be greater than or equal to the effective date. If this field is not specified, then no expiration date has been currently defined and should automatically be considered greater than the effective date.

setExpirationDate

public void setExpirationDate(Date expirationDate)

getAttributes

public Map<String,String> getAttributes()

List of key/value pairs, typically used for dynamic attributes.

Specified by:

getAttributes in interface HasAttributes

setAttributes

public void setAttributes(Map<String,String> attributes)

Specified by:

setAttributes in interface HasAttributes

getMetaInfo

public MetaInfo getMetaInfo()

Create and last update info for the structure. This is optional and treated as read only since the data is set by the internals of the service during maintenance operations.

setMetaInfo

public void setMetaInfo(MetaInfo metaInfo)

getType

public String getType()

Unique identifier for a result component type.

Specified by:

getType in interface HasTypeState

setType

public void setType(String type)

Specified by:

setType in interface HasTypeState

getState

public String getState()

The current status of the result component. The values for this field are constrained to those in the state enumeration. A separate setup operation does not exist for retrieval of the meta data around this value.

Specified by:

getState in interface HasTypeState

setState

public void setState(String state)

Specified by:

setState in interface HasTypeState

getId

public String getId()

Unique identifier for a result component. This is optional, due to the identifier being set at the time of creation. Once the result component has been created, this should be seen as required.

Specified by:

getId in interface Idable

setId

public void setId(String id)

Specified by:

setId in interface Idable