org.osid.inquiry

Interface InquestSearchOrder

All Superinterfaces:

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

public interface InquestSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
InquestSearchOrderRecord	getInquestSearchOrderRecord(Type inquestRecordType) Gets the inquest search order record corresponding to the given inquest 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

getInquestSearchOrderRecord

InquestSearchOrderRecord getInquestSearchOrderRecord(Type inquestRecordType)
                                                     throws OperationFailedException

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

Parameters:

inquestRecordType - an inquest record type

Returns:

the inquest search order record

Throws:

NullArgumentException - inquestRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquestRecordType) is false

Compliance:

mandatory - This method must be implemented.