Interface CanonicalUnitEnablerList

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

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

while (cuel.hasNext()) {
     CanonicalUnitEnabler enabler = cuel.getNextCanonicalUnitEnabler();
}
or 
while (cuel.hasNext()) {
     CanonicalUnitEnabler[] enablers = cuel.getNextCanonicalUnitEnablers(cuel.available());
}

  • Method Details

    • getNextCanonicalUnitEnabler

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

    • getNextCanonicalUnitEnablers

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