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