Interface SubjectBatchFormList

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

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

while (sbfl.hasNext()) {
     SubjectBatchForm form = sbfl.getNextSubjectBatchForm();
}
or 
while (sbfl.hasNext()) {
     SubjectBatchForm[] forms = sbfl.getNextSubjectBatchForms(sbfl.available());
}

  • Method Details

    • getNextSubjectBatchForm

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

    • getNextSubjectBatchForms

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