Package lumis.portal.documentation

Class DocumentationResource

  • @Path("/lum-internal/documentation")
public class DocumentationResource
extends java.lang.Object
    Documentation utilities methods.
    Since:
    10.0.0
    Version:
    $Revision: 20151 $ $Date: 2017-04-26 13:14:10 -0300 (Wed, 26 Apr 2017) $

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Response goTo​(java.lang.String page, java.lang.String locale)
      Redirects user to the desired page in the online documentation.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DocumentationResource

        public DocumentationResource()

    • Method Detail

      • goTo

        @Path("/goTo/{page:[a-zA-Z0-9_.]+}")
@GET
public Response goTo​(@PathParam("page")
                     java.lang.String page,
                     @QueryParam("locale")
                     java.lang.String locale)
              throws PortalException
        Redirects user to the desired page in the online documentation.
        Parameters:
        page - the requested documentation page.
        locale - the optional locale.
        Returns:
        the response.
        Throws:
        PortalException
        Since:
        10.0.0