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