org.osid.control.rules

Interface ActionEnablerList

All Superinterfaces:

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

public interface ActionEnablerList
extends OsidList

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

       
       
       while (ael.hasNext()) {
            ActionEnabler enabler = ael.getNextActionEnabler();
       }
       
                   
       
  

or

       
       
       while (ael.hasNext()) {
            ActionEnabler[] enablers = ael.getNextActionEnablers(ael.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextActionEnabler

ActionEnabler getNextActionEnabler()
                                   throws OperationFailedException

Gets the next ActionEnabler in this list.

Returns:

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

getNextActionEnablers

ActionEnabler[] getNextActionEnablers(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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