Interface BidBatchFormList

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

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

while (bbfl.hasNext()) {
     BidBatchForm form = bbfl.getNextBidBatchForm();
}
or 
while (bbfl.hasNext()) {
     BidBatchForm[] forms = bbfl.getNextBidBatchForms(bbfl.available());
}

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

  • Method Details

    • getNextBidBatchForm

      BidBatchForm getNextBidBatchForm() throws OperationFailedException
      Gets the next BidBatchForm in this list.
      Returns:
      the next BidBatchForm in this list. The hasNext() method should be used to test that a next BidBatchForm 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.

    • getNextBidBatchForms

      BidBatchForm[] getNextBidBatchForms(long n) throws OperationFailedException
      Gets the next set of BidBatchForm elements in this list. The specified amount must be less than or equal to the return from available().
      Parameters:
      n - the number of BidBatchForm elements requested which must be less than or equal to available()
      Returns:
      an array of BidBatchForm 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.