OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.CookbookSearch
Implementsosid.OsidSearch
Used Byosid.recipe.CookbookSearchSession
Description

The search interface for governing cookbook searches.

MethodsearchAmongCookbooks
Description

Execute this search among the given list of cookbooks.

Parametersosid.id.IdListcookbookIds list of cookbooks
ErrorsNULL_ARGUMENT cookbookIds is null
Compliancemandatory This method must be implemented.
MethodorderCookbookResults
Description

Specify an ordering to the search results.

Parametersosid.recipe.CookbookSearchOrdercookbooksearchOrder cookbook search order
ErrorsNULL_ARGUMENT cookbooksearchOrder is null
UNSUPPORTED cookbooksearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetCookbookSearchRecord
Description

Gets the cookbook search record corresponding to the given cookbook search record Type. This method is used to retrieve an object implementing the requested record interface.

Parametersosid.type.TypecookbookSearchRecordType a cookbook search record type
Returnosid.recipe.records.CookbookSearchRecord the cookbook search record
ErrorsNULL_ARGUMENT cookbooksearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(cookbooksearchRecordType) is false
Compliancemandatory This method must be implemented.