Package com.atlassian.confluence.impl.search.actions

Class ContentNameSearchAction

  • All Implemented Interfaces:
    Beanable, WebInterface, MessageHolderAware, com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable, org.apache.struts2.action.ServletRequestAware, org.apache.struts2.interceptor.ServletRequestAware
    @Deprecated
public class ContentNameSearchAction
extends ConfluenceActionSupport
implements Beanable, org.apache.struts2.interceptor.ServletRequestAware
    Deprecated.
    since 5.2. Instead please use the REST endpoint that is provided by the 'Confluence QuickNav' Bundled Plugin. Please use /rest/quicknav/1/search instead. It accepts the exact same arguments and is thus API compatible with this class. You should be able to swap them out directly.

    An action that will take a query String from the front end and apply it as a search across the 'universal title' field within the Confluence search index.

    See Also:
    Serialized Form

    • Constructor Detail

      • ContentNameSearchAction

        public ContentNameSearchAction()
        Deprecated.

    • Method Detail

      • execute

        public String execute()
               throws Exception
        Deprecated.

        Perform the search and create the ContentNameSearchResult. The individual ContentNameMatch objects within the result will be ordered and grouped, so you can count on getting results ordered like -

        • all page matches
        • all blog matches
        • all attachment matches
        • all user matches
        • all space matches

        If a particular category has no matches then it will not be included in the result.

        Specified by:
        execute in interface com.opensymphony.xwork2.Action
        Overrides:
        execute in class com.opensymphony.xwork2.ActionSupport
        Throws:
        Exception

      • setQuery

        public void setQuery​(String query)
        Deprecated.

      • setType

        public void setType​(String[] types)
        Deprecated.

      • setSpaceKey

        public void setSpaceKey​(String spaceKey)
        Deprecated.

      • setMaxPerCategory

        public void setMaxPerCategory​(int maxPerCategory)
        Deprecated.

      • setLimit

        public void setLimit​(int limit)
        Deprecated.

      • getBean

        public Object getBean()
        Deprecated.
        Specified by:
        getBean in interface Beanable
        Returns:
        the result bean (ContentNameSearchResult) on successful execution of this action. If the action has not executed then the return value will be null.

      • setServletRequest

        public void setServletRequest​(javax.servlet.http.HttpServletRequest httpServletRequest)
        Deprecated.
        Specified by:
        setServletRequest in interface org.apache.struts2.interceptor.ServletRequestAware

      • setContentNameSearchService

        public void setContentNameSearchService​(ContentNameSearchService contentNameSearchService)
        Deprecated.