OSID - osid.mapping.MapList Service Interface Definition

Interface	osid.mapping.MapList
Implements	`osid.OsidList`
Used By	`osid.mapping.LocationMapSession`
	`osid.mapping.MapHierarchySession`
	`osid.mapping.MapLookupSession`
	`osid.mapping.MapQuerySession`
	`osid.mapping.MapSearchResults`
	`osid.mapping.path.IntersectionMapSession`
	`osid.mapping.path.ObstacleMapSession`
	`osid.mapping.path.PathMapSession`
	`osid.mapping.path.SignalMapSession`
	`osid.mapping.path.SpeedZoneMapSession`
	show 4 more…
`osid.mapping.path.rules.ObstacleEnablerMapSession`
`osid.mapping.path.rules.SignalEnablerMapSession`
`osid.mapping.path.rules.SpeedZoneEnablerMapSession`
`osid.mapping.route.RouteMapSession`
Description	Like all `OsidLists`, `MapList` provides a means for accessing `Map` elements sequentially either one at a time or many at a time. Examples: while (ml.hasNext()) { Map map = ml.getNextMap(); } or while (ml.hasNext()) { Map[] maps = ml.getNextMaps(ml.available()); }
Method	getNextMap
Description	Gets the next `Map` in this list.
Return	`osid.mapping.Map`		the next `Map` in this list. The `hasNext()` method should be used to test that a next `Map` 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	getNextMaps
Description	Gets the next set of `Map` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Map` elements requested which must be less than or equal to `available()`
Return	`osid.mapping.Map[]`		an array of `Map` 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.