org.kuali.student.ap.plannerreview.dto

Class ConversationCommentInfo

java.lang.Object

org.kuali.student.ap.plannerreview.dto.ConversationCommentInfo

All Implemented Interfaces:

Serializable, Comparable<ConversationCommentInfo>, ConversationComment, HasId, HasMeta, HasPrimaryKey

public class ConversationCommentInfo
extends Object
implements ConversationComment, Serializable, Comparable<ConversationCommentInfo>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConversationCommentInfo()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ConversationCommentInfo o)
String	getCommentCreateTime() Get the time that the comment was created See getTimeFromDate(java.util.Date)
int	getCommentCreationDay() Get the day of the year.
String	getCommentCreationDayDisplay() Get some date display text for when the comment was created.
RichText	getCommentText() Get the text of the comment.
String	getHumanReadableDate() Turn the comment's update time into something more suitable for human viewing See makeDateHumanReadable(java.util.Date)
String	getId() The system assigned unique id to identify this Object.
Meta	getMeta() Create and last update info for the structure.
boolean	isByAdvisor() Determine if the comment was made by the advisor or by the student.
boolean	isReadOnce() Determine if the comment has been read at least once by the other party.
void	setByAdvisor(boolean byAdvisor)
void	setCommentText(RichText commentText)
void	setId(String id)
void	setMeta(Meta meta)
void	setReadOnce(boolean readOnce)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConversationCommentInfo

public ConversationCommentInfo()

Method Detail

getId

public String getId()

Description copied from interface: HasId

The system assigned unique id to identify this Object. Could be implemented as as sequence number or as a UUID. Attempts to set this value on creates should result in a ReadOnlyException being thrown An Id:

• An id is used when the actual value is unimportant and can therefore be a large hex value for example
• An id value might be 23b9ca9bd203df902
• An Id is never intended to be used directly by an end user.
• Ids are assumed to be of different values in different KS implementations
• Id values are generated by the service implementations
• Id values are never expected to be used in Configuration or Application code

Specified by:

getId in interface HasId

setId

public void setId(String id)

getMeta

public Meta getMeta()

Description copied from interface: HasMeta

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. Contains audit trail information about the creation and last update of this object Also contains the version ind used for optimistic locking. Attempts to set or update should result in a ReadOnlyException being thrown.

Specified by:

getMeta in interface HasMeta

setMeta

public void setMeta(Meta meta)

isByAdvisor

public boolean isByAdvisor()

Description copied from interface: ConversationComment

Determine if the comment was made by the advisor or by the student.

Specified by:

isByAdvisor in interface ConversationComment

Returns:

True if the comment was made by the advisor, false if by the student.

setByAdvisor

public void setByAdvisor(boolean byAdvisor)

isReadOnce

public boolean isReadOnce()

Description copied from interface: ConversationComment

Determine if the comment has been read at least once by the other party.

Specified by:

isReadOnce in interface ConversationComment

Returns:

True if the comment has been read at least once by the other party, false if not.

setReadOnce

public void setReadOnce(boolean readOnce)

getCommentText

public RichText getCommentText()

Description copied from interface: ConversationComment

Get the text of the comment.

Specified by:

getCommentText in interface ConversationComment

Returns:

The text of the comment.

setCommentText

public void setCommentText(RichText commentText)

compareTo

public int compareTo(ConversationCommentInfo o)

Specified by:

compareTo in interface Comparable<ConversationCommentInfo>

getHumanReadableDate

public String getHumanReadableDate()

Turn the comment's update time into something more suitable for human viewing See makeDateHumanReadable(java.util.Date)

Returns:

A String representation of the update time

getCommentCreateTime

public String getCommentCreateTime()

Get the time that the comment was created See getTimeFromDate(java.util.Date)

Returns:

getCommentCreationDay

public int getCommentCreationDay()

Get the day of the year. Will be used to determine if the date "header" should be displayed that summarizes all comments for a specific day

Returns:

The integer day of the year, so February 20 would return 51

getCommentCreationDayDisplay

public String getCommentCreationDayDisplay()

Get some date display text for when the comment was created. It will have the format of "EEEE, MMM d" (Friday, April 2). If the date in question is of a different year than the current year, also add the year to the returned string.

Returns: