Interface DeviceSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DeviceSearch
extends OsidSearch

The search interface for governing device searches.

Method Summary

Modifier and Type	Method	Description
DeviceSearchRecord	getDeviceSearchRecord(Type deviceSearchRecordType)	Gets the device search record corresponding to the given device search record Type.
void	orderDeviceResults(DeviceSearchOrder deviceSearchOrder)	Specify an ordering to the search results.
void	searchAmongDevices(IdList deviceIds)	Execute this search among the given list of devices.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongDevices

void searchAmongDevices(IdList deviceIds)

Execute this search among the given list of devices.

Parameters:

deviceIds - list of devices

Throws:

NullArgumentException - deviceIds is null

Compliance:

mandatory - This method must be implemented.

orderDeviceResults

void orderDeviceResults(DeviceSearchOrder deviceSearchOrder)

Specify an ordering to the search results.

Parameters:

deviceSearchOrder - device search order

Throws:

NullArgumentException - deviceSearchOrder is null

UnsupportedException - deviceSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDeviceSearchRecord

DeviceSearchRecord getDeviceSearchRecord(Type deviceSearchRecordType)
                                  throws OperationFailedException

Gets the device search record corresponding to the given device search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

deviceSearchRecordType - a device search record type

Returns:

the device search record

Throws:

NullArgumentException - deviceSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(deviceSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.