Interface AuctionHouseBatchFormList

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

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

while (abfl.hasNext()) {
     AuctionHouseBatchForm form = abfl.getNextAuctionHouseBatchForm();
}
or 
while (abfl.hasNext()) {
     AuctionHouseBatchForm[] forms = abfl.getNextAuctionHouseBatchForms(abfl.available());
}

  • Method Details

    • getNextAuctionHouseBatchForm

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

    • getNextAuctionHouseBatchForms

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