OSID Logo
OSID Specifications
osid package
Version 3.1.0
Interfaceosid.OsidRuleApplicatorSearchOrder
Implementsosid.OsidEnablerSearchOrder
Implemented Byosid.rules.check.InstructionSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByResource
Description

Specifies a preference for ordering the results by the applied resource.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodsupportsResourceSearchOrder
Description

Tests if a ResourceSearchOrder is available.

Returnboolean true if a resource search order is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetResourceSearchOrder
Description

Gets the search order for a resource.

Returnosid.resource.ResourceSearchOrder the resource search order
ErrorsUNIMPLEMENTED supportsResourceSearchOrder() is false
Complianceoptional This method must be implemented if supportsResourceSearchOrder() is true.