Interface Configuration

All Known Implementing Classes:
ConfigurationEntity

public interface Configuration

A process configuration entry: a key/value pair which is either global or scoped to a single tenant.

  • Field Details

    • STATUS_ACTIVE

      static final String STATUS_ACTIVE
      Lifecycle status of an entry which is currently in effect.
      See Also:
    • STATUS_DELETED

      static final String STATUS_DELETED
      Lifecycle status of an entry which has been soft-deleted.
      See Also:
    • STATUS_INACTIVE

      static final String STATUS_INACTIVE
      Lifecycle status of an entry which has been superseded by a newer version.
      See Also:
  • Method Details

    • getId

      String getId()
      Returns:
      the id of the configuration entry
    • getConfigKey

      String getConfigKey()
      Returns:
      the configuration key
    • getTenantId

      String getTenantId()
      Returns:
      the id of the tenant this entry belongs to, or null for a global entry
    • getConfigValue

      String getConfigValue()
      Returns:
      the configuration value
    • getVersion

      int getVersion()
      Returns:
      the version of this entry, starting at 1
    • getStatus

      String getStatus()
      Returns:
      the lifecycle status: STATUS_ACTIVE, STATUS_INACTIVE or STATUS_DELETED
    • getCreatedBy

      String getCreatedBy()
      Returns:
      the id of the user who created this entry
    • getCreatedAt

      Date getCreatedAt()
      Returns:
      the time this entry was created
    • getUpdatedBy

      String getUpdatedBy()
      Returns:
      the id of the user who last updated this entry
    • getUpdatedAt

      Date getUpdatedAt()
      Returns:
      the time this entry was last updated