com.jivesoftware.community
Interface TaskSearchQueryCriteria

public interface TaskSearchQueryCriteria

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

Nested Class Summary

static class

TaskSearchQueryCriteria.TaskSortType Represents how task search queries will be sorted

Method Summary

Project	getFilteredProject() Returns the project that query results are restricted to.
TaskSearchQueryCriteria.TaskSortType	getSortType() Returns the sort type to use to sort search results.
boolean	isOnlyComplete() Returns whether the query results are restricted to only complete tasks
boolean	isOnlyIncomplete() Returns whether the query results are restricted to only incomplete tasks
boolean	isTaskSearchEnabled() Returns whether tasks should be returned in search results
void	setFilterOnProject(Project project) Restricts the query results to tasks posted in a specific project.
void	setOnlyComplete(boolean complete) Sets whether the query results are restricted to only complete tasks
void	setOnlyIncomplete(boolean onlyIncomplete) Sets whether the query results are restricted to only incomplete tasks
void	setSortType(TaskSearchQueryCriteria.TaskSortType type) Sets the sort type to use to sort search results.
void	setTaskSearchEnabled(boolean taskSearchEnabled) Sets whether to enabled or disable task search

Method Detail

getSortType

TaskSearchQueryCriteria.TaskSortType getSortType()

Returns the sort type to use to sort search results. Default is TaskSearchQueryCriteria.TaskSortType.RELEVANCE

Returns:

sort type to use to sort search results

setSortType

void setSortType(TaskSearchQueryCriteria.TaskSortType type)

Sets the sort type to use to sort search results. Default is TaskSearchQueryCriteria.TaskSortType.RELEVANCE

Parameters:

type - the TaskSortType that will be used for sorting.

getFilteredProject

Project getFilteredProject()

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

Returns:

the project that results are restricted to.

setFilterOnProject

void setFilterOnProject(Project project)

Restricts the query results to tasks posted in a specific project.

Parameters:

project - the Project to restrict query results to.

isOnlyIncomplete

boolean isOnlyIncomplete()

Returns whether the query results are restricted to only incomplete tasks

Returns:

whether the query results are restricted to only incomplete tasks

setOnlyIncomplete

void setOnlyIncomplete(boolean onlyIncomplete)

Sets whether the query results are restricted to only incomplete tasks

Parameters:

onlyIncomplete - true if the query results are restricted to only incomplete tasks, false otherwise

isOnlyComplete

boolean isOnlyComplete()

Returns whether the query results are restricted to only complete tasks

Returns:

whether the query results are restricted to only complete tasks

setOnlyComplete

void setOnlyComplete(boolean complete)

Sets whether the query results are restricted to only complete tasks

Parameters:

complete - true if the query results are restricted to only complete tasks, false otherwise

isTaskSearchEnabled

boolean isTaskSearchEnabled()

Returns whether tasks should be returned in search results

Returns:

true iff tasks should be searched

setTaskSearchEnabled

void setTaskSearchEnabled(boolean taskSearchEnabled)

Sets whether to enabled or disable task search

Parameters:

taskSearchEnabled - - false to disable task search, true to enable