Interface PersonBatchFormList

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

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

while (pbfl.hasNext()) {
     PersonBatchForm form = pbfl.getNextPersonBatchForm();
}
or 
while (pbfl.hasNext()) {
     PersonBatchForm[] forms = pbfl.getNextPersonBatchForms(pbfl.available());
}

  • Method Details

    • getNextPersonBatchForm

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

    • getNextPersonBatchForms

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