org.osid

Interface PropertyList

All Superinterfaces:

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

public interface PropertyList
extends OsidList

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

       
       
       while (pl.hasNext()) {
            Property property = pl.getNextProperty();
       }
       
                   
       
  

or

       
       
       while (pl.hasNext()) {
            Property[] properties = pl.getNextProperties(pl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Property[]	getNextProperties(long n) Gets the next set of Property elements in this list which must be less than or equal to the number returned from available().
Property	getNextProperty() Gets the next Property 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

getNextProperty

Property getNextProperty()
                         throws OperationFailedException

Gets the next Property in this list.

Returns:

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

getNextProperties

Property[] getNextProperties(long n)
                             throws OperationFailedException

Gets the next set of Property elements in this list which must be less than or equal to the number returned from available().

Parameters:

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

Returns:

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