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