Interface OffsetEventEnablerList

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

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

while (oeel.hasNext()) {
     OffsetEventEnabler enabler = oeel.getNextOffsetEventEnabler();
}
or 
while (oeel.hasNext()) {
     OffsetEventEnabler[] enablers = oeel.getNextOffsetEventEnablers(oeel.available());
}

  • Method Details

    • getNextOffsetEventEnabler

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

    • getNextOffsetEventEnablers

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