org.osid.control

Interface DeviceList

All Superinterfaces:

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

public interface DeviceList
extends OsidList

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

       
       
       while (dl.hasNext()) {
            Device device = dl.getNextDevice();
       }
       
                   
       
  

or

       
       
       while (dl.hasNext()) {
            Device[] devices = dl.getNextDevices(dl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextDevice

Device getNextDevice()
                     throws OperationFailedException

Gets the next Device in this list.

Returns:

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

getNextDevices

Device[] getNextDevices(long n)
                        throws OperationFailedException

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

Parameters:

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

Returns:

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