org.osid.control

Interface SettingList

All Superinterfaces:

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

public interface SettingList
extends OsidList

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

       
       
       while (sl.hasNext()) {
            Setting setting = sl.getNextSetting();
       }
       
                   
       
  

or

       
       
       while (sl.hasNext()) {
            Setting[] settings = sl.getNextSettings(sl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextSetting

Setting getNextSetting()
                       throws OperationFailedException

Gets the next Setting in this list.

Returns:

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

getNextSettings

Setting[] getNextSettings(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

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