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