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