Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum
Class TagResultFilter

java.lang.Object
  extended by com.jivesoftware.forum.ResultFilter
      extended by com.jivesoftware.forum.TagResultFilter

public class TagResultFilter
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
TagResultFilter()
           
 
Method Summary
static TagResultFilter createDefaultFilter()
          Creates a default TagResultFilter: all tags sorted in descending order with no minimum number of JiveContentObjects.
 int getMinimum()
          Returns the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.
 void setMinimum(int minimum)
          Sets the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.
 
Methods inherited from class com.jivesoftware.forum.ResultFilter
addProperty, addResolutionState, addTag, clearResolutionStates, clone, createDefaultContentFilter, createDefaultForumFilter, createDefaultMessageFilter, createDefaultThreadFilter, createDefaultUserMessagesFilter, equals, getCreationDateRangeMax, getCreationDateRangeMin, getModerationRangeMax, getModerationRangeMin, 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, setModerationRangeMax, setModerationRangeMin, 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

TagResultFilter

public TagResultFilter()
Method Detail

createDefaultFilter

public static TagResultFilter createDefaultFilter()
Creates a default TagResultFilter: all tags sorted in descending order with no minimum number of JiveContentObjects.

NOTE: The resulting TagResultFilter should not be stored by invoking classes; this filter is the default tag filter at the time this method is invoked.


getMinimum

public int getMinimum()
Returns the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.

Returns:
the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.

setMinimum

public void setMinimum(int minimum)
Sets the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.

Parameters:
minimum -

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.