org.osid.control

Interface DeviceSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface DeviceSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
DeviceSearchOrderRecord	getDeviceSearchOrderRecord(Type deviceRecordType) Gets the device search order record corresponding to the given device 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

Method Detail

getDeviceSearchOrderRecord

DeviceSearchOrderRecord getDeviceSearchOrderRecord(Type deviceRecordType)
                                                   throws OperationFailedException

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

Parameters:

deviceRecordType - a device record type

Returns:

the device search order record

Throws:

NullArgumentException - deviceRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(deviceRecordType) is false

Compliance:

mandatory - This method must be implemented.