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