org.osid.checklist

Interface ChecklistNodeList

All Superinterfaces:

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

public interface ChecklistNodeList
extends OsidList

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

       
       
       while (cnl.hasNext()) {
            ChecklistNode node = cnl.getNextChecklistNode();
       }
       
                   
       
  

or

       
       
       while (cnl.hasNext()) {
            ChecklistNode[] nodes = cnl.getNextChecklistNodes(cnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextChecklistNode

ChecklistNode getNextChecklistNode()
                                   throws OperationFailedException

Gets the next ChecklistNode in this list.

Returns:

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

getNextChecklistNodes

ChecklistNode[] getNextChecklistNodes(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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