org.osid.configuration.rules

Interface ValueEnablerList

All Superinterfaces:

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

public interface ValueEnablerList
extends OsidList

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

       
       
       while (vel.hasNext()) {
            ValueEnabler enabler = vel.getNextValueEnabler();
       }
       
                   
       
  

or

       
       
       while (vel.hasNext()) {
            ValueEnabler[] enablers = vel.getNextValueEnablers(vel.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextValueEnabler

ValueEnabler getNextValueEnabler()
                                 throws OperationFailedException

Gets the next ValueEnabler in this list.

Returns:

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

getNextValueEnablers

ValueEnabler[] getNextValueEnablers(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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