org.osid.control

Interface InputSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface InputSearchOrder
extends OsidRuleSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ControllerSearchOrder	getControllerSearchOrder() Gets the controller search order.
DeviceSearchOrder	getDeviceSearchOrder() Gets the device search order.
InputSearchOrderRecord	getInputSearchOrderRecord(Type inputRecordType) Gets the input search order record corresponding to the given input record Type.
void	orderByController(SearchOrderStyle style) Orders the results by controller.
void	orderByDevice(SearchOrderStyle style) Orders the results by device.
boolean	supportsControllerSearchOrder() Tests if a controller search order is available.
boolean	supportsDeviceSearchOrder() Tests if a device search order is available.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Method Detail

orderByDevice

void orderByDevice(SearchOrderStyle style)

Orders the results by device.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsDeviceSearchOrder

boolean supportsDeviceSearchOrder()

Tests if a device search order is available.

Returns:

true if a device search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDeviceSearchOrder

DeviceSearchOrder getDeviceSearchOrder()

Gets the device search order.

Returns:

the device search order

Throws:

IllegalStateException - supportsDeviceSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByController

void orderByController(SearchOrderStyle style)

Orders the results by controller.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsControllerSearchOrder

boolean supportsControllerSearchOrder()

Tests if a controller search order is available.

Returns:

true if a controller search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getControllerSearchOrder

ControllerSearchOrder getControllerSearchOrder()

Gets the controller search order.

Returns:

the controller search order

Throws:

IllegalStateException - supportsControllerSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

getInputSearchOrderRecord

InputSearchOrderRecord getInputSearchOrderRecord(Type inputRecordType)
                                                 throws OperationFailedException

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

Parameters:

inputRecordType - an input record type

Returns:

the input search order record

Throws:

NullArgumentException - inputRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inputRecordType) is false

Compliance:

mandatory - This method must be implemented.