Interface AuditBatchFormList

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

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

while (abfl.hasNext()) {
     AuditBatchForm form = abfl.getNextInquiryBatchForm();
}
or 
while (abfl.hasNext()) {
     AuditBatchForm[] forms = abfl.getNextAuditBatchForms(aibfl.available());
}

  • Method Summary

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

    • getNextAuditBatchForm

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

    • getNextAuditBatchForms

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