Interface CatalogSearchOrder

All Superinterfaces:

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

public interface CatalogSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
CatalogSearchOrderRecord	getCatalogSearchOrderRecord(Type catalogRecordType)	Gets the catalog search order record corresponding to the given subject record Type.Multiple retrievals return the same underlying object.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Methods inherited from interface OsidObjectSearchOrder

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

Methods inherited from interface OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Details

getCatalogSearchOrderRecord

CatalogSearchOrderRecord getCatalogSearchOrderRecord(Type catalogRecordType)
                                              throws OperationFailedException

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

Parameters:

catalogRecordType - a catalog record type

Returns:

the catalog search order record

Throws:

NullArgumentException - catalogRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogRecordType) is false

Compliance:

mandatory - This method must be implemented.