org.osid.workflow

Interface WorkflowEventList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextWorkflowEvent

WorkflowEvent getNextWorkflowEvent()
                                   throws OperationFailedException

Gets the next WorkflowEvent in this list.

Returns:

the next WorkflowEvent in this list. The hasNext() method should be used to test that a next WorkflowEvent is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextWorkflowEvents

WorkflowEvent[] getNextWorkflowEvents(long n)
                                      throws OperationFailedException

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

Parameters:

n - the number of WorkflowEvent elements requested which must be less than or equal to available()

Returns:

an array of WorkflowEvent elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.