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