Package com.jamasoftware.velocity.api
Interface RevisionItemComment
-
- All Superinterfaces:
DomainObject
public interface RevisionItemComment extends DomainObject
Represents a single comment associated with a review. It represents both review/revision comments, and revision item comments.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Comment
getComment()
Gets additional comment details.java.lang.String
getCommentText()
Gets comment's rich text content.java.lang.String
getCommentType()
Returns the comment type as a string.java.lang.Boolean
getIsActive()
Returns true if comment is "active", i.e.java.lang.Boolean
getIsResolved()
Gets whether comment is resolved.java.lang.Boolean
getIsRevisionItemComment()
Returns true if this is a comment on a revision item, else returns false if this is a comment on a review/revision that is not associated with a specific item in the review.java.lang.Integer
getParentId()
Gets the ID of the comment's parent, or null if this is a top-level comment with no parent.Review
getReview()
Gets the associated review.Revision
getRevision()
Gets the associated revision.RevisionItem
getRevisionItem()
Gets the associated revision item.RevisionUserItem
getRevisionUserItem()
Gets the associated revision user item.java.lang.Integer
getUserId()
Gets comment author user.-
Methods inherited from interface com.jamasoftware.velocity.api.DomainObject
getCreatedBy, getCreatedDate, getId, getModifiedBy, getModifiedDate, getXmlToString, isNewObject, obtainAclObjectIdentity
-
-
-
-
Method Detail
-
getComment
Comment getComment()
Gets additional comment details.- Returns:
-
getUserId
java.lang.Integer getUserId()
Gets comment author user.- Returns:
-
getIsResolved
java.lang.Boolean getIsResolved()
Gets whether comment is resolved. A comment is considered resolved if its status is COMPLETED, or its parent comment status is COMPLETED.- Returns:
-
getCommentType
java.lang.String getCommentType()
Returns the comment type as a string. SeeCommentTypeEnum
for complete list of comment types.- Returns:
-
getCommentText
java.lang.String getCommentText()
Gets comment's rich text content.- Returns:
-
getParentId
java.lang.Integer getParentId()
Gets the ID of the comment's parent, or null if this is a top-level comment with no parent.- Returns:
-
getReview
Review getReview()
Gets the associated review. Will never be null regardless of type of comment, i.e. it can be a review/revision comment, or a revision item comment.- Returns:
-
getRevision
Revision getRevision()
Gets the associated revision. Will never be null.- Returns:
-
getRevisionItem
RevisionItem getRevisionItem()
Gets the associated revision item. Only applies to comments on items in a review/revision, otherwise will be null.- Returns:
-
getRevisionUserItem
RevisionUserItem getRevisionUserItem()
Gets the associated revision user item. Only applies to comments on items in a review/revision by user, otherwise will be null.- Returns:
-
getIsRevisionItemComment
java.lang.Boolean getIsRevisionItemComment()
Returns true if this is a comment on a revision item, else returns false if this is a comment on a review/revision that is not associated with a specific item in the review.- Returns:
-
getIsActive
java.lang.Boolean getIsActive()
Returns true if comment is "active", i.e. not deleted.- Returns:
-
-