Interface ParticipantBatchFormList

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

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

while (pobfl.hasNext()) {
     ParticipantBatchForm form = pobfl.getNextParticipantBatchForm();
}
or 
while (pobfl.hasNext()) {
     ParticipantBatchForm[] forms = pobfl.getNextParticipantBatchForms(pobfl.available());
}

  • Method Details

    • getNextParticipantBatchForm

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

    • getNextParticipantBatchForms

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