Interface CompositionEnablerList

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

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

while (cel.hasNext()) {
     CompositionEnabler enabler = cel.getNextCompositionEnabler();
}
or 
while (cel.hasNext()) {
     CompositionEnabler[] enablers = cel.getNextCompositionEnablers cel.available());
}

  • Method Details

    • getNextCompositionEnabler

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

    • getNextCompositionEnablers

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