Interface PublisherBatchFormList

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

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

while (pbfl.hasNext()) {
     PublisherBatchForm form = pbfl.getNextPublisherBtchForm();
}
or 
while (pbfl.hasNext()) {
     PublisherBatchForm[] forms = pbfl.getNextPublisherBatchFormspobfl.available());
}

  • Method Details

    • getNextPublisherBatchForm

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

    • getNextPublisherBatchForms

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