Interface AuthorizationBatchFormList

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

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

while (abfl.hasNext()) {
     AuthorizationBatchForm form = abfl.getNextAuthorizationBatchForm();
}
or 
while (abfl.hasNext()) {
     AuthorizationBatchForm[] forms = abfl.getNextAuthorizationBatchForms(abfl.available());
}

  • Method Details

    • getNextAuthorizationBatchForm

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

    • getNextAuthorizationBatchForms

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