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