Interface ConfigurationList

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

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

while (cl.hasNext()) {
     Configuration config = cl.getNextConfiguration();
}
or 
while (cl.hasNext()) {
     Configuration[] configs = cl.getNextConfigurations(cl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    Configuration
    getNextConfiguration()
    Gets the next Configuration in this list.
    Configuration[]
    getNextConfigurations(long n)
    Gets the next set of Configuration objects in this lis which must be less than or equal to whst is returned from available() .

    Methods inherited from interface Closeable

    close

    Methods inherited from interface OsidList

    close
    Modifier and Type
    Method
    Description
    void
    close()
    Close this list.

    Methods inherited from interface OsidList

    available, hasNext, skip
    Modifier and Type
    Method
    Description
    long
    available()
    Gets the number of elements available for retrieval.
    boolean
    hasNext()
    Tests if there are more elements in this list.
    void
    skip(long n)
    Skip the specified number of elements in the list.

  • Method Details

    • getNextConfiguration

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

    • getNextConfigurations

      Configuration[] getNextConfigurations(long n) throws OperationFailedException
      Gets the next set of Configuration objects in this lis which must be less than or equal to whst is returned from available() .
      Parameters:
      n - the number of Configuration elements requested which should be less than or equal to available()
      Returns:
      an array of ConfigurationHelv ength 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.