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