OSID - osid.mapping.SpatialUnitList Service Interface Definition

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