org.osid.recipe

Interface CookbookSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CookbookSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
CookbookQueryInspector	getCookbookQueryInspector() Gets the inspector for the query to examine the terns used in the search.
CookbookList	getCookbooks() Gets the cook book list resulting from a search.
CookbookSearchResultsRecord	getCookbookSearchResultsRecord(Type cookbookSearchRecordType) Gets the cook book search rsults record corresponding to the given cook book search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getCookbooks

CookbookList getCookbooks()

Gets the cook book list resulting from a search.

Returns:

the cook book list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCookbookQueryInspector

CookbookQueryInspector getCookbookQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getCookbookSearchResultsRecord

CookbookSearchResultsRecord getCookbookSearchResultsRecord(Type cookbookSearchRecordType)
                                                           throws OperationFailedException

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

Parameters:

cookbookSearchRecordType - a cook book search record type

Returns:

the cook book search results record

Throws:

NullArgumentException - cookbookSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cookbookSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.