org.osid.checklist.mason

Interface TodoProducerSearchSession

All Superinterfaces:

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

public interface TodoProducerSearchSession
extends TodoProducerQuerySession

This session provides methods for searching among TodoProducer objects. The search query is constructed using the TodoProduceryQuery.

getTodoProducersByQuery() is the basic search method and returns a list of TodoProducers. A more advanced search may be performed with getTodoProducersBySearch(). It accepts a TodoProducerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getTodoProducersBySearch() returns a TodoProducerSearchResults that can be used to access the resulting TodoProducerList or be used to perform a search within the result set through TodoProducerSearch.

This session defines views that offer differing behaviors for searching.

• federated checklist view: searches include todo producers in checklists of which this checklist is an ancestor in the checklist hierarchy
• isolated checklist view: searches are restricted to todo producers in this checklist

TodoProducers may have a query record indicated by their respective record types. The query record is accessed via the TodoProducerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
TodoProducerQuery	getTodoProducerQueryFromInspector(TodoProducerQueryInspector todoProducerQueryInspector) Gets a todo producer query from an inspector.
TodoProducerSearchResults	getTodoProducersBySearch(TodoProducerQuery todoProducerQuery, TodoProducerSearch todoProducerSearch) Gets the search results matching the given search query using the given search.
TodoProducerSearch	getTodoProducerSearch() Gets a todo producer search.
TodoProducerSearchOrder	getTodoProducerSearchOrder() Gets a todo producer search order.

Methods inherited from interface org.osid.checklist.mason.TodoProducerQuerySession

canSearchTodoProducers, getChecklist, getChecklistId, getTodoProducerQuery, getTodoProducersByQuery, useFederatedChecklistView, useIsolatedChecklistView

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

getTodoProducerSearch

TodoProducerSearch getTodoProducerSearch()

Gets a todo producer search.

Returns:

the todo producer search

Compliance:

mandatory - This method must be implemented.

getTodoProducerSearchOrder

TodoProducerSearchOrder getTodoProducerSearchOrder()

Gets a todo producer search order. The TodoProducerSearchOrder is supplied to a TodoProducerSearch to specify the ordering of results.

Returns:

the todo producer search order

Compliance:

mandatory - This method must be implemented.

getTodoProducersBySearch

TodoProducerSearchResults getTodoProducersBySearch(TodoProducerQuery todoProducerQuery,
                                                 TodoProducerSearch todoProducerSearch)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

todoProducerQuery - the todo producer query

todoProducerSearch - the todo producer search

Returns:

the returned search results

Throws:

NullArgumentException - todoProducerQuery or todoProducerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - todoProducerQuery or todoProducerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getTodoProducerQueryFromInspector

TodoProducerQuery getTodoProducerQueryFromInspector(TodoProducerQueryInspector todoProducerQueryInspector)

Gets a todo producer query from an inspector. The inspector is available from a TodoProducerSearchResults.

Parameters:

todoProducerQueryInspector - a todo producer query inspector

Returns:

the todo producer query

Throws:

NullArgumentException - todoProducerQueryInspector is null

UnsupportedException - todoProducerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.