Package com.saperion.ngc.portal.builder.standalone

Class StandaloneHandler

java.lang.Object
com.saperion.ngc.portal.builder.standalone.StandaloneHandler
All Implemented Interfaces:
ElementBuilder, LinkBuilder, LinkValidator
public final class StandaloneHandler extends Object implements ElementBuilder, LinkBuilder, LinkValidator
This Builder can be used to build URLs for the viewer.zul.

  • Method Details

    • with

      public static ElementBuilder with(ResultProperties document) throws com.saperion.util.LinkCreationException
      Creates a builder enclosed by the given document. The resulting link can be used to view the given document in the viewer.zul.
      Parameters:
      document - The document to view.
      Returns:
      an ElementBuilder to enclose the document element to view.
      Throws:
      com.saperion.util.LinkCreationException - if an error occurs.

    • with

      public static ElementBuilder with(String versionId)
      Creates a builder with the given versionId (the XHDOC) of the document to view. The resulting link can be used to view the given document in the viewer.zul.
      Parameters:
      versionId - The versionId (the XHDOC) of the document to view.
      Returns:
      an ElementBuilder to enclose the document element to view.

    • element

      public LinkBuilder element(int element)
      Description copied from interface: ElementBuilder
      Option to specify the document element to view.
      Specified by:
      element in interface ElementBuilder
      Parameters:
      element - the element
      Returns:
      the LinkBuilder

    • firstElement

      public LinkBuilder firstElement()
      Description copied from interface: ElementBuilder
      Option to specify the first document element to view.
      Specified by:
      firstElement in interface ElementBuilder
      Returns:
      the LinkBuilder

    • toLink

      public String toLink(String baseURL)
      Description copied from interface: LinkBuilder
      Builds the weblink url with given baseURL.
      Specified by:
      toLink in interface LinkBuilder
      Parameters:
      baseURL - the base url
      Returns:
      the string

    • toSecureLink

      public String toSecureLink(String baseURL) throws com.saperion.util.LinkCreationException
      Description copied from interface: LinkBuilder
      Builds a secure weblink url with given baseURL.
      Specified by:
      toSecureLink in interface LinkBuilder
      Parameters:
      baseURL - the base url
      Returns:
      the secure link.
      Throws:
      com.saperion.util.LinkCreationException - when the link could not be created

    • validate

      public boolean validate(String secure)
      Description copied from interface: LinkValidator
      Validates the build link with the given secure hash.
      Specified by:
      validate in interface LinkValidator
      Parameters:
      secure - the hash to validate the link with.
      Returns:
      true, if the link is valid, false otherwise.