org.osid.offering.rules

Interface OfferingConstrainerEnablerList

All Superinterfaces:

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

public interface OfferingConstrainerEnablerList
extends OsidList

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

       
       
       while (ocel.hasNext()) {
            OfferingConstrainerEnabler enabler = ocel.getNextOfferingConstrainerEnabler();
       }
       
                   
       
  

or

       
       
       while (ocel.hasNext()) {
            OfferingConstrainerEnabler[] enablers = ocel.getNextOfferingConstrainerEnablers(ocel.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextOfferingConstrainerEnabler

OfferingConstrainerEnabler getNextOfferingConstrainerEnabler()
                                                             throws OperationFailedException

Gets the next OfferingConstrainerEnabler in this list.

Returns:

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

getNextOfferingConstrainerEnablers

OfferingConstrainerEnabler[] getNextOfferingConstrainerEnablers(long n)
                                                                throws OperationFailedException

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

Parameters:

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

Returns:

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