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