Interface IntersectionBatchFormList

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

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

while (cbfl.hasNext()) {
     IntersectionBatchForm form = cbfl.getNextIntersectionBatchForm();
}
or 
while (cbfl.hasNext()) {
     IntersectionBatchForm[] forms = cbfl.getNextIntersectionBatchForms(cbfl.available());
}

  • Method Details

    • getNextIntersectionBatchForm

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

    • getNextIntersectionBatchForms

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