org.osid.checklist

Interface ChecklistList

All Superinterfaces:

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

public interface ChecklistList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Checklist checklist = cl.getNextChecklist();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Checklist[] checklist = cl.getNextChecklists(cl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextChecklist

Checklist getNextChecklist()
                           throws OperationFailedException

Gets the next Checklist in this list.

Returns:

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

getNextChecklists

Checklist[] getNextChecklists(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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