Package com.e1c.g5.v8.dt.check.settings

Interface ICheckSettings

All Superinterfaces:
INamedElement
All Known Implementing Classes:
CheckSettings
public interface ICheckSettings extends INamedElement
Check description with settngs.

  • Method Details

    • getId

      CheckUid getId()
      Gets the unique idenfier of the check
      Specified by:
      getId in interface INamedElement
      Returns:
      The unique identifier of the check. May not be null

    • getParameters

      Map<String,ICheckParameterSettings> getParameters()
      Returns the immutable map of check properties by names.
      Returns:
      map of check properties by names, not null.

    • getSeverity

      IssueSeverity getSeverity()
      Gets the severity of the check as configured
      Returns:
      The severity of the check. May not be null

    • getType

      IssueType getType()
      Gets the type of the check issues
      Returns:
      The type of the check issues. May not be null

    • isDefault

      boolean isDefault()
      Returns whether check settings is default.
      Returns:
      whether check settings is default.

    • isEnabled

      boolean isEnabled()
      Reads the enablement status of the check
      Returns:
      True if the check is enabled at the moment

    • isProtectedObjectCheckEnabled

      boolean isProtectedObjectCheckEnabled()
      Reads the protected object check mode enablement status
      Returns:
      True if the protected object check mode is enabled

    • setEnabled

      void setEnabled(boolean enabled)
      Sets check enabling.
      Parameters:
      enabled - check enabling

    • setSeverity

      void setSeverity(IssueSeverity severity)
      Sets check severity.
      Parameters:
      severity - check severity, not null