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