org.osid.recipe

Interface CookbookSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface CookbookSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CookbookSearchOrderRecord	getCookbookSearchOrderRecord(Type cookbookRecordType) Gets the cook book search order record corresponding to the given cook book record Type.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getCookbookSearchOrderRecord

CookbookSearchOrderRecord getCookbookSearchOrderRecord(Type cookbookRecordType)
                                                       throws OperationFailedException

Gets the cook book search order record corresponding to the given cook book record Type. Multiple retrievals return the same underlying object.

Parameters:

cookbookRecordType - a cook book record type

Returns:

the cook book search order record

Throws:

NullArgumentException - cookbookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cookbookRecordType) is false

Compliance:

mandatory - This method must be implemented.