OSID - osid.topology.path.PathSearchOrder Service Interface Definition

Interface	osid.topology.path.PathSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Implements	`osid.OsidAggregateableSearchOrder`
Used By	`osid.topology.path.PathSearchSession`
Used By	`osid.topology.path.PathSmartGraphSession`
Description	An interface for specifying the ordering of search results.
Method	orderByStartingNode
Description	Specifies a preference for ordering the result set by the starting node.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsStartingNodeSearchOrder
Description	Tests if a starting 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	getStartingNodeSearchOrder
Description	Gets a starting node search order.
Return	`osid.topology.NodeSearchOrder`		a node search order
Errors	UNIMPLEMENTED		`supportsStartingNodeSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStartingNodeSearchOrder()` is `true`.
Method	orderByEndingNode
Description	Specifies a preference for ordering the result set by the starting node.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndingNodeSearchOrder
Description	Tests if an ending 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	getEndingNodeSearchOrder
Description	Gets an ending node search order.
Return	`osid.topology.NodeSearchOrder`		a node search order
Errors	UNIMPLEMENTED		`supportsEndingNodeSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEndingNodeSearchOrder()` is `true`.
Method	orderByComplete
Description	Specifies a preference for ordering the result set by the complete state.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByClosed
Description	Specifies a preference for ordering the result set by the open and closed paths.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByHops
Description	Specifies a preference for ordering the result set by the number of hops in the path.
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 path distance.
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 path cost.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPathSearchOrderRecord
Description	Gets the path search order record corresponding to the given path record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`pathRecordType`	a path record type
Return	`osid.topology.path.records.PathSearchOrderRecord`		the path search order record
Errors	NULL_ARGUMENT		`pathRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(pathRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.