OSID Logo
OSID Specifications
topology path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.path.PathSearchOrder
Implementsosid.OsidRelationshipSearchOrder
osid.OsidAggregateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByStartingNode
Description

Specifies a preference for ordering the result set by the starting node.

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

Tests if a starting node search order is available.

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

Gets a starting node search order.

Returnosid.topology.NodeSearchOrdera node search order
ErrorsUNIMPLEMENTED supportsStartingNodeSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsStartingNodeSearchOrder() is true.
MethodorderByEndingNode
Description

Specifies a preference for ordering the result set by the starting node.

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

Tests if an ending node search order is available.

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

Gets an ending node search order.

Returnosid.topology.NodeSearchOrdera node search order
ErrorsUNIMPLEMENTED supportsEndingNodeSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsEndingNodeSearchOrder() is true.
MethodorderByComplete
Description

Specifies a preference for ordering the result set by the complete state.

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

Specifies a preference for ordering the result set by the open and closed paths.

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

Specifies a preference for ordering the result set by the number of hops in the path.

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

Specifies a preference for ordering the result set by the path distance.

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

Specifies a preference for ordering the result set by the path cost.

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

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

Parametersosid.type.TypepathRecordTypea path record type
Returnosid.topology.path.records.PathSearchOrderRecordthe path search order record
ErrorsNULL_ARGUMENT pathRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(pathRecordType) is false
CompliancemandatoryThis method must be implemented.