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