Interface DeviceEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DeviceEnablerSearch
extends OsidSearch

The search interface for governing device enabler searches.

Method Summary

Modifier and Type	Method	Description
DeviceEnablerSearchRecord	getDeviceEnablerSearchRecord(Type deviceEnablerSearchRecordType)	Gets the device enabler search record corresponding to the given device enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderDeviceEnablerResults(DeviceEnablerSearchOrder deviceEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongDeviceEnablers(IdList deviceEnablerIds)	Execute this search among the given list of device enablers.

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

searchAmongDeviceEnablers

void searchAmongDeviceEnablers(IdList deviceEnablerIds)

Execute this search among the given list of device enablers.

Parameters:

deviceEnablerIds - list of device enablers

Throws:

NullArgumentException - deviceEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderDeviceEnablerResults

void orderDeviceEnablerResults(DeviceEnablerSearchOrder deviceEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

deviceEnablerSearchOrder - device enabler search order

Throws:

NullArgumentException - deviceEnablerSearchOrder is null

UnsupportedException - deviceEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDeviceEnablerSearchRecord

DeviceEnablerSearchRecord getDeviceEnablerSearchRecord(Type deviceEnablerSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

deviceEnablerSearchRecordType - a device enabler search record type

Returns:

the device enabler search record

Throws:

NullArgumentException - deviceEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(deviceEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.