org.osid.process

Interface StateList

All Superinterfaces:

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

public interface StateList
extends OsidList

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

       
       
       while (sl.hasNext()) {
            State state = sl.getNextState();
       }
       
                   
       
  

or

       
       
       while (sl.hasNext()) {
            State[] states = sl.getNextStates(sl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
State	getNextState() Gets the next State in this list.
State[]	getNextStates(long n) Gets the next set of States in this list which must be less than or equal to the return from available().

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

getNextState

State getNextState()
                   throws OperationFailedException

Gets the next State in this list.

Returns:

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

getNextStates

State[] getNextStates(long n)
                      throws OperationFailedException

Gets the next set of States in this list which must be less than or equal to the return from available().

Parameters:

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

Returns:

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