org.osid.checklist

Interface TodoSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, TodoQuerySession

public interface TodoSearchSession
extends TodoQuerySession

This session provides methods for searching Todo objects. 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

Methods

Modifier and Type	Method and 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 org.osid.checklist.TodoQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.