OSID - osid.mapping.path.IntersectionSearchOrder Service Interface Definition

Interface	osid.mapping.path.IntersectionSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Implements	`osid.OsidAggregateableSearchOrder`
Used By	`osid.mapping.path.IntersectionSearchSession`
Used By	`osid.mapping.path.IntersectionSmartMapSession`
Description	An interface for specifying the ordering of search results.
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	orderByRotary
Description	Specifies a preference for ordering the results by rotaries.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByFork
Description	Specifies a preference for ordering the results by forks.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectionSearchOrderRecord
Description	Gets the intersection search order record corresponding to the given intersection record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`intersectionRecordType`	a route record type
Return	`osid.mapping.path.records.IntersectionSearchOrderRecord`		the route search order record
Errors	NULL_ARGUMENT		`intersectionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(intersectionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.