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