org.osid.configuration

Interface ConfigurationList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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 Configuration 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.