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

Interface	osid.mapping.route.RouteProgressList
Implements	`osid.OsidList`
Used By	`osid.mapping.route.ResourceRouteSession`
Description	Like all `OsidLists`, `RouteProgressList` provides a means for accessing `RouteProgress` elements sequentially either one at a time or many at a time. Examples: while (rpl.hasNext()) { RouteProgress progress = rpl.getNextRouteProgress(); } or while (rpl.hasNext()) { RouteProgress[] progresses = rpl.getNextRouteProgresses(rpl.available()); }
Method	getNextRouteProgress
Description	Gets the next `RouteProgress` in this list.
Return	`osid.mapping.route.RouteProgress`		the next `RouteProgress` in this list. The `hasNext()` method should be used to test that a next `RouteProgress` 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	getNextRouteProgresses
Description	Gets the next set of `RouteProgress` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `RouteProgress` elements requested which must be less than or equal to `available()`
Return	`osid.mapping.route.RouteProgress[]`		an array of `RouteProgress` 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.