OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.InputSearchOrder
Implementsosid.OsidRuleSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByDevice
Description

Orders the results by device.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceSearchOrder
Description

Tests if a device search order is available.

Returnboolean true if a device search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDeviceSearchOrder
Description

Gets the device search order.

Returnosid.control.DeviceSearchOrderthe device search order
ErrorsILLEGAL_STATE supportsDeviceSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByController
Description

Orders the results by controller.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsControllerSearchOrder
Description

Tests if a controller search order is available.

Returnboolean true if a controller search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetControllerSearchOrder
Description

Gets the controller search order.

Returnosid.control.ControllerSearchOrderthe controller search order
ErrorsILLEGAL_STATE supportsControllerSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodgetInputSearchOrderRecord
Description

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

Parametersosid.type.TypeinputRecordTypean input record type
Returnosid.control.records.InputSearchOrderRecordthe input search order record
ErrorsNULL_ARGUMENT inputRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inputRecordType) is false
CompliancemandatoryThis method must be implemented.