com.jivesoftware.community.webservices
Class WSCommentResultFilter

java.lang.Object
  com.jivesoftware.community.webservices.WSResultFilter
      com.jivesoftware.community.webservices.WSCommentResultFilter

Direct Known Subclasses:

WSUserContentCommentResultFilter

public class WSCommentResultFilter
extends WSResultFilter

Nested Class Summary

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

WSResultFilter.ResolutionState

Field Summary

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

ASCENDING, DESCENDING, NULL_INT

Constructor Summary

WSCommentResultFilter()

Method Summary

static WSCommentResultFilter	createDefaultFilter() Creates a default comment ResultFilter: no filtering with results sorted on the comment creation date.
static WSCommentResultFilter	createDefaultFilter(WSCommunity community) Creates a default comment ResultFilter: no filtering with results sorted on the comment creation date.
long	getCommunityID() Returns the communityID.
boolean	isIncludeModerated() Returns whether the result to be selected by the result filter should include moderated comments.
void	setCommunityID(long communityID) Sets the communityID to use to restrict results to be selected by the result filter.
void	setIncludeModerated(boolean include) Sets whether the result to be selected by the result filter should include moderated comments.

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

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

WSCommentResultFilter

public WSCommentResultFilter()

Method Detail

createDefaultFilter

public static WSCommentResultFilter createDefaultFilter()

Creates a default comment ResultFilter: no filtering with results sorted on the comment creation date. The moderation minimum value will be the highest moderation minimum value of any community the parent object belongs to.

createDefaultFilter

public static WSCommentResultFilter createDefaultFilter(WSCommunity community)

Creates a default comment ResultFilter: no filtering with results sorted on the comment creation date. The moderation minimum value will be value retrieved from the given community.

Parameters:

community - - the community to get the default moderation minimum value from.

getCommunityID

public long getCommunityID()

Returns the communityID. This can be used to restrict results to be selected by the result filter. This is most useful when you only want the results inside of a particular community (i.e. list all comments that are moderated appropriately within a specific community).

Returns:

the current communityID, or -1 if it is not set.

setCommunityID

public void setCommunityID(long communityID)

Sets the communityID to use to restrict results to be selected by the result filter. This is most useful when you only want the results inside of a particular community (i.e. list all comments that are moderated appropriately within a specific community).

Parameters:

communityID - the community that will be used to restrict results.

isIncludeModerated

public boolean isIncludeModerated()

Returns whether the result to be selected by the result filter should include moderated comments. The default value is false, or not to include moderated comments.

Returns:

whether the result to be selected by the result filter should include moderated comments.

setIncludeModerated

public void setIncludeModerated(boolean include)

Sets whether the result to be selected by the result filter should include moderated comments. The default value is false, or not to include moderated comments.

Parameters:

include - true to include moderated comments, false otherwise.