Interface AwardBatchFormList

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

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

while (abfl.hasNext()) {
     AwardBatchForm form = abfl.getNextAwardBatchForm();
}
or 
while (abfl.hasNext()) {
     AwardBatchForm[] forms = abfl.getNextAwardBatchForms(abfl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    AwardBatchForm
    getNextAwardBatchForm()
    Gets the next AwardBatchForm in this list.
    AwardBatchForm[]
    getNextAwardBatchForms(long n)
    Gets the next set of AwardBatchForm 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

    • getNextAwardBatchForm

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

    • getNextAwardBatchForms

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