Interface ContactBatchForm

All Superinterfaces:
ContactForm, Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable
public interface ContactBatchForm extends ContactForm

This is the form for creating and updating contacts in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ContactBatchAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Like all OsidForms, ContactBatchForm is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getAddressId

      Id getAddressId()
      Gets the Address Id of the contact if this is a create transaction.
      Returns:
      the address Id
      Throws:
      IllegalStateException - isForUpdate() is true
      Compliance:
      mandatory - This method must be implemented.

    • getReferenceId

      Id getReferenceId()
      Gets the reference Id of the contact if this is a create transaction.
      Returns:
      the reference Id
      Throws:
      IllegalStateException - isForUpdate() is true
      Compliance:
      mandatory - This method must be implemented.

    • getContactId

      Id getContactId()
      Gets the Id of the contact to be updated if this is an update transaction.
      Returns:
      the contact Id
      Throws:
      IllegalStateException - isForUpdate() is false
      Compliance:
      mandatory - This method must be implemented.