OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.CookbookSearchResults
Implementsosid.OsidSearchResults
Used Byosid.recipe.CookbookSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetCookbooks
Description

Gets the cookbook list resulting from a search.

Returnosid.recipe.CookbookList the cookbook list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCookbookQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.recipe.CookbookQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetCookbookSearchResultsRecord
Description

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

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