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