public interface ProvisionList extends OsidList
Like all OsidLists,
ProvisionList
provides a means for accessing Provision
elements
sequentially either one at a time or many at a time. Examples:
while (pl.hasNext()) { Provision provision = pl.getNextProvision(); }or
while (pl.hasNext()) { Provision[] provisions = pl.getNextProvisions(pl.available()); }
Modifier and Type | Method and Description |
---|---|
Provision |
getNextProvision()
Gets the next
Provision in this list. |
Provision[] |
getNextProvisions(long n)
Gets the next set of
Provision elements in this list. |
Provision getNextProvision() throws OperationFailedException
Provision
in this list. Provision
in this list. The
hasNext()
method should be used to test that a next
Provision
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Provision[] getNextProvisions(long n) throws OperationFailedException
Provision
elements in this list.
The specified amount must be less than or equal to the return from
available().
n
- the number of Provision
elements requested
which must be less than or equal to available()
Provision
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.