com.jivesoftware.community
Class ModerationFilter

java.lang.Object
  com.jivesoftware.community.ResultFilter
      com.jivesoftware.community.ThreadResultFilter
          com.jivesoftware.community.ModerationFilter

public class ModerationFilter
extends ThreadResultFilter

Filters and sorts lists of ForumMessages based upon the message's moderation and abuse value.

Factory methods to create common queries are provided for convenience.

See Also:

OldModerationManager#getMessages(ModerationFilter, com.jivesoftware.base.AuthToken), OldModerationManager#getMessages(ModerationFilter, com.jivesoftware.base.AuthToken, Community)

Field Summary

Fields inherited from class com.jivesoftware.community.ResultFilter

AND_MODE, ASCENDING, CONTAINS_MATCH, DESCENDING, EXACT_MATCH, NULL_INT, OR_MODE

Constructor Summary

ModerationFilter()

Method Summary

static ModerationFilter	createAbuseOnlyFilter() Creates a default Moderation Filter: shows all messages marked for moderation with results sorted by creation date in ascending order.
static ModerationFilter	createDefaultModerationFilter() Creates a default Moderation Filter: shows all messages marked for moderation with results sorted by creation date in ascending order.
static ModerationFilter	createModerationOnlyFilter() Creates a default Moderation Filter: shows all messages marked for moderation with results sorted by creation date in ascending order.
int	getModerationRangeMax() Returns the moderation value that represents the upper bound for messages or threads to be selected by the result filter.
int	getModerationRangeMin() Returns the moderation value that represents the lower boundry for messages or threads to be selected by the result filter.
List<Integer>	getModValueList() Gets a list of moderation values that will be used to filter results.
void	setModerationRangeMax(int moderationRangeMax) Sets the upper bound for the moderation value that will pass the result filter.
void	setModerationRangeMin(int moderationRangeMin) Sets the moderation value that represents the lower bound for messages or threads to be selected by the result filter.
void	setModValueList(List<Integer> modValueList) Sets a list of moderation values that will be used to filter results.

Methods inherited from class com.jivesoftware.community.ThreadResultFilter

addResolutionState, clearResolutionStates, createDefaultMessageFilter, createDefaultThreadFilter, createDefaultUserMessagesFilter, equals, getResolutionDateRangeMax, getResolutionDateRangeMin, getResolutionStates, getShowModerated, getSortField, hashCode, removeResolutionState, roundDate, roundDate, setResolutionDateRangeMax, setResolutionDateRangeMin, setShowModerated, setSortField, toString

Methods inherited from class com.jivesoftware.community.ResultFilter

addProperty, addProperty, addTag, createDefaultContentFilter, createDefaultRecursiveContentFilter, getCreationDateRangeMax, getCreationDateRangeMin, getModificationDateRangeMax, getModificationDateRangeMin, getNumResults, getPropertyCount, getPropertyMatchType, getPropertyMode, getPropertyName, getPropertyValue, getPropertyValueString, getSortOrder, getSortPropertyName, getStartIndex, getTags, getUserID, isAllTagsRequired, isPerformDistinctCount, isRecursive, setAllTagsRequired, setCreationDateRangeMax, setCreationDateRangeMin, setModificationDateRangeMax, setModificationDateRangeMin, setNumResults, setPerformDistinctCount, setPropertyMode, setRecursive, setSortOrder, setSortPropertyName, setStartIndex, setTags, setUserID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModerationFilter

public ModerationFilter()

Method Detail

createDefaultModerationFilter

public static ModerationFilter createDefaultModerationFilter()

Creates a default Moderation Filter: shows all messages marked for moderation with results sorted by creation date in ascending order.

createModerationOnlyFilter

public static ModerationFilter createModerationOnlyFilter()

Creates a default Moderation Filter: shows all messages marked for moderation with results sorted by creation date in ascending order.

createAbuseOnlyFilter

public static ModerationFilter createAbuseOnlyFilter()

Creates a default Moderation Filter: shows all messages marked for moderation with results sorted by creation date in ascending order.

getModValueList

public List<Integer> getModValueList()

Gets a list of moderation values that will be used to filter results. Valid moderation values are specified in JiveConstants and will of the type Integer.

Returns:

a list of moderation values that will be used to filter results

setModValueList

public void setModValueList(List<Integer> modValueList)

Sets a list of moderation values that will be used to filter results. Valid moderation values are specified in JiveConstants and must be added to the list as type Integer.

Parameters:

modValueList - a list of moderation values that will be used to filter results.

getModerationRangeMin

public int getModerationRangeMin()

Description copied from class: ThreadResultFilter

Returns the moderation value that represents the lower boundry for messages or threads to be selected by the result filter. If this value is not set it will return the lowest moderation value allowed and the results filter will be unbounded for the lowest moderation value selected.

For example -- if boolean moderation is being used, the possible values that can be expected of a message are -1 for rejected messages, 0 unapproved messages, and 1 for approved messages. To show messages available for the general public, you would pass this accessor a minimum value of 1 and a maximum value of 1 or higher. To show messages in need of moderation you would pass this accessor a minimum value of 0 and a maximum value of 0. To show messages in need of moderation in the context of threads that are already approved, you would pass this accessor a minumum value of 0 and a maximum value of 1.

Overrides:

getModerationRangeMin in class ThreadResultFilter

Returns:

an int representing the lowest value of the moderation value to be selected by the filter.

setModerationRangeMin

public void setModerationRangeMin(int moderationRangeMin)

Description copied from class: ThreadResultFilter

Sets the moderation value that represents the lower bound for messages or threads to be selected by the result filter. If this value is not set, the lower bound will default to JiveConstants.FORUM_MODERATION_VISIBLE.

Overrides:

setModerationRangeMin in class ThreadResultFilter

Parameters:

moderationRangeMin - int representing the lowest value of the moderation value range to be selected by the result filter.

getModerationRangeMax

public int getModerationRangeMax()

Description copied from class: ThreadResultFilter

Returns the moderation value that represents the upper bound for messages or threads to be selected by the result filter. If an upper bound has not been set, this method will return ResultFilter.NULL_INT.

Overrides:

getModerationRangeMax in class ThreadResultFilter

Returns:

the upper bound for moderation values to filter on.

setModerationRangeMax

public void setModerationRangeMax(int moderationRangeMax)

Description copied from class: ThreadResultFilter

Sets the upper bound for the moderation value that will pass the result filter. If this value is not set, or is set to ResultFilter.NULL_INT there will be no upper bound on moderation values.

Overrides:

setModerationRangeMax in class ThreadResultFilter

Parameters:

moderationRangeMax - the max value of the moderation value range.