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