org.kuali.student.core.statement.dto
Class ReqComponentInfo

java.lang.Object
  org.kuali.student.core.statement.dto.ReqComponentInfo

All Implemented Interfaces:

Serializable, HasTypeState, Idable

Direct Known Subclasses:

ReqComponentInfoUi

public class ReqComponentInfo
extends Object
implements Serializable, Idable, HasTypeState

Information about a requirement component.

See Also:

Serialized Form

Field Summary

private RichTextInfo	desc
private Date	effectiveDate
private Date	expirationDate
private String	id
private MetaInfo	metaInfo
private String	naturalLanguageTranslation naturalLanguageTranslation attribute is a read-only attribute which is generated on-the-fly and should not be persisted.
private List<ReqCompFieldInfo>	reqCompFields
private static long	serialVersionUID
private String	state
private String	type

Constructor Summary

ReqComponentInfo()

Method Summary

RichTextInfo	getDesc() Narrative description of the requirement component.
Date	getEffectiveDate() Date and time that this requirement component became effective.
Date	getExpirationDate() Date and time that this requirement component expires.
String	getId() Unique identifier for a requirement component.
MetaInfo	getMetaInfo() Create and last update info for the structure.
String	getNaturalLanguageTranslation()
List<ReqCompFieldInfo>	getReqCompFields() Detailed information about a requirement component field value.
String	getState() The current status of the requirement component.
String	getType() Unique identifier for a requirement component type.
void	setDesc(RichTextInfo desc)
void	setEffectiveDate(Date effectiveDate)
void	setExpirationDate(Date expirationDate)
void	setId(String id)
void	setMetaInfo(MetaInfo metaInfo)
void	setNaturalLanguageTranslation(String naturalLanguageTranslation)
void	setReqCompFields(List<ReqCompFieldInfo> reqCompFields)
void	setState(String state)
void	setType(String type)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

desc

private RichTextInfo desc

reqCompFields

private List<ReqCompFieldInfo> reqCompFields

effectiveDate

private Date effectiveDate

expirationDate

private Date expirationDate

metaInfo

private MetaInfo metaInfo

type

private String type

state

private String state

id

private String id

naturalLanguageTranslation

private String naturalLanguageTranslation

naturalLanguageTranslation attribute is a read-only attribute which is generated on-the-fly and should not be persisted.

Constructor Detail

ReqComponentInfo

public ReqComponentInfo()

Method Detail

getDesc

public RichTextInfo getDesc()

Narrative description of the requirement component.

setDesc

public void setDesc(RichTextInfo desc)

getReqCompFields

public List<ReqCompFieldInfo> getReqCompFields()

Detailed information about a requirement component field value.

setReqCompFields

public void setReqCompFields(List<ReqCompFieldInfo> reqCompFields)

getEffectiveDate

public Date getEffectiveDate()

Date and time that this requirement 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 requirement component expires. This is a similar concept to the expiration date on enumerated values. If specified, this must 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)

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 requirement 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 requirement component. The values for this field are constrained to those in the reqComponentState 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 requirement component. This is optional, due to the identifier being set at the time of creation. Once the requirement 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

getNaturalLanguageTranslation

public String getNaturalLanguageTranslation()

setNaturalLanguageTranslation

public void setNaturalLanguageTranslation(String naturalLanguageTranslation)

toString

public String toString()

Overrides:

toString in class Object