com.jivesoftware.community.webservices
Class UserContentCommentResultFilter

java.lang.Object
  com.jivesoftware.community.webservices.ResultFilter
      com.jivesoftware.community.webservices.CommentResultFilter
          com.jivesoftware.community.webservices.UserContentCommentResultFilter

public class UserContentCommentResultFilter
extends CommentResultFilter

A result filter for use in creating queries which return all comments on content created by a given user.

Nested Class Summary

Nested classes/interfaces inherited from class com.jivesoftware.community.webservices.ResultFilter

ResultFilter.ResolutionState

Field Summary

Fields inherited from class com.jivesoftware.community.webservices.ResultFilter

ASCENDING, DESCENDING, NULL_INT

Constructor Summary

UserContentCommentResultFilter()

Method Summary

static UserContentCommentResultFilter	createDefaultContentCommentFilter()
boolean	isIncludeAuthorsInUserFilter() Returns true if users who have been added as authors to a document should be included when filtering user content comments by user.
boolean	isIncludeDocumentBackChannelComments() Returns true if document backchannel comments should be included.
boolean	isIncludeOwnComments() Returns true if comments by the user whose content is being queried for comments should be included.
void	setIncludeAuthorsInUserFilter(boolean includeAuthorsInUserFilter) Sets whether users who have been added as authors to a document should be included when filtering user content comments by user.
void	setIncludeDocumentBackChannelComments(boolean includeDocumentBackChannelComments) Sets whether document backchannel comments should be included.
void	setIncludeOwnComments(boolean includeOwnComments) Sets whether comments by the user whose content is being queried for comments should be included.

Methods inherited from class com.jivesoftware.community.webservices.CommentResultFilter

createDefaultFilter, createDefaultFilter, getCommunityID, isIncludeModerated, setCommunityID, setIncludeModerated

Methods inherited from class com.jivesoftware.community.webservices.ResultFilter

createDefaultMessageFilter, createDefaultThreadFilter, createDefaultUserMessagesFilter, getCreationDateRangeMax, getCreationDateRangeMin, getModerationRangeMax, getModerationRangeMin, getModificationDateRangeMax, getModificationDateRangeMin, getNumResults, getResolutionDateRangeMin, getResolutionnDateRangeMax, getResolutionStates, getSortField, getSortOrder, getStartIndex, getTags, getUserID, isRecursive, setCreationDateRangeMax, setCreationDateRangeMin, setModerationRangeMax, setModerationRangeMin, setModificationDateRangeMax, setModificationDateRangeMin, setNumResults, setRecursive, setResolutionDateRangeMin, setResolutionnDateRangeMax, setResolutionStates, setSortField, setSortOrder, setStartIndex, setTags, setUserID

Methods inherited from class java.lang.Object

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

Constructor Detail

UserContentCommentResultFilter

public UserContentCommentResultFilter()

Method Detail

createDefaultContentCommentFilter

public static UserContentCommentResultFilter createDefaultContentCommentFilter()

isIncludeAuthorsInUserFilter

public boolean isIncludeAuthorsInUserFilter()

Returns true if users who have been added as authors to a document should be included when filtering user content comments by user.

Returns:

true if users who have been added as authors to a document should be included when filtering by user.

setIncludeAuthorsInUserFilter

public void setIncludeAuthorsInUserFilter(boolean includeAuthorsInUserFilter)

Sets whether users who have been added as authors to a document should be included when filtering user content comments by user.

Parameters:

includeAuthorsInUserFilter - true when users who have been added as authors to a document should be included when filtering by user.

isIncludeOwnComments

public boolean isIncludeOwnComments()

Returns true if comments by the user whose content is being queried for comments should be included.

Returns:

true if comments by the user whose content is being queried for comments should be included.

setIncludeOwnComments

public void setIncludeOwnComments(boolean includeOwnComments)

Sets whether comments by the user whose content is being queried for comments should be included.

Parameters:

includeOwnComments - true when comments by the user whose content is being queried for comments should be included.

isIncludeDocumentBackChannelComments

public boolean isIncludeDocumentBackChannelComments()

Returns true if document backchannel comments should be included.

Returns:

true if document backchannel comments should be included.

setIncludeDocumentBackChannelComments

public void setIncludeDocumentBackChannelComments(boolean includeDocumentBackChannelComments)

Sets whether document backchannel comments should be included.

Parameters:

includeDocumentBackChannelComments - true if document backchannel comments should be included.