org.osid.contact.rules

Interface ContactEnablerList

All Superinterfaces:

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

public interface ContactEnablerList
extends OsidList

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

       
       
       while (cel.hasNext()) {
            ContactEnabler enabler = cel.getNextContactEnabler();
       }
       
                   
       
  

or

       
       
       while (cel.hasNext()) {
            ContactEnabler[] enablers = cel.getNextContactEnablers(cel.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextContactEnabler

ContactEnabler getNextContactEnabler()
                                     throws OperationFailedException

Gets the next ContactEnabler in this list.

Returns:

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

getNextContactEnablers

ContactEnabler[] getNextContactEnablers(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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