Interface MailboxBatchFormList

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

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

while (mbfl.hasNext()) {
     MailboxBatchForm form = mbfl.getNextMailboxBatchForm();
}
or 
while (mbfl.hasNext()) {
     MailboxBatchForm[] forms = mbfl.getNextMailboxBatchForms(mbfl.available());
}

  • Method Details

    • getNextMailboxBatchForm

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

    • getNextMailboxBatchForms

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