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