org.osid.calendaring

Interface CommitmentList

All Superinterfaces:

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

public interface CommitmentList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Commitment commitment = cl.getNextCommitment();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Commitment[] commitments = cl.getNextCommitment(cl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Commitment	getNextCommitment() Gets the next Commitment in this list.
Commitment[]	getNextCommitments(long n) Gets the next set of Commitment elements in this list which must be less than or equal to the number returned from available().

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

getNextCommitment

Commitment getNextCommitment()
                             throws OperationFailedException

Gets the next Commitment in this list.

Returns:

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

getNextCommitments

Commitment[] getNextCommitments(long n)
                                throws OperationFailedException

Gets the next set of Commitment elements in this list which must be less than or equal to the number returned from available().

Parameters:

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

Returns:

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