Interface RaceBatchFormList

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

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

while (rbfl.hasNext()) {
     RaceBatchForm form = rbfl.getNextRaceBatchForm();
}
or 
while (rbfl.hasNext()) {
     RaceBatchForm[] forms = rbfl.getNextRaceBatchForms(rbfl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    RaceBatchForm
    getNextRaceBatchForm()
    Gets the next RaceBatchForm in this list.
    RaceBatchForm[]
    getNextRaceBatchForms(long n)
    Gets the next set of RaceBatchForm elements in this list.

    Methods inherited from interface Closeable

    close

    Methods inherited from interface OsidList

    close
    Modifier and Type
    Method
    Description
    void
    close()
    Close this list.

    Methods inherited from interface OsidList

    available, hasNext, skip
    Modifier and Type
    Method
    Description
    long
    available()
    Gets the number of elements available for retrieval.
    boolean
    hasNext()
    Tests if there are more elements in this list.
    void
    skip(long n)
    Skip the specified number of elements in the list.

  • Method Details

    • getNextRaceBatchForm

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

    • getNextRaceBatchForms

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