Interface CommitmentBatchForm

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

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

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

  • Method Details

    • getEventId

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

    • getResourceId

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

    • getCommitmentId

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