Interface TodoSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, TodoQuerySession

public interface TodoSearchSession
extends TodoQuerySession

This session provides methods for searching Todos. The search query is constructed using the TodoQuery. The todo record Type also specifies the record for the todo query.

getTodosByQuery() is the basic search method and returns a list of Todo elements. A more advanced search may be performed with getTodosBySearch(). It accepts a TodoSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getTodosBySearch() returns a TodoSearchResults that can be used to access the resulting TodoList or be used to perform a search within the result set through TodoSearch.

Todos may have a query record indicated by their respective record types. The query record is accessed via the TodoQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
TodoQuery	getTodoQueryFromInspector(TodoQueryInspector todoQueryInspector)	Gets an entry query from an inspector.
TodoSearchResults	getTodosBySearch(TodoQuery todoQuery, TodoSearch todoSearch)	Gets the search results matching the given search.
TodoSearch	getTodoSearch()	Gets a todo search.
TodoSearchOrder	getTodoSearchOrder()	Gets a todo search order.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface TodoQuerySession

canSearchTodos, getChecklist, getChecklistId, getTodoQuery, getTodosByQuery, useFederatedChecklistView, useIsolatedChecklistView, useSequesteredTodoView, useUnsequesteredTodoView

Modifier and Type	Method	Description
boolean	canSearchTodos()	Tests if this user can perform todo searches.
Checklist	getChecklist()	Gets the Checklist associated with this session.
Id	getChecklistId()	Gets the Checklist Id associated with this session.
TodoQuery	getTodoQuery()	Gets a todo query.
TodoList	getTodosByQuery(TodoQuery todoQuery)	Gets a list of todos matching the given search.
void	useFederatedChecklistView()	Federates the view for methods in this session.
void	useIsolatedChecklistView()	Isolates the view for methods in this session.
void	useSequesteredTodoView()	The returns from the search methods omit sequestered todos.
void	useUnsequesteredTodoView()	All todos are returned including sequestered todos.

Method Details

getTodoSearch

TodoSearch getTodoSearch()

Gets a todo search.

Returns:

the todo search

Compliance:

mandatory - This method must be implemented.

getTodoSearchOrder

TodoSearchOrder getTodoSearchOrder()

Gets a todo search order. The TodoSearchOrder is supplied to a TodoSearch to specify the ordering of results.

Returns:

the todo search order

Compliance:

mandatory - This method must be implemented.

getTodosBySearch

TodoSearchResults getTodosBySearch(TodoQuery todoQuery,
 TodoSearch todoSearch)
                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

todoQuery - the todo query

todoSearch - the todo search

Returns:

the search results

Throws:

NullArgumentException - todoQuery or todoSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - todoQuery or todoSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getTodoQueryFromInspector

TodoQuery getTodoQueryFromInspector(TodoQueryInspector todoQueryInspector)

Gets an entry query from an inspector. The inspector is available from an TodoSearchResults.

Parameters:

todoQueryInspector - a todo query inspector

Returns:

the entry query

Throws:

NullArgumentException - todoQueryInspector is null

UnsupportedException - todoQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.