org.osid.control.rules

Interface DeviceEnablerList

All Superinterfaces:

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

public interface DeviceEnablerList
extends OsidList

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

       
       
       while (del.hasNext()) {
            DeviceEnabler enabler = del.getNextDeviceEnabler();
       }
       
                   
       
  

or

       
       
       while (duel.hasNext()) {
            DeviceEnabler[] enablers = del.getNextDeviceEnablers(del.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextDeviceEnabler

DeviceEnabler getNextDeviceEnabler()
                                   throws OperationFailedException

Gets the next DeviceEnabler in this list.

Returns:

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

getNextDeviceEnablers

DeviceEnabler[] getNextDeviceEnablers(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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