public interface ConfigurationBatchFormList extends OsidList
Like all OsidLists,
ConfigurationBatchFormList
provides a means for accessing ConfigurationBatchForm
elements sequentially either one at a time or many at a time.
Examples:
while (cbfl.hasNext()) { ConfigurationBatchForm form = cbfl.getNextConfigurationBatchForm(); }or
while (cbfl.hasNext()) { ConfigurationBatchForm[] forms = cbfl.getNextConfigurationBatchForms(cbfl.available()); }
Modifier and Type | Method and Description |
---|---|
ConfigurationBatchForm |
getNextConfigurationBatchForm()
Gets the next
ConfigurationBatchForm in this list. |
ConfigurationBatchForm[] |
getNextConfigurationBatchForms(long n)
Gets the next set of
ConfigurationBatchForm elements in
this list. |
ConfigurationBatchForm getNextConfigurationBatchForm() throws OperationFailedException
ConfigurationBatchForm
in this list. ConfigurationBatchForm
in this list.
The hasNext()
method should be used to test
that a next ConfigurationBatchForm
is available
before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. ConfigurationBatchForm[] getNextConfigurationBatchForms(long n) throws OperationFailedException
ConfigurationBatchForm
elements in
this list. The specified amount must be less than or equal to the
return from available().
n
- the number of ConfigurationBatchForm
elements
requested which must be less than or equal to
available()
ConfigurationBatchForm
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.