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