Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.moderation
Class ModerationFilter

java.lang.Object
  extended by com.jivesoftware.forum.ResultFilter
      extended by com.jivesoftware.forum.moderation.ModerationFilter

public class ModerationFilter
extends ResultFilter


Field Summary
 
Fields inherited from class com.jivesoftware.forum.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.
 java.util.List getModValueList()
           
 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(java.util.List modValueList)
           
 
Methods inherited from class com.jivesoftware.forum.ResultFilter
addProperty, addResolutionState, addTag, clearResolutionStates, clone, createDefaultContentFilter, createDefaultForumFilter, createDefaultMessageFilter, createDefaultThreadFilter, createDefaultUserMessagesFilter, equals, getCreationDateRangeMax, getCreationDateRangeMin, getModificationDateRangeMax, getModificationDateRangeMin, getNumResults, getPropertyCount, getPropertyMatchType, getPropertyMode, getPropertyName, getPropertyValue, getPropertyValueString, getResolutionDateRangeMax, getResolutionDateRangeMin, getResolutionStates, getSortField, getSortOrder, getSortPropertyName, getStartIndex, getTags, getUserID, hashCode, isAllTagsRequired, isRecursive, removeResolutionState, roundDate, roundDate, setAllTagsRequired, setCreationDateRangeMax, setCreationDateRangeMin, setModificationDateRangeMax, setModificationDateRangeMin, setNumResults, setPropertyMode, setRecursive, setResolutionDateRangeMax, setResolutionDateRangeMin, setSortField, setSortOrder, setSortPropertyName, setStartIndex, setTags, setUserID
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, 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 java.util.List getModValueList()

setModValueList

public void setModValueList(java.util.List modValueList)

getModerationRangeMin

public int getModerationRangeMin()
Description copied from class: ResultFilter
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 ResultFilter
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: ResultFilter
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 ResultFilter
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: ResultFilter
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 ResultFilter
Returns:
the upper bound for moderation values to filter on.

setModerationRangeMax

public void setModerationRangeMax(int moderationRangeMax)
Description copied from class: ResultFilter
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 ResultFilter
Parameters:
moderationRangeMax - the max value of the moderation value range.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.