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