org.osid.control

Interface ActionList

All Superinterfaces:

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

public interface ActionList
extends OsidList

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

       
       
       while (al.hasNext()) {
            Action action = al.getNextAction();
       }
       
                   
       
  

or

       
       
       while (al.hasNext()) {
            Action[] actions = al.getNextActions(al.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAction

Action getNextAction()
                     throws OperationFailedException

Gets the next Action in this list.

Returns:

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

getNextActions

Action[] getNextActions(long n)
                        throws OperationFailedException

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

Parameters:

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

Returns:

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