org.kuali.student.core.comment.dto
Class CommentInfo

java.lang.Object
  org.kuali.student.core.comment.dto.CommentInfo

All Implemented Interfaces:

Serializable, HasAttributes, HasTypeState, Idable

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

Detailed information about a comment.

See Also:

Serialized Form

Field Summary

private Map<String,String>	attributes
private RichTextInfo	commentText
private Date	effectiveDate
private Date	expirationDate
private String	id
private MetaInfo	metaInfo
private String	referenceId
private String	referenceTypeKey
private static long	serialVersionUID
private String	state
private String	type

Constructor Summary

CommentInfo()

Method Summary

Map<String,String>	getAttributes() List of key/value pairs, typically used for dynamic attributes.
RichTextInfo	getCommentText() Narrative text of the comment
Date	getEffectiveDate() Date and time that this comment became effective.
Date	getExpirationDate() Date and time that this comment expires.
String	getId() Unique identifier for a comment.
MetaInfo	getMetaInfo() Create and last update info for the structure.
String	getReferenceId() Identifier component for a reference.
String	getReferenceTypeKey() Unique identifier for a reference type.
String	getState() The current status of the comment.
String	getType() Unique identifier for a comment type.
void	setAttributes(Map<String,String> attributes)
void	setCommentText(RichTextInfo commentText)
void	setEffectiveDate(Date effectiveDate)
void	setExpirationDate(Date expirationDate)
void	setId(String id)
void	setMetaInfo(MetaInfo metaInfo)
void	setReferenceId(String referenceId)
void	setReferenceTypeKey(String referenceTypeKey)
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

commentText

private RichTextInfo commentText

referenceTypeKey

private String referenceTypeKey

referenceId

private String referenceId

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

CommentInfo

public CommentInfo()

Method Detail

getCommentText

public RichTextInfo getCommentText()

Narrative text of the comment

setCommentText

public void setCommentText(RichTextInfo commentText)

getReferenceTypeKey

public String getReferenceTypeKey()

Unique identifier for a reference type.

setReferenceTypeKey

public void setReferenceTypeKey(String referenceTypeKey)

getReferenceId

public String getReferenceId()

Identifier component for a reference. This is an external identifier and such may not uniquely identify a particular reference unless combined with the type. A referenceId could be a cluId, a luiId, an orgId, a documentId, etc.

setReferenceId

public void setReferenceId(String referenceId)

getEffectiveDate

public Date getEffectiveDate()

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