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

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