org.osid.recipe

Interface CookbookSearchSession

All Superinterfaces:

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

public interface CookbookSearchSession
extends CookbookQuerySession

This session provides methods for searching Cookbook objects. The search query is constructed using the CookbookQuery. The cook book record Type also specifies the record for the cook book query.

getCookbooksByQuery() is the basic search method and returns a list of Cookbook elements. A more advanced search may be performed with getCookbooksBySearch(). It accepts an CookbookSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getCookbooksBySearch() returns an CookbookSearchResults that can be used to access the resulting CookbookList or be used to perform a search within the result set through CookbookSearch.

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

Method Summary

Methods

Modifier and Type	Method and Description
CookbookQuery	getCookbookQueryFromInspector(CookbookQueryInspector cookbookQueryInspector) Gets a cook book query from an inspector.
CookbookSearchResults	getCookbooksBySearch(CookbookQuery cookbookQuery, CookbookSearch cookbookSearch) Gets the search results matching the given search.
CookbookSearch	getCookbookSearch() Gets a cook book search.
CookbookSearchOrder	getCookbookSearchOrder() Gets a cook book search order.

Methods inherited from interface org.osid.recipe.CookbookQuerySession

canSearchCookbooks, getCookbookQuery, getCookbooksByQuery

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

getCookbookSearch

CookbookSearch getCookbookSearch()

Gets a cook book search.

Returns:

the cook book search

Compliance:

mandatory - This method must be implemented.

getCookbookSearchOrder

CookbookSearchOrder getCookbookSearchOrder()

Gets a cook book search order. The CookbookSearchOrder is supplied to an CookbookSearch to specify the ordering of results.

Returns:

the cook book search order

Compliance:

mandatory - This method must be implemented.

getCookbooksBySearch

CookbookSearchResults getCookbooksBySearch(CookbookQuery cookbookQuery,
                                         CookbookSearch cookbookSearch)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets the search results matching the given search.

Parameters:

cookbookQuery - the cook book query

cookbookSearch - the cook book search

Returns:

the cook book search results

Throws:

NullArgumentException - cookbookQuery or cook books earch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - cookbookQuery or cook books earch is not of this service

Compliance:

mandatory - This method must be implemented.

getCookbookQueryFromInspector

CookbookQuery getCookbookQueryFromInspector(CookbookQueryInspector cookbookQueryInspector)

Gets a cook book query from an inspector. The inspector is available from an CookbookSearchResults.

Parameters:

cookbookQueryInspector - a cook book query inspector

Returns:

the cook book query

Throws:

NullArgumentException - cookbookQueryInspector is null

UnsupportedException - cookbookQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.