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

Interface	osid.mapping.route.RouteList
Implements	`osid.OsidList`
Used By	`osid.mapping.route.RouteLookupSession`
	`osid.mapping.route.RouteMapSession`
	`osid.mapping.route.RouteQuerySession`
	`osid.mapping.route.RouteSearchResults`
Description	Like all `OsidLists`, `RouteList` provides a means for accessing `Route` elements sequentially either one at a time or many at a time. Examples: while (rl.hasNext()) { Route route = rl.getNextRoute(); } or while (rl.hasNext()) { Route[] routes = rl.getNextRoutes(rl.available()); }
Method	getNextRoute
Description	Gets the next `Route` in this list.
Return	`osid.mapping.route.Route`		the next `Route` in this list. The `hasNext()` method should be used to test that a next `Route` is available before calling this method.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getNextRoutes
Description	Gets the next set of `Route` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Route` elements requested which must be less than or equal to `available()`
Return	`osid.mapping.route.Route[]`		an array of `Route` elements. The length of the array is less than or equal to the number specified.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.