Interface DocumentationBean

    • Method Detail

      • getLink

        String getLink​(String docLink)
        Constructs a link to help documentation
        Parameters:
        docLink - the page title
        Returns:
        link to help documentation
      • getTitle

        String getTitle​(String docLink)
        Retrieves the title for the link to help documentation
        Parameters:
        docLink - the page title
        Returns:
        title for the link
      • getAlt

        String getAlt​(String docLink)
        Retrieves the alt text for images associated with the link to help documentation
        Parameters:
        docLink - the page title
        Returns:
        alt text for images that may be used as or with the link
      • isLocal

        boolean isLocal​(String docLink)
        Retrieves the location of the help documentation
        Parameters:
        docLink - the page title
        Returns:
        true if the documentation is local to the instance, false if it is external
      • exists

        boolean exists​(String docLink)
        Returns true if the documentation link exists, otherwise false.