org.osid.installation

Interface DepotSearchOrder

All Superinterfaces:

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

public interface DepotSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
DepotSearchOrderRecord	getDepotSearchOrderRecord(Type depotRecordType) Gets the depot search order record corresponding to the given depot 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

getDepotSearchOrderRecord

DepotSearchOrderRecord getDepotSearchOrderRecord(Type depotRecordType)
                                                 throws OperationFailedException

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

Parameters:

depotRecordType - a depot record type

Returns:

the depot search order record

Throws:

NullArgumentException - depotRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(depotRecordType) is false

Compliance:

mandatory - This method must be implemented.