OSID - osid.mapping.CoordinateList Service Interface Definition

Interface	osid.mapping.CoordinateList
Implements	`osid.OsidList`
Used By	`osid.locale.CoordinateConversionSession`
	`osid.mapping.SpatialUnit`
	`osid.mapping.path.PathSpatialDesignSession`
Description	Like all `OsidLists`, `CoordinateList` provides a means for accessing `Coordinate` elements sequentially either one at a time or many at a time. Examples: while (cl.hasNext()) { Coordinate coordinate = cl.getNextCoordinate(); } or while (cl.hasNext()) { Coordinate[] coordinates = cl.getNextCoordinates(cl.available()); }
Method	getNextCoordinate
Description	Gets the next `Coordinate` in this list.
Return	`osid.mapping.Coordinate`		the next `Coordinate` in this list. The `hasNext()` method should be used to test that a next `Coordinate` 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	getNextCoordinates
Description	Gets the next set of `Coordinate` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Coordinate` elements requested which must be less than or equal to `available()`
Return	`osid.mapping.Coordinate[]`		an array of `Coordinate` 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.