com.jivesoftware.community.webservices
Class BlogResultFilter

java.lang.Object
  com.jivesoftware.community.webservices.ResultFilter
      com.jivesoftware.community.webservices.BlogResultFilter

public class BlogResultFilter
extends ResultFilter

Filters and sorts Blogs.

Nested Class Summary

Nested classes/interfaces inherited from class com.jivesoftware.community.webservices.ResultFilter

ResultFilter.ResolutionState

Field Summary

Fields inherited from class com.jivesoftware.community.webservices.ResultFilter

ASCENDING, DESCENDING, NULL_INT

Constructor Summary

BlogResultFilter()

Method Summary

static BlogResultFilter	createDefaultFilter() Creates a default blog ResultFilter: all blogs with results sorted on the blog creation date (newest blogs first).
java.lang.String	getPrefix() Returns an optional prefix to be used when search blogs by name.
boolean	isOnlyCommunity() Returns whether the result to be selected by the result filter should include only community blogs.
boolean	isOnlyPersonal() Returns whether the result to be selected by the result filter should include only personal blogs.
void	setOnlyCommunity(boolean onlyCommunity) Sets whether the result to be selected by the result filter should include only community blogs.
void	setOnlyPersonal(boolean onlyPersonal) Sets whether the result to be selected by the result filter should include only personal blogs.
void	setPrefix(java.lang.String prefix) Set a single character prefix to be used when searching blogs.

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

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

BlogResultFilter

public BlogResultFilter()

Method Detail

createDefaultFilter

public static BlogResultFilter createDefaultFilter()

Creates a default blog ResultFilter: all blogs with results sorted on the blog creation date (newest blogs first).

getPrefix

public java.lang.String getPrefix()

Returns an optional prefix to be used when search blogs by name.

Returns:

an optional prefix to be used when search blogs by name.

setPrefix

public void setPrefix(java.lang.String prefix)

Set a single character prefix to be used when searching blogs.

Parameters:

prefix - a single character prefix to be used when searching blogs.

isOnlyCommunity

public boolean isOnlyCommunity()

Returns whether the result to be selected by the result filter should include only community blogs. The default value is false, to include all blogs.

Returns:

whether the result to be selected by the result filter should include only community blogs.

setOnlyCommunity

public void setOnlyCommunity(boolean onlyCommunity)

Sets whether the result to be selected by the result filter should include only community blogs. The default value is false, to include all blogs.

Parameters:

onlyCommunity - the onlyCommunity value.

isOnlyPersonal

public boolean isOnlyPersonal()

Returns whether the result to be selected by the result filter should include only personal blogs. The default value is false, to include all blogs.

Returns:

whether the result to be selected by the result filter should include only personal blogs.

setOnlyPersonal

public void setOnlyPersonal(boolean onlyPersonal)

Sets whether the result to be selected by the result filter should include only personal blogs. The default value is false, to include all blogs.

Parameters:

onlyPersonal - the onlyPersonal value.