Interface ChecklistList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, 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());
}

Like all OsidLists, ChecklistList is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • 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.