Interface DistributorBatchFormList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
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());
}

  • Method Details

    • getNextDistributorBatchForm

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

    • getNextDistributorBatchForms

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