Interface RecurringEventEnablerList

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

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

while (reel.hasNext()) {
     RecurringEventEnabler enabler = reel.getNextRecurringEventEnabler();
}
or 
while (reel.hasNext()) {
     RecurringEventEnabler[] enablers = reel.getNextRecurringEventEnablers(reel.available());
}

  • Method Details

    • getNextRecurringEventEnabler

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

    • getNextRecurringEventEnablers

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