com.jamasoftware.contour.ws.domain

Class WsComment

java.lang.Object

com.jamasoftware.contour.ws.domain.WsComment

public class WsComment
extends Object

This object represents a Contour comment.

Author:

Dylan

Constructor Summary

Constructors

Constructor and Description
WsComment() Creates an empty WsComment object.
WsComment(String commentText, Integer documentId) Creates a new WsComment object with the given comment text and document id.
WsComment(String commentText, Integer scopeId, Integer refId) Creates a new WsComment object with the given comment text and reference/scope values.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getActive()
String	getAvatar()
List<WsComment>	getChildComments()
String	getCommentText() Gets the text of the comment.
Integer	getCommentType()
Integer	getCreatedBy()
Date	getCreatedDate()
Integer	getDocumentId() Gets the id of the document associated with this comment.
String	getDocumentKey()
String	getDocumentName()
Integer	getDocumentVersionId()
Calendar	getEntryDate() Gets the date the comment was made.
Long	getId() Gets the comment's id.
Boolean	getImportant()
Integer	getOriginDocumentId()
Integer	getParentId() Gets the id of the parent of this comment.
Integer	getRefId() Gets the comment's reference id.
Integer	getRevisionSequence()
Integer	getScopeId() Gets the comment's scopeId.
Integer	getStatus()
Integer	getThreadId()
Date	getThreadUpdatedDate()
Integer	getUpdatedBy()
WsUser	getUser() Gets the user who made the comment.
List<Integer>	getUserIdsWhoLiked()
void	setActive(Boolean active)
void	setAvatar(String avatar)
void	setChildComments(List<WsComment> childComments)
void	setCommentText(String commentText) Sets the text of the comment.
void	setCommentType(Integer commentType)
void	setCreatedBy(Integer createdBy)
void	setCreatedDate(Date createdDate)
void	setDocumentId(Integer documentId) Sets the id of the document associated with this comment.
void	setDocumentKey(String documentKey)
void	setDocumentName(String documentName)
void	setDocumentVersionId(Integer documentVersionId)
void	setEntryDate(Calendar entryDate) Sets the date the comment was made.
void	setId(Long id) Sets the comment's id.
void	setImportant(Boolean important)
void	setOriginDocumentId(Integer originDocumentId)
void	setParentId(Integer parentId) Sets the id of the parent of this comment.
void	setRefId(Integer refId) Sets the comment's reference id.
void	setRevisionSequence(Integer revisionSequence)
void	setScopeId(Integer scopeId) Sets the comment's scopeId.
void	setStatus(Integer status)
void	setThreadId(Integer threadId)
void	setThreadUpdatedDate(Date threadUpdatedDate)
void	setUpdatedBy(Integer updatedBy)
void	setUser(WsUser user) Sets the user who made the comment.
void	setUserIdsWhoLiked(List<Integer> userIdsWhoLiked)

Methods inherited from class java.lang.Object

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

Constructor Detail

WsComment

public WsComment()

Creates an empty WsComment object.

WsComment

public WsComment(String commentText,
         Integer scopeId,
         Integer refId)

Creates a new WsComment object with the given comment text and reference/scope values.

Parameters:

commentText - text of the comment

scopeId - scope of the element associated with the comment

refId - id associated with the comment

WsComment

public WsComment(String commentText,
         Integer documentId)

Creates a new WsComment object with the given comment text and document id.

Parameters:

commentText - text of the comment

documentId - id of the document associated with the comment

Method Detail

getId

public Long getId()

Gets the comment's id.

Returns:

the id

setId

public void setId(Long id)

Sets the comment's id.

Parameters:

id - the id to set

getCommentText

public String getCommentText()

Gets the text of the comment.

Returns:

the comment

setCommentText

public void setCommentText(String commentText)

Sets the text of the comment.

Parameters:

commentText - the comment to set

getUser

public WsUser getUser()

Gets the user who made the comment.

Returns:

the user

setUser

public void setUser(WsUser user)

Sets the user who made the comment.

Parameters:

user - the user to set

getScopeId

public Integer getScopeId()

Gets the comment's scopeId.

Returns:

the scopeId

See Also:

WsScope

setScopeId

public void setScopeId(Integer scopeId)

Sets the comment's scopeId.

Parameters:

scopeId - the scopeId to set

See Also:

WsScope

getRefId

public Integer getRefId()

Gets the comment's reference id.

Returns:

the reference id

setRefId

public void setRefId(Integer refId)

Sets the comment's reference id.

Parameters:

refId - the reference id to set

getEntryDate

public Calendar getEntryDate()

Gets the date the comment was made.

Returns:

date of comment

setEntryDate

public void setEntryDate(Calendar entryDate)

Sets the date the comment was made.

Parameters:

entryDate - date of the comment

getDocumentId

public Integer getDocumentId()

Gets the id of the document associated with this comment.

setDocumentId

public void setDocumentId(Integer documentId)

Sets the id of the document associated with this comment.

Parameters:

documentId - id of the associated document

getParentId

public Integer getParentId()

Gets the id of the parent of this comment.

Returns:

parentId

setParentId

public void setParentId(Integer parentId)

Sets the id of the parent of this comment.

Parameters:

parentId - id of the parent comment

getActive

public Boolean getActive()

setActive

public void setActive(Boolean active)

getCommentType

public Integer getCommentType()

setCommentType

public void setCommentType(Integer commentType)

getAvatar

public String getAvatar()

setAvatar

public void setAvatar(String avatar)

getDocumentName

public String getDocumentName()

setDocumentName

public void setDocumentName(String documentName)

getDocumentKey

public String getDocumentKey()

setDocumentKey

public void setDocumentKey(String documentKey)

getDocumentVersionId

public Integer getDocumentVersionId()

setDocumentVersionId

public void setDocumentVersionId(Integer documentVersionId)

getOriginDocumentId

public Integer getOriginDocumentId()

setOriginDocumentId

public void setOriginDocumentId(Integer originDocumentId)

getThreadId

public Integer getThreadId()

setThreadId

public void setThreadId(Integer threadId)

getCreatedDate

public Date getCreatedDate()

setCreatedDate

public void setCreatedDate(Date createdDate)

getThreadUpdatedDate

public Date getThreadUpdatedDate()

setThreadUpdatedDate

public void setThreadUpdatedDate(Date threadUpdatedDate)

getCreatedBy

public Integer getCreatedBy()

setCreatedBy

public void setCreatedBy(Integer createdBy)

getUpdatedBy

public Integer getUpdatedBy()

setUpdatedBy

public void setUpdatedBy(Integer updatedBy)

getRevisionSequence

public Integer getRevisionSequence()

setRevisionSequence

public void setRevisionSequence(Integer revisionSequence)

getUserIdsWhoLiked

public List<Integer> getUserIdsWhoLiked()

setUserIdsWhoLiked

public void setUserIdsWhoLiked(List<Integer> userIdsWhoLiked)

getChildComments

public List<WsComment> getChildComments()

setChildComments

public void setChildComments(List<WsComment> childComments)

getImportant

public Boolean getImportant()

setImportant

public void setImportant(Boolean important)

getStatus

public Integer getStatus()

setStatus

public void setStatus(Integer status)