OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.WorkflowEventList
Implementsosid.OsidList
Description

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());
                     }
                     
                                 
                     
                
MethodgetNextWorkflowEvent
Description

Gets the next WorkflowEvent in this list.

Returnosid.workflow.WorkflowEventthe next WorkflowEvent in this list. The hasNext() method should be used to test that a next WorkflowEvent is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextWorkflowEvents
Description

Gets the next set of WorkflowEvent elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinalnthe number of WorkflowEvent elements requested which must be less than or equal to available()
Returnosid.workflow.WorkflowEvent[]an array of WorkflowEvent elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.