OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.ObstacleSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidOperableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByPath
Description

Orders the results by path.

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

Tests if a path search order 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.
MethodorderByLength
Description

Orders the results by the length of the obstacle.

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

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

Parametersosid.type.TypeobstacleRecordTypean obstacle record type
Returnosid.mapping.path.records.ObstacleSearchOrderRecordthe obstacle search order record
ErrorsNULL_ARGUMENT obstacleRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(obstacleRecordType) is false
CompliancemandatoryThis method must be implemented.