Interface DeviceSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface DeviceSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
DeviceQueryInspector	getDeviceQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
DeviceList	getDevices()	Gets the device list resulting from a search.
DeviceSearchResultsRecord	getDeviceSearchResultsRecord(Type deviceSearchRecordType)	Gets the device search results record corresponding to the given device search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getDevices

DeviceList getDevices()

Gets the device list resulting from a search.

Returns:

the device list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getDeviceQueryInspector

DeviceQueryInspector getDeviceQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the device query inspector

Compliance:

mandatory - This method must be implemented.

getDeviceSearchResultsRecord

DeviceSearchResultsRecord getDeviceSearchResultsRecord(Type deviceSearchRecordType)
                                                throws OperationFailedException

Gets the device search results 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 results record

Throws:

NullArgumentException - deviceSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(deviceSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.