Class BaseOpenSearchImpl

Object
com.liferay.portal.kernel.search.BaseOpenSearchImpl
All Implemented Interfaces:
OpenSearch
Direct Known Subclasses:
HitsOpenSearchImpl

public abstract class BaseOpenSearchImpl extends Object implements OpenSearch
Author:
Charles May, Brian Wing Shun Chan
  • Constructor Details

    • BaseOpenSearchImpl

      public BaseOpenSearchImpl()
    • BaseOpenSearchImpl

      public BaseOpenSearchImpl(String openSearchURL, String openSearchDescriptionURL)
  • Method Details

    • getClassName

      public String getClassName()
      Specified by:
      getClassName in interface OpenSearch
    • isEnabled

      public boolean isEnabled()
      Specified by:
      isEnabled in interface OpenSearch
    • search

      public abstract String search(jakarta.servlet.http.HttpServletRequest httpServletRequest, long groupId, long userId, String keywords, int startPage, int itemsPerPage, String format) throws SearchException
      Specified by:
      search in interface OpenSearch
      Throws:
      SearchException
    • search

      public String search(jakarta.servlet.http.HttpServletRequest httpServletRequest, long userId, String keywords, int startPage, int itemsPerPage, String format) throws SearchException
      Specified by:
      search in interface OpenSearch
      Throws:
      SearchException
    • search

      public String search(jakarta.servlet.http.HttpServletRequest httpServletRequest, String url) throws SearchException
      Specified by:
      search in interface OpenSearch
      Throws:
      SearchException
    • addSearchResult

      protected void addSearchResult(Element root, long groupId, long scopeGroupId, String entryClassName, long entryClassPK, String title, String link, Date updated, String summary, double score, String format)
    • addSearchResult

      protected void addSearchResult(Element root, long groupId, long scopeGroupId, String entryClassName, long entryClassPK, String title, String link, Date updated, String summary, String[] tags, double ratings, double score, String format)
    • addSearchResultAtom

      protected void addSearchResultAtom(Element root, long groupId, long scopeGroupId, String entryClassName, long entryClassPK, String title, String link, Date updated, String summary, String[] tags, double ratings, double score)
    • addSearchResultRSS

      protected void addSearchResultRSS(Element root, long groupId, long scopeGroupId, String entryClassName, long entryClassPK, String title, String link, Date updated, String summary, String[] tags, double ratings, double score)
    • addSearchResults

      protected Object[] addSearchResults(String[] queryTerms, String keywords, int startPage, int itemsPerPage, int total, int start, String title, String searchPath, String format, ThemeDisplay themeDisplay)
    • addSearchResultsAtom

      protected Object[] addSearchResultsAtom(Document doc, String[] queryTerms, String keywords, int startPage, int itemsPerPage, int total, int start, int totalPages, int previousPage, int nextPage, String title, String searchPath, ThemeDisplay themeDisplay)
    • addSearchResultsRSS

      protected Object[] addSearchResultsRSS(Document doc, String[] queryTerms, String keywords, int startPage, int itemsPerPage, int total, int start, int totalPages, int previousPage, int nextPage, String title, String searchPath, ThemeDisplay themeDisplay)
    • getOpenSearchDescriptionURL

      protected String getOpenSearchDescriptionURL(String searchPath, ThemeDisplay themeDisplay)
    • getOpenSearchURL

      protected String getOpenSearchURL(String searchPath, ThemeDisplay themeDisplay)
    • getPlid

      protected long getPlid(jakarta.servlet.http.HttpServletRequest httpServletRequest, String portletId, long scopeGroupId) throws Exception
      Throws:
      Exception
    • getPortletURL

      protected jakarta.portlet.PortletURL getPortletURL(jakarta.servlet.http.HttpServletRequest httpServletRequest, String portletId) throws Exception
      Throws:
      Exception
    • getPortletURL

      protected jakarta.portlet.PortletURL getPortletURL(jakarta.servlet.http.HttpServletRequest httpServletRequest, String portletId, long scopeGroupId) throws Exception
      Throws:
      Exception
    • getPortletURL

      protected jakarta.portlet.PortletURL getPortletURL(jakarta.servlet.http.HttpServletRequest httpServletRequest, String className, PortletProvider.Action action, long scopeGroupId) throws Exception
      Throws:
      Exception