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