Interface EntryBatchForm

All Superinterfaces:
EntryForm, Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable
public interface EntryBatchForm extends EntryForm

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

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

  • Method Details

    • getKeyType

      Type getKeyType()
      Gets the key type of the entry if this is a create transaction.
      Returns:
      the key type
      Throws:
      IllegalStateException - isForUpdate() is true
      Compliance:
      mandatory - This method must be implemented.

    • getKey

      Object getKey()
      Gets the value of the entry if this is a create transaction.
      Returns:
      the value
      Throws:
      IllegalStateException - isForUpdate() is true
      Compliance:
      mandatory - This method must be implemented.

    • getValueType

      Type getValueType()
      Gets the value type of the entry if this is a create transaction.
      Returns:
      the value type
      Throws:
      IllegalStateException - isForUpdate() is true
      Compliance:
      mandatory - This method must be implemented.

    • getEntryId

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