Interface CookbookSearchSession

All Superinterfaces:

AutoCloseable, Closeable, CookbookQuerySession, OsidSession, OsidSession

public interface CookbookSearchSession
extends CookbookQuerySession

This session provides methods for searching Cookbook objects. The search query is constructed using the CookbookQuery . The cookbook record Type also specifies the record for the cookbook 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

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

Methods inherited from interface Closeable

close

Methods inherited from interface CookbookQuerySession

canSearchCookbooks, getCookbookQuery, getCookbooksByQuery

Modifier and Type	Method	Description
boolean	canSearchCookbooks()	Tests if this user can perform Cookbook searches.
CookbookQuery	getCookbookQuery()	Gets a cookbook query.
CookbookList	getCookbooksByQuery(CookbookQuery cookbookQuery)	Gets a list of Cookbooks matching the given search.

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.

Method Details

getCookbookSearch

CookbookSearch getCookbookSearch()

Gets a cookbook search.

Returns:

the cookbook search

Compliance:

mandatory - This method must be implemented.

getCookbookSearchOrder

CookbookSearchOrder getCookbookSearchOrder()

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

Returns:

the cookbook 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 cookbook query

cookbookSearch - the cookbook search

Returns:

the cookbook search results

Throws:

NullArgumentException - cookbookQuery or cookbooksearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - cookbookQuery or cookbooksearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCookbookQueryFromInspector

CookbookQuery getCookbookQueryFromInspector(CookbookQueryInspector cookbookQueryInspector)

Gets a cookbook query from an inspector. The inspector is available from an CookbookSearchResults .

Parameters:

cookbookQueryInspector - a cookbook query inspector

Returns:

the cookbook query

Throws:

NullArgumentException - cookbookQueryInspector is null

UnsupportedException - cookbookQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.