OSID - osid.mapping.route.RouteSegmentSearchOrder Service Interface Definition

Interface	osid.mapping.route.RouteSegmentSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByStartingInstructions
Description	Specifies a preference for oredering the results by starting instructions.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByEndingInstructions
Description	Specifies a preference for oredering the results by ending instructions.
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 oredering the results by distance.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByETA
Description	Specifies a preference for oredering the results by estimated travel time.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRoute
Description	Specifies a preference for oredering the results by path.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteSearchOrder
Description	Tests if a search order for the route is available.
Return	`boolean`		`true` if a route search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRouteSearchOrder
Description	Gets a route search order.
Return	`osid.mapping.route.RouteSearchOrder`		the path search order
Errors	UNIMPLEMENTED		`supportsRouteSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteSearchOrder()` is `true.`
Method	orderByPath
Description	Specifies a preference for oredering the results by path.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathSearchOrder
Description	Tests if a search order for the path is available.
Return	`boolean`		`true` if a path search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPathSearchOrder
Description	Gets a path search order.
Return	`osid.mapping.path.PathSearchOrder`		the path search order
Errors	UNIMPLEMENTED		`supportsPathSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPathSearchOrder()` is `true.`
Method	getRouteSegmentSearchOrderRecord
Description	Gets the route segment search order record corresponding to the given route segment `Type.` Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`routeSegmentRecordType`	a route segment record type
Return	`osid.mapping.route.records.RouteSegmentSearchOrderRecord`		the route segment search order record
Errors	NULL_ARGUMENT		`routeSegmentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(routeSegmentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.