Module is.codion.framework.model
Package is.codion.framework.model

Interface EntityEditor.Settings

Enclosing interface:
EntityEditor
public static interface EntityEditor.Settings
The editor settings.

  • Method Summary

    Modifier and Type
    Method
    Description
    State
    deleteEnabled()
    Disabling delete causes an exception being thrown when deleting.
    State
    insertEnabled()
    Disabling insert causes an exception being thrown when inserting.
    State
    publishPersistenceEvents()
     
    State
    readOnly()
    Making this editor read-only prevents any changes from being persisted to the database, trying to insert, update or delete will cause an exception being thrown, it does not prevent editing.
    State
    updateEnabled()
    Disabling update causes an exception being thrown when updating.
    State
    updateMultipleEnabled()
    Disabling updating multiple entities causes an exception being thrown when trying to update multiple entities at a time.

  • Method Details

    • readOnly

      State readOnly()
      Making this editor read-only prevents any changes from being persisted to the database, trying to insert, update or delete will cause an exception being thrown, it does not prevent editing. Use insertEnabled(), updateEnabled() and deleteEnabled() to configure the enabled state of those specific actions.
      Returns:
      the State controlling whether this editor is read only

    • insertEnabled

      State insertEnabled()
      Disabling insert causes an exception being thrown when inserting.
      Returns:
      the State controlling whether inserting is enabled via this editor

    • updateEnabled

      State updateEnabled()
      Disabling update causes an exception being thrown when updating.
      Returns:
      the State controlling whether updating is enabled via this editor

    • updateMultipleEnabled

      State updateMultipleEnabled()
      Disabling updating multiple entities causes an exception being thrown when trying to update multiple entities at a time.
      Returns:
      the State controlling whether updating multiple entities is enabled

    • deleteEnabled

      State deleteEnabled()
      Disabling delete causes an exception being thrown when deleting.
      Returns:
      the State controlling whether deleting is enabled via this editor

    • publishPersistenceEvents

      State publishPersistenceEvents()
      Returns:
      a state controlling whether this editor publishes insert, update and delete events on the PersistenceEvents event bus.
      See Also: