OSID - osid.mapping.path.ObstacleList Service Interface Definition

Interface	osid.mapping.path.ObstacleList
Implements	`osid.OsidList`
Used By	`osid.mapping.path.ObstacleLookupSession`
	`osid.mapping.path.ObstacleMapSession`
	`osid.mapping.path.ObstacleQuerySession`
	`osid.mapping.path.ObstacleSearchResults`
	`osid.mapping.path.PathTravelSession`
	`osid.mapping.path.rules.ObstacleEnablerRuleLookupSession`
Description	Like all `OsidLists`, `ObstacleList` provides a means for accessing `Obstacle` elements sequentially either one at a time or many at a time. Examples: while (ol.hasNext()) { Obstacle obstacle = ol.getNextObstacle(); } or while (ol.hasNext()) { Obstacle[] obstacles = ol.getNextObstacles(ol.available()); }
Method	getNextObstacle
Description	Gets the next `Obstacle` in this list.
Return	`osid.mapping.path.Obstacle`		the next `Obstacle` in this list. The `hasNext()` method should be used to test that a next `Obstacle` 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	getNextObstacles
Description	Gets the next set of `Obstacle` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Obstacle` elements requested which must be less than or equal to `available()`
Return	`osid.mapping.path.Obstacle[]`		an array of `Obstacle` 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.