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

Modifier and Type	Method	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 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 OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Methods inherited from interface OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Modifier and Type	Method	Description
void	orderByActive(SearchOrderStyle style)	Specifies a preference for ordering the result set by the active status.
void	orderByDisabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively disabled status.
void	orderByEnabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively enabled status.
void	orderByOperational(SearchOrderStyle style)	Specifies a preference for ordering the results by the operational status.

Methods inherited from interface OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Modifier and Type	Method	Description
RuleSearchOrder	getRuleSearchOrder()	Gets the search order for a rule.
void	orderByRule(SearchOrderStyle style)	Specifies a preference for ordering the results by the associated rule.
boolean	supportsRuleSearchOrder()	Tests if a RuleSearchOrder is available.

Method Details

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.