Package jetbrains.buildServer.serverSide

Interface CriticalErrors

  • All Superinterfaces:
    ErrorsCollection
    public interface CriticalErrors
extends ErrorsCollection
    Maintains list of critical errors that must be shown on every page.
    Since:
    3.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearError​(java.lang.String key)
      Removes error with specified key
      void clearErrors()
      Clears all of the errors
      boolean containsError​(java.lang.String key)
      Returns true if an error with specified key exists
      java.lang.String getError​(java.lang.String key)  
      java.util.Collection<java.lang.String> getErrorKeys()
      Returns all error keys.
      boolean hasErrors()
      Returns true if and only if there is any error.
      void putError​(java.lang.String key, java.lang.String message)
      Adds a new error and logs it to a log gile with warning log level
      void putError​(java.lang.String key, java.lang.String message, boolean logMessage)
      Adds a new error

    • Method Detail

      • putError

        void putError​(@NotNull
              java.lang.String key,
              @NotNull
              java.lang.String message)
        Adds a new error and logs it to a log gile with warning log level
        Parameters:
        key - error key
        message - error message
        Since:
        3.0

      • putError

        void putError​(@NotNull
              java.lang.String key,
              @NotNull
              java.lang.String message,
              boolean logMessage)
        Adds a new error
        Parameters:
        key - error key
        message - error message
        logMessage - if true then the log will be logged to a log file with warning log level
        Since:
        2023.11

      • containsError

        boolean containsError​(@NotNull
                      java.lang.String key)
        Returns true if an error with specified key exists
        Parameters:
        key - key of the error
        Returns:
        true if error exists
        Since:
        3.0

      • clearError

        void clearError​(@NotNull
                java.lang.String key)
        Removes error with specified key
        Parameters:
        key - key of the error
        Since:
        3.0

      • clearErrors

        void clearErrors()
        Clears all of the errors
        Since:
        3.0

      • hasErrors

        boolean hasErrors()
        Returns true if and only if there is any error.
        Since:
        2021.1

      • getErrorKeys

        @NotNull
java.util.Collection<java.lang.String> getErrorKeys()
        Returns all error keys.
        Returns:
        see above
        Since:
        3.0

      • getError

        @Nullable
java.lang.String getError​(@NotNull
                          java.lang.String key)
        Parameters:
        key - particular key to look for
        Returns:
        error message for specified key