Interface ActivityUnitBatchFormList

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

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

while (aubfl.hasNext()) {
     ActivityUnitBatchForm form = aubfl.getNextActivityUnitBatchForm();
}
or 
while (aubfl.hasNext()) {
     ActivityUnitBatchForm[] forms = aubfl.getNextActivityUnitBatchForms(aubfl.available());
}

  • Method Details

    • getNextActivityUnitBatchForm

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

    • getNextActivityUnitBatchForms

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