Interface RecurringEventBatchFormList

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

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

while (rebfl.hasNext()) {
     RecurringEventBatchForm form = rebfl.getNextRecurringEventBatchForm();
}
or 
while (rebfl.hasNext()) {
     RecurringEventBatchForm[] forms = rebfl.getNextRecurringEventBatchForms(rebfl.available());
}

  • Method Details

    • getNextRecurringEventBatchForm

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

    • getNextRecurringEventBatchForms

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