Interface CanonicalUnitProcessorList

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

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

while (cupl.hasNext()) {
     CanonicalUnitProcessor = cupl.getNextCanonicalUnitProcessor();
}
or 
while cuapl.hasNext()) {
     CanonicalUnitProcessor[] = cupl.getNextCanonicalUnitProcessors(cupl.available());
}

  • Method Details

    • getNextCanonicalUnitProcessor

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

    • getNextCanonicalUnitProcessors

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