OSID - osid.mapping.LocationList Service Interface Definition

Interface	osid.mapping.LocationList
Implements	`osid.OsidList`
Used By	`osid.inventory.Stock`
	`osid.mapping.LocationAdjacencySession`
	`osid.mapping.LocationHierarchySession`
	`osid.mapping.LocationLookupSession`
	`osid.mapping.LocationMapSession`
	`osid.mapping.LocationQuerySession`
	`osid.mapping.LocationSearchResults`
	`osid.mapping.LocationSpatialSession`
	`osid.mapping.MyLocationSession`
	`osid.repository.AssetSpatialSession`
Description	Like all `OsidLists`, `LocationList` provides a means for accessing `Location` elements sequentially either one at a time or many at a time. Examples: while (ll.hasNext()) { Location location = ll.getNextLocation(); } or while (ll.hasNext()) { Location[] locations = ll.getNextLocations(ll.available()); }
Method	getNextLocation
Description	Gets the next `Location` in this list.
Return	`osid.mapping.Location`		the next `Location` in this list. The `hasNext()` method should be used to test that a next `Location` 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	getNextLocations
Description	Gets the next set of `Location` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Location` elements requested which must be less than or equal to `available()`
Return	`osid.mapping.Location[]`		an array of `Location` 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.