Interface TodoProducerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, TodoProducerQuerySession

public interface TodoProducerSearchSession
extends TodoProducerQuerySession

This session provides methods for searching among TodoProducers . 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

Modifier and Type	Method	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 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 TodoProducerQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchTodoProducers()	Tests if this user can perform TodoProducer lookups.
Checklist	getChecklist()	Gets the Checklist associated with this session.
Id	getChecklistId()	Gets the Checklist Id associated with this session.
TodoProducerQuery	getTodoProducerQuery()	Gets a todo producer query.
TodoProducerList	getTodoProducersByQuery(TodoProducerQuery todoProducerQuery)	Gets a list of TodoProducers matching the given todo producer query.
void	useFederatedChecklistView()	Federates the view for methods in this session.
void	useIsolatedChecklistView()	Isolates the view for methods in this session.

Method Details

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.