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