OSID Logo
OSID Specifications
osid package
Version 3.1.0
Interfaceosid.OsidRuleSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidOperableSearchOrder
Implemented Byosid.assessment.authoring.SequenceRuleSearchOrder
osid.ordering.PriceSearchOrder
osid.authorization.FunctionSearchOrder
osid.OsidEnablerSearchOrder
osid.OsidConstrainerSearchOrder
osid.OsidProcessorSearchOrder
osid.resource.demographic.DemographicSearchOrder
osid.checklist.mason.TodoProducerSearchOrder
osid.rules.check.AgendaSearchOrder
osid.rules.check.CheckSearchOrder
osid.course.requisite.RequisiteSearchOrder
osid.course.requisite.CourseRequirementSearchOrder
osid.calendaring.RecurringEventSearchOrder
osid.calendaring.SupersedingEventSearchOrder
osid.calendaring.OffsetEventSearchOrder
osid.configuration.ParameterSearchOrder
osid.inquiry.InquirySearchOrder
osid.workflow.StepSearchOrder
osid.rules.RuleSearchOrder
osid.mapping.path.SpeedZoneSearchOrder
osid.mapping.path.SignalSearchOrder
osid.control.InputSearchOrder
osid.control.TriggerSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByRule
Description

Specifies a preference for ordering the results by the associated rule. The element of the rule to order is not specified but may be managed through a RuleSearchOrder.

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

Tests if a RuleSearchOrder is available.

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

Gets the search order for a rule.

Returnosid.rules.RuleSearchOrder the rule search order
ErrorsUNIMPLEMENTED supportsRuleSearchOrder() is false
Complianceoptional This method must be implemented if supportsRuleSearchOrder() is true.