org.osid.calendaring.rules

Interface CommitmentEnablerList

All Superinterfaces:

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

public interface CommitmentEnablerList
extends OsidList

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

       
       
       while (cel.hasNext()) {
            CommitmentEnabler enabler = cel.getNextCommitmentEnabler();
       }
       
                   
       
  

or

       
       
       while (cel.hasNext()) {
            CommitmentEnabler[] enablers = cel.getNextCommitmentEnablers(cel.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCommitmentEnabler

CommitmentEnabler getNextCommitmentEnabler()
                                           throws OperationFailedException

Gets the next CommitmentEnabler in this list.

Returns:

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

getNextCommitmentEnablers

CommitmentEnabler[] getNextCommitmentEnablers(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

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