com.jivesoftware.community
Interface BlogPostSearchQueryCriteria

public interface BlogPostSearchQueryCriteria

Search criteria specific to searching blog posts may be specified using this criteria class.

Nested Class Summary

static class

BlogPostSearchQueryCriteria.BlogPostSortType Represents how message blog post queries will be sorted

Method Summary

void	filterOnBlog(Blog blog) Restricts the query results to posts posted in a specific blog.
Blog	getFilteredBlog() Returns the blog that query results are restricted to.
BlogPostSearchQueryCriteria.BlogPostSortType	getSortType() Returns the sort type to use to sort search results.
boolean	isCommentsIncludedInSearch() Returns whether comments are included in the search or not.
void	setCommentsIncludedInSearch(boolean include) Sets whether to include comments in the search or not.
void	setSortType(BlogPostSearchQueryCriteria.BlogPostSortType type) Sets the sort type to use to sort search results.

Method Detail

getSortType

BlogPostSearchQueryCriteria.BlogPostSortType getSortType()

Returns the sort type to use to sort search results. Default is BlogPostSearchQueryCriteria.BlogPostSortType.RELEVANCE

Returns:

sort type to use to sort search results

setSortType

void setSortType(BlogPostSearchQueryCriteria.BlogPostSortType type)

Sets the sort type to use to sort search results. Default is BlogPostSearchQueryCriteria.BlogPostSortType.RELEVANCE

Parameters:

type - the BlogPostSortType that will be used for sorting.

getFilteredBlog

Blog getFilteredBlog()

Returns the blog that query results are restricted to. If the query is not restricted to posts in a certain blog, this method will return null.

Returns:

the blog that results are restricted to.

filterOnBlog

void filterOnBlog(Blog blog)

Restricts the query results to posts posted in a specific blog.

Parameters:

blog - the Blog to restrict query results to.

isCommentsIncludedInSearch

boolean isCommentsIncludedInSearch()

Returns whether comments are included in the search or not.

Returns:

true if comments are included in the search, false otherwise.

setCommentsIncludedInSearch

void setCommentsIncludedInSearch(boolean include)

Sets whether to include comments in the search or not.

Parameters:

include - true to include comments in the search, false otherwise.