Interface EngineSearchOrder

All Superinterfaces:

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

public interface EngineSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
EngineSearchOrderRecord	getEngineSearchOrderRecord(Type engineRecordType)	Gets the engine search record order corresponding to the given engine 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

getEngineSearchOrderRecord

EngineSearchOrderRecord getEngineSearchOrderRecord(Type engineRecordType)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

engineRecordType - an engine record type

Returns:

the engine search order record

Throws:

NullArgumentException - engineRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(engineRecordType) is false

Compliance:

mandatory - This method must be implemented.