Interface CatalogueSearchOrder

All Superinterfaces:

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

public interface CatalogueSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
CatalogueSearchOrderRecord	getCatalogueSearchOrderRecord(Type catalogueRecordType)	Gets the catalogue search record order corresponding to the given catalogue record Type.

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

getCatalogueSearchOrderRecord

CatalogueSearchOrderRecord getCatalogueSearchOrderRecord(Type catalogueRecordType)
                                                  throws OperationFailedException

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

Parameters:

catalogueRecordType - a catalogue record type

Returns:

the catalogue search order record interface

Throws:

NullArgumentException - catalogueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogueRecordType) is false

Compliance:

mandatory - This method must be implemented.