OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.SignalSearchOrder
Implementsosid.OsidRuleSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByPath
Description

Specifies a preference for ordering the results by path.

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

Tests if a search order for the path is available.

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

Gets a path search order.

Returnosid.mapping.path.PathSearchOrderthe path search order
ErrorsUNIMPLEMENTED supportsPathSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsPathSearchOrder() is true.
MethodgetSignalSearchOrderRecord
Description

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

Parametersosid.type.TypesignalRecordTypea signal record type
Returnosid.mapping.path.records.SignalSearchOrderRecordthe signal search order record
ErrorsNULL_ARGUMENT signalRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(signalRecordType) is false
CompliancemandatoryThis method must be implemented.