Package org.exoplatform.commons.api.search.data

Class SearchContext

java.lang.Object
org.exoplatform.commons.api.search.data.SearchContext
public class SearchContext extends Object
Search Context contains a set of data needed for SearchService and all connectors.
eXo level API
Experimental

  • Constructor Details

    • SearchContext

      public SearchContext(org.exoplatform.web.controller.router.Router router, String siteName)
      Contructor to create a context for search service
      Parameters:
      router -
      siteName -
      eXo level API
      Experimental

  • Method Details

    • getRouter

      public org.exoplatform.web.controller.router.Router getRouter()
      Get router
      Returns:
      Router
      eXo level API
      Experimental

    • setRouter

      public void setRouter(org.exoplatform.web.controller.router.Router router)
      Set router
      Parameters:
      router -
      eXo level API
      Experimental

    • getParamValue

      public String getParamValue(org.exoplatform.web.controller.QualifiedName name)

    • getSiteName

      public String getSiteName()
      Get site name, e.g. intranet, acme, ..
      Returns:
      String
      eXo level API
      Experimental

    • getSiteType

      public String getSiteType()
      Get site type
      Returns:
      String
      eXo level API
      Experimental

    • handler

      public SearchContext handler(String value)
      Puts Handler value into QualifiedName map
      Parameters:
      value -
      Returns:
      SearchContext
      eXo level API
      Experimental

    • lang

      public SearchContext lang(String value)
      Puts Lang value into QualifiedName map
      Parameters:
      value -
      Returns:
      SearchContext
      eXo level API
      Experimental

    • path

      public SearchContext path(String value)
      Puts Path value into QualifiedName map
      Parameters:
      value -
      Returns:
      SearchContext
      eXo level API
      Experimental

    • siteType

      public SearchContext siteType(String value)
      Puts SiteType value into QualifiedName map
      Parameters:
      value -
      Returns:
      SearchContext
      eXo level API
      Experimental

    • siteName

      public SearchContext siteName(String value)
      Puts SiteType value into QualifiedName map
      Parameters:
      value -
      Returns:
      SearchContext
      eXo level API
      Experimental

    • renderLink

      public String renderLink() throws Exception
      Render link base on router and Map<QualifiedName, String>
      Returns:
      String
      Throws:
      Exception
      eXo level API
      Experimental