Interface OrderItemBatchFormList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface OrderItemBatchFormList extends OsidList

Like all OsidLists, OrderItemBatchFormList provides a means for accessing OrderItemBatchForm elements sequentially either one at a time or many at a time. Examples: 

while (ibfl.hasNext()) {
     OrderItemBatchForm form = ibfl.getNextOrderItemBatchForm();
}
or 
while (ibfl.hasNext()) {
     OrderItemBatchForm[] forms = ibfl.getNextOrderItemBatchForms(ibfl.available());
}

Like all OsidLists, OrderItemBatchFormList is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getNextOrderItemBatchForm

      OrderItemBatchForm getNextOrderItemBatchForm() throws OperationFailedException
      Gets the next OrderItemBatchForm in this list.
      Returns:
      the next OrderItemBatchForm in this list. The hasNext() method should be used to test that a next OrderItemBatchForm is available before calling this method.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getNextOrderItemBatchForms

      OrderItemBatchForm[] getNextOrderItemBatchForms(long n) throws OperationFailedException
      Gets the next set of OrderItemBatchForm elements in this list. The specified amount must be less than or equal to the return from available().
      Parameters:
      n - the number of OrderItemBatchForm elements requested which must be less than or equal to available()
      Returns:
      an array of OrderItemBatchForm elements. The length of the array is less than or equal to the number specified.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.