Interface SupersedingEventForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable
public interface SupersedingEventForm extends OsidRuleForm

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

  • Method Details

    • getSupersededDateMetadata

      Metadata getSupersededDateMetadata()
      Gets the metadata to superseding an event within a recurring series by date.
      Returns:
      metadata for a superseded date
      Compliance:
      mandatory - This method must be implemented.

    • setSupersededDate

      void setSupersededDate(DateTime date)
      Sets the superseded date.
      Parameters:
      date - the new superseded date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - date cannot be modified
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSupersededDate

      void clearSupersededDate()
      Clears the superseded date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getSupersededEventPositionMetadata

      Metadata getSupersededEventPositionMetadata()
      Gets the metadata to superseding an event within a recurring series by date.
      Returns:
      metadata for a superseded date
      Compliance:
      mandatory - This method must be implemented.

    • setSupersededEventPosition

      void setSupersededEventPosition(long position)
      Sets the superseded position. A negative number counts from the end of the series.
      Parameters:
      position - the new superseded position
      Throws:
      InvalidArgumentException - position is invalid
      NoAccessException - position cannot be modified
      Compliance:
      mandatory - This method must be implemented.

    • clearSupersededEventPosition

      void clearSupersededEventPosition()
      Clears the superseded position.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventFormRecord

      SupersedingEventFormRecord getSupersedingEventFormRecord(Type supersedingEventRecordType) throws OperationFailedException
      Gets the SupersedingEventFormRecord corresponding to the given superseding event record Type.
      Parameters:
      supersedingEventRecordType - the superseding event record type
      Returns:
      the superseding event form record
      Throws:
      NullArgumentException - supersedingEventRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(supersedingEventRecordType) is false
      Compliance:
      mandatory - This method must be implemented.