org.osid.inquiry.rules

Interface InquiryEnablerList

All Superinterfaces:

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

public interface InquiryEnablerList
extends OsidList

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

       
       
       while (iel.hasNext()) {
            InquiryEnabler enabler = iel.getNextInquiryEnabler();
       }
       
                   
       
  

or

       
       
       while (iel.hasNext()) {
            InquiryEnabler[] enablers = iel.getNextInquiryEnablers(iel.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextInquiryEnabler

InquiryEnabler getNextInquiryEnabler()
                                     throws OperationFailedException

Gets the next InquiryEnabler in this list.

Returns:

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

getNextInquiryEnablers

InquiryEnabler[] getNextInquiryEnablers(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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