org.osid.ordering

Interface StoreSearchOrder

All Superinterfaces:

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

public interface StoreSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
StoreSearchOrderRecord	getStoreSearchOrderRecord(Type storeRecordType) Gets the store search order record corresponding to the given store 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

getStoreSearchOrderRecord

StoreSearchOrderRecord getStoreSearchOrderRecord(Type storeRecordType)
                                                 throws OperationFailedException

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

Parameters:

storeRecordType - a store record type

Returns:

the store search order record

Throws:

NullArgumentException - storeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(storeRecordType) is false

Compliance:

mandatory - This method must be implemented.