Interface AddressBookBatchFormList

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

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

while (abbfl.hasNext()) {
     AddressBookBatchForm form = abbfl.getNextAddressBookBatchForm();
}
or 
while (abbfl.hasNext()) {
     AddressBookBatchForm[] forms = abbfl.getNextAddressBookBatchForms(abbfl.available());
}

  • Method Details

    • getNextAddressBookBatchForm

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

    • getNextAddressBookBatchForms

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