OSID Logo
OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.EdgeSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderBySourceNode
Description

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

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

Tests if a source node search order is available.

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

Gets a source node search order.

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

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

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

Tests if a destination node search order is available.

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

Gets a destination node search order.

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

Specifies a preference for ordering the result set by the directionality.

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

Specifies a preference for ordering the result set by the directionality.

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 edge cost.

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 edge distance.

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

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

Parametersosid.type.TypeedgeRecordTypea edge record type
Returnosid.topology.records.EdgeSearchOrderRecordthe edge search order record
ErrorsNULL_ARGUMENT edgeRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(edgeRecordType) is false
CompliancemandatoryThis method must be implemented.