Interface | osid.topology.EdgeSearchOrder | ||
---|---|---|---|
Implements | osid.OsidRelationshipSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderBySourceNode | ||
Description |
Specifies a preference for ordering the result set by the source node. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSourceNodeSearchOrder | ||
Description |
Tests if a source node search order is available. | ||
Return | boolean | true if a node search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSourceNodeSearchOrder | ||
Description |
Gets a source node search order. | ||
Return | osid.topology.NodeSearchOrder | a node search order | |
Errors | UNIMPLEMENTED | supportsSourceNodeSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsSourceNodeSearchOrder()
is true. | |
Method | orderByDestinationNode | ||
Description |
Specifies a preference for ordering the result set by the destination node. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDestinationNodeSearchOrder | ||
Description |
Tests if a destination node search order is available. | ||
Return | boolean | true if a node search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDestinationNodeSearchOrder | ||
Description |
Gets a destination node search order. | ||
Return | osid.topology.NodeSearchOrder | a node search order | |
Errors | UNIMPLEMENTED | supportsDestinationNodeSearchOrder() is false | |
Compliance | optional | This method must be implemented if
supportsDestinationNodeSearchOrder() is true. | |
Method | orderByDirectional | ||
Description |
Specifies a preference for ordering the result set by the directionality. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByBiDirectional | ||
Description |
Specifies a preference for ordering the result set by the directionality. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByCost | ||
Description |
Specifies a preference for ordering the result set by the edge cost. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByDistance | ||
Description |
Specifies a preference for ordering the result set by the edge distance. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeSearchOrderRecord | ||
Description |
Gets the edge search order record corresponding to the
given edge record | ||
Parameters | osid.type.Type | edgeRecordType | a edge record type |
Return | osid.topology.records.EdgeSearchOrderRecord | the edge search order record | |
Errors | NULL_ARGUMENT | edgeRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(edgeRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |