Interface CyclicEventBatchForm

All Superinterfaces:
CyclicEventForm, Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable
public interface CyclicEventBatchForm extends CyclicEventForm

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

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

  • Method Details

    • getCyclicEventId

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