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