org.osid.workflow.rules

Interface ProcessEnablerList

All Superinterfaces:

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

public interface ProcessEnablerList
extends OsidList

Like all OsidLists, ProcessEnablerList provides a means for accessing ProcessEnabler elements sequentially either one at a time or many at a time. Examples:

       
       
       while (pel.hasNext()) {
            ProcessEnabler enabler = pel.getNextProcessEnabler();
       }
       
                   
       
  

or

       
       
       while (pel.hasNext()) {
            ProcessEnabler[] enablers = pel.getNextProcessEnablers(pel.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
ProcessEnabler	getNextProcessEnabler() Gets the next ProcessEnabler in this list.
ProcessEnabler[]	getNextProcessEnablers(long n) Gets the next set of ProcessEnabler 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

getNextProcessEnabler

ProcessEnabler getNextProcessEnabler()
                                     throws OperationFailedException

Gets the next ProcessEnabler in this list.

Returns:

the next ProcessEnabler in this list. The hasNext() method should be used to test that a next ProcessEnabler 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.

getNextProcessEnablers

ProcessEnabler[] getNextProcessEnablers(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

an array of ProcessEnabler 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.