org.osid.offering

Interface OfferingList

All Superinterfaces:

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

public interface OfferingList
extends OsidList

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

       
       
       while (ol.hasNext()) {
            Offering offering = ol.getNextOffering();
       }
       
                   
       
  

or

       
       
       while (ol.hasNext()) {
            Offering[] offerings = ol.getNextOfferings(ol.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextOffering

Offering getNextOffering()
                         throws OperationFailedException

Gets the next Offering in this list.

Returns:

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

getNextOfferings

Offering[] getNextOfferings(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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