com.jivesoftware.community
Interface MessageSearchQueryCriteria

public interface MessageSearchQueryCriteria

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

Nested Class Summary

static class

MessageSearchQueryCriteria.MessageSortType Represents how message search queries will be sorted

Method Summary

ForumThread	getFilteredThread() Returns the thread that query results are restricted to.
MessageSearchQueryCriteria.MessageSortType	getSortType() Returns the sort type to use to sort search results.
boolean	isSingleResultPerThread() Returns true if message search results are limited to a single result per thread, false otherwise.
void	setFilterOnThread(ForumThread thread) Restricts the query results to messages posted in a specific thread.
void	setSingleResultPerThread(boolean singleResultPerThread) Sets whether message search results are limited to a single result per thread or not.
void	setSortType(MessageSearchQueryCriteria.MessageSortType type) Sets the sort type to use to sort search results.

Method Detail

getSortType

MessageSearchQueryCriteria.MessageSortType getSortType()

Returns the sort type to use to sort search results. Default is MessageSearchQueryCriteria.MessageSortType.RELEVANCE

Returns:

sort type to use to sort search results

setSortType

void setSortType(MessageSearchQueryCriteria.MessageSortType type)

Sets the sort type to use to sort search results. Default is MessageSearchQueryCriteria.MessageSortType.RELEVANCE

Parameters:

type - the MessageSortType that will be used for sorting.

getFilteredThread

ForumThread getFilteredThread()

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

Returns:

the thread that results are restricted to.

setFilterOnThread

void setFilterOnThread(ForumThread thread)

Restricts the query results to messages posted in a specific thread.

Parameters:

thread - the ForumThread to restrict query results to.

isSingleResultPerThread

boolean isSingleResultPerThread()

Returns true if message search results are limited to a single result per thread, false otherwise. The default is false

Returns:

true if message search results are limited to a single result per thread, false otherwise

setSingleResultPerThread

void setSingleResultPerThread(boolean singleResultPerThread)

Sets whether message search results are limited to a single result per thread or not.

Parameters:

singleResultPerThread - true if message search results should be limited to a single result per thread, false otherwise.