OSID - osid.lexicon.ParameterList Service Interface Definition

Interface	osid.lexicon.ParameterList
Implements	`osid.OsidList`
Used By	`osid.lexicon.ParameterLookupSession`
	`osid.lexicon.ParameterPressSession`
	`osid.lexicon.ParameterQuerySession`
	`osid.lexicon.ParameterSearchResults`
Description	Like all `OsidLists` , `ParameterList` provides a means for accessing `Parameter` elements sequentially either one at a time or many at a time. Examples: while (pl.hasNext()) { Parameter parameter = pl.getNextParameter(); } or while (pl.hasNext()) { Parameter[] parameters = pl.getNextParameters(pl.available()); }
Method	getNextParameter
Description	Gets the next `Parameter` in this list.
Return	`osid.lexicon.Parameter`		the next `Parameter` in this list. The `hasNext()` method should be used to test that a next `Parameter` 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	getNextParameters
Description	Gets the next set of `Parameter` elements in this list. The specified amount must be less than or equal to the return from `available()` .
Parameters	`cardinal`	`n`	the number of `Parameter` elements requested which must be less than or equal to `available()`
Return	`osid.lexicon.Parameter[]`		an array of `Parameter` 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.