org.osid.commenting

Interface BookSearchOrder

All Superinterfaces:

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

public interface BookSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BookSearchOrderRecord	getBookSearchOrderRecord(Type bookRecordType) Gets the book search order record corresponding to the given 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

getBookSearchOrderRecord

BookSearchOrderRecord getBookSearchOrderRecord(Type bookRecordType)
                                               throws OperationFailedException

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

Parameters:

bookRecordType - a book record type

Returns:

the book search order record

Throws:

NullArgumentException - bookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bookRecordType) is false

Compliance:

mandatory - This method must be implemented.