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()); }
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(). |
Configuration getNextConfiguration() throws OperationFailedException
Configuration
in this list. Configuration
in this list. The
hasNext()
method should be used to test that a next
Configuration
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Configuration[] getNextConfigurations(long n) throws OperationFailedException
Configuration
objects in this lis
which must be less than or equal to whst is returned from
available().
n
- the number of Configuration
elements
requested which should be less than or equal to
available()
Configuration
elements.
The length of the array is less than or equal to the
number specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.