Interface ParameterBatchFormList

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

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

while (pbfl.hasNext()) {
     ParameterBatchForm form = pbfl.getNextParameterBatchForm();
}

or

while (p
bf 
l.hasNext()) {
     ParameterBatchForm[] forms = pbfl.getNextParameterBatchForms(pbfl.available());
}

  • Method Details

    • getNextParameterBatchForm

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

    • getNextParameterBatchForms

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