org.osid.rules

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

Methods

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

getEngineSearchOrderRecord

EngineSearchOrderRecord getEngineSearchOrderRecord(Type engineRecordType)
                                                   throws OperationFailedException

Gets the engine search order record 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

UnsupportedException - hasRecordType(engineRecordType) is false

Compliance:

mandatory - This method must be implemented.