Interface AvailabilityEnablerList

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

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

while (ael.hasNext()) {
     AvailabilityEnabler enabler = ael.getNextAvailabilityEnabler();
}
or 
while (ael.hasNext()) {
     AvailabilityEnabler[] enablers = ael.getNextAvailabilityEnablers(ael.available());
}

  • Method Details

    • getNextAvailabilityEnabler

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

    • getNextAvailabilityEnablers

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