com.jivesoftware.community.webservices
Class WSTagResultFilter

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

Direct Known Subclasses:

WSBlogTagResultFilter

public class WSTagResultFilter
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

WSTagResultFilter()

Method Summary

static WSTagResultFilter	createDefaultFilter() Creates a default TagResultFilter: all tags sorted in descending order with no minimum number of com.jivesoftware.community.JiveContentObjects.
int	getMinimum() Returns the minimum number of com.jivesoftware.community.JiveContentObjects that a tag must be associated with to be included in the result set.
void	setMinimum(int minimum) Sets the minimum number of com.jivesoftware.community.JiveContentObjects that a tag must be associated with to be included in the result set.

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

WSTagResultFilter

public WSTagResultFilter()

Method Detail

createDefaultFilter

public static WSTagResultFilter createDefaultFilter()

Creates a default TagResultFilter: all tags sorted in descending order with no minimum number of com.jivesoftware.community.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.

Returns:

a default TagResultFilter

getMinimum

public int getMinimum()

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

Returns:

the minimum number of com.jivesoftware.community.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 com.jivesoftware.community.JiveContentObjects that a tag must be associated with to be included in the result set.

Parameters:

minimum - the minimum number of com.jivesoftware.community.JiveContentObjects that a tag must be associated with to be included in the result set.