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