OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.DeviceEnablerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetDeviceEnablers
Description

Gets the DeviceEnablerList resulting from a search.

Returnosid.control.rules.DeviceEnablerListthe device enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetDeviceEnablerQueryInspector
Description

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

Returnosid.control.rules.DeviceEnablerQueryInspectorthe device enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetDeviceEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypedeviceEnablerSearchRecordTypea device enabler search record type
Returnosid.control.rules.records.DeviceEnablerSearchResultsRecordthe device enabler search results record
ErrorsNULL_ARGUMENT deviceEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(deviceEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.