public interface ParameterList extends OsidList
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()); }
Modifier and Type | Method and Description |
---|---|
Parameter |
getNextParameter()
Gets the next
Parameter in this list. |
Parameter[] |
getNextParameters(long n)
Gets the next set of
Parameters in this list which must
be less than or equal to the return from available(). |
Parameter getNextParameter() throws OperationFailedException
Parameter
in this list. Parameter
in this list. The
hasNext()
method should be used to test that a next
Parameter
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Parameter[] getNextParameters(long n) throws OperationFailedException
Parameters
in this list which must
be less than or equal to the return from available().
n
- the number of Parameter
elements requested
which must be less than or equal to available()
Parameter
elements.
The length of the array is less than or equal to the number
specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.