org.osid.resource

Interface BinSearchOrder

All Superinterfaces:

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

public interface BinSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BinSearchOrderRecord	getBinSearchOrderRecord(Type binRecordType) Gets the bin search record corresponding to the given bin 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

getBinSearchOrderRecord

BinSearchOrderRecord getBinSearchOrderRecord(Type binRecordType)
                                             throws OperationFailedException

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

Parameters:

binRecordType - a bin record type

Returns:

the bin search order record

Throws:

NullArgumentException - binRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(binRecordType) is false

Compliance:

mandatory - This method must be implemented.