com.jivesoftware.community.webservices
Class WSBlogTagResultFilter

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

public class WSBlogTagResultFilter
extends WSTagResultFilter

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

WSBlogTagResultFilter()

Method Summary

static WSBlogTagResultFilter	createDefaultFilter() Creates a default tag ResultFilter: all tags associated with blog posts that have status = com.jivesoftware.community.BlogPost#STATUS_PUBLISH, publishDate less than now() (with minute precision) ordered by tag name in descending order.
java.util.Date	getPublishDateRangeMax() Returns a date that represents the upper boundry for tags to be selected by the result filter.
java.util.Date	getPublishDateRangeMin() Returns the publish date that represents the lower boundary for blog posts to be filtered on.
void	setPublishDateRangeMax(java.util.Date publishDateRangeMax) Sets a date that represents the upper boundry for tags to be selected by the result filter.
void	setPublishDateRangeMin(java.util.Date publishDateRangeMin) Sets the date that represents the lower boundary for blog posts to be selected by the result filter.

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

getMinimum, setMinimum

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

WSBlogTagResultFilter

public WSBlogTagResultFilter()

Method Detail

createDefaultFilter

public static WSBlogTagResultFilter createDefaultFilter()

Creates a default tag ResultFilter: all tags associated with blog posts that have status = com.jivesoftware.community.BlogPost#STATUS_PUBLISH, publishDate less than now() (with minute precision) ordered by tag name in descending order.

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

getPublishDateRangeMin

public java.util.Date getPublishDateRangeMin()

Returns the publish date that represents the lower boundary for blog posts to be filtered on. If this value has not been set, the method will return null.

Returns:

a Date representing the lower bound for publish dates to filter on.

setPublishDateRangeMin

public void setPublishDateRangeMin(java.util.Date publishDateRangeMin)

Sets the date that represents the lower boundary for blog posts to be selected by the result filter. If this value is not set the results filter will be unbounded for the earliest publish date selected.

Setting a date range for a BlogTagResultFilter is a potential performance bottleneck. For example, if the argument for the date range is "new Date()" then the corresponding database query will map to an accuracy of a particular millesecond in time. This means that the results can't be cached. A better solution is to round dates to the nearest minute, hour, etc (whatever accuracy you need).

Parameters:

publishDateRangeMin - Date representing the filter lowest value of the publish date to be selected.

getPublishDateRangeMax

public java.util.Date getPublishDateRangeMax()

Returns a date that represents the upper boundry for tags to be selected by the result filter. If this value is not set it will return null and the results filter will be unbounded for the latest publish date selected.

Returns:

a Date representing the filter highest value of the publish date to be selected.

setPublishDateRangeMax

public void setPublishDateRangeMax(java.util.Date publishDateRangeMax)

Sets a date that represents the upper boundry for tags to be selected by the result filter. If this value is not set the results filter will be unbounded for the latest publish date selected.

Setting a date range for a BlogTagResultFilter is a potential performance bottleneck. For example, if the argument for the date range is "new Date()" then the corresponding database query will map to an accuracy of a particular millesecond in time. This means that the results can't be cached. A better solution is to round dates to the nearest minute, hour, etc (whatever accuracy you need).

Parameters:

publishDateRangeMax - Date representing the filter lowest value of the publish date range.