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

Interface	osid.mapping.path.PathList
Implements	`osid.OsidList`
Used By	`osid.mapping.path.Intersection`
	`osid.mapping.path.PathLookupSession`
	`osid.mapping.path.PathMapSession`
	`osid.mapping.path.PathQuerySession`
	`osid.mapping.path.PathSearchResults`
	`osid.mapping.path.PathSpatialSession`
Description	Like all `OsidLists`, `PathList` provides a means for accessing `Path` elements sequentially either one at a time or many at a time. Examples: while (pl.hasNext()) { Path path = pl.getNextPath(); } or while (pl.hasNext()) { Path[] paths = pl.getNextPaths(pl.available()); }
Method	getNextPath
Description	Gets the next `Path` in this list.
Return	`osid.mapping.path.Path`		the next `Path` in this list. The `hasNext()` method should be used to test that a next `Path` 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	getNextPaths
Description	Gets the next set of `Path` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Path` elements requested which must be less than or equal to `available()`
Return	`osid.mapping.path.Path[]`		an array of `Path` 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.