Class SystemProblemWebSpecifics


  • public class SystemProblemWebSpecifics
    extends Object
    Contains web UI specific information related to a particular system problem. Conststs of the solution web link, and the problem caption.
    • The solution link is the URL, following which the user is able to solve the raised system problem. For example, in case of VCS connection errors the solution link leads to the VCS Root configuration page.
    • The problem caption is the heading of the problem section. For example, for VCS connection errors this text looks something like "VCS problem: <VCS Root description>". In general, this text should shortly characterize the problem and point somehow to the source of the problem.
    • Constructor Detail

      • SystemProblemWebSpecifics

        public SystemProblemWebSpecifics​(@NotNull
                                         WebLink solutionLink,
                                         @NotNull
                                         String problemCaption,
                                         @Nullable
                                         String branchName)
        Constructs the object with the given properties
        Parameters:
        solutionLink - solution link
        problemCaption - problem caption
        branchName - branchName (if any)
      • SystemProblemWebSpecifics

        public SystemProblemWebSpecifics​(@NotNull
                                         WebLink solutionLink,
                                         @NotNull
                                         String problemCaption)
        Constructs the object with the given properties
        Parameters:
        solutionLink - solution link
        problemCaption - problem caption
    • Method Detail

      • getSolutionLink

        @NotNull
        public WebLink getSolutionLink()
        Returns:
        the solution link
      • getProblemCaption

        @NotNull
        public String getProblemCaption()
        Returns:
        the problem source description
      • getAdditionalData

        @Nullable
        @Deprecated
        public String getAdditionalData()
        Deprecated.
        use getBranchName()
        Returns:
        additional web data
      • getBranchName

        @Nullable
        public String getBranchName()
        Returns:
        optional associated branch name