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