Package jetbrains.buildServer.serverSide

Interface CriticalErrors

All Superinterfaces:

ErrorsCollection

All Known Implementing Classes:

CriticalErrorsImpl, SecuredCriticalErrorsImpl

public interface CriticalErrors
extends ErrorsCollection

Maintains list of critical errors that must be shown on every page.

Since:

3.0

Method Summary

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

Methods inherited from interface jetbrains.buildServer.serverSide.ErrorsCollection

getErrors

Method Detail

putError

void putError(@NotNull
              String key,
              @NotNull
              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
              String key,
              @NotNull
              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
                      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
                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
Collection<String> getErrorKeys()

Returns all error keys.

Returns:

see above

Since:

3.0

getError

@Nullable
String getError(@NotNull
                String key)

Parameters:

key - particular key to look for

Returns:

error message for specified key