Interface GradebookColumnBatchFormList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface GradebookColumnBatchFormList extends OsidList

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

while (gcbfl.hasNext()) {
     GradebookColumnBatchForm form = gcbfl.getNextGradebookColumnBatchForm();
}
or 
while (gcbfl.hasNext()) {
     GradebookColumnBatchForm[] forms = gcbfl.getNextGradebookColumnBatchForms(gcbfl.available());
}

  • Method Details

    • getNextGradebookColumnBatchForm

      GradebookColumnBatchForm getNextGradebookColumnBatchForm() throws OperationFailedException
      Gets the next GradebookColumnBatchForm in this list.
      Returns:
      the next GradebookColumnBatchForm in this list. The hasNext() method should be used to test that a next GradebookColumnBatchForm 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.

    • getNextGradebookColumnBatchForms

      GradebookColumnBatchForm[] getNextGradebookColumnBatchForms(long n) throws OperationFailedException
      Gets the next set of GradebookColumnBatchForm elements in this list. The specified amount must be less than or equal to the return from available() .
      Parameters:
      n - the number of GradebookColumnBatchForm elements requested which must be less than or equal to available()
      Returns:
      an array of GradebookColumnBatchForm 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.