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