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

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

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getCookbooks

CookbookList getCookbooks()

Gets the cookbook list resulting from a search.

Returns:

the cookbook 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 cookbook search rsults record corresponding to the given cookbook search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

cookbookSearchRecordType - a cookbook search record type

Returns:

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