com.atlassian.confluence.search.actions

Class ContentNameSearchAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.search.actions.ContentNameSearchAction

All Implemented Interfaces:

Beanable, WebInterface, MessageHolderAware, com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

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.

@Deprecated
public class ContentNameSearchAction
extends ConfluenceActionSupport
implements Beanable, com.opensymphony.webwork.interceptor.ServletRequestAware

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

Field Summary

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

accessModeService, CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, personService, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
ContentNameSearchAction() Deprecated.

Method Summary

Modifier and Type	Method and Description
String	execute() Deprecated. Perform the search and create the ContentNameSearchResult.
Object	getBean() Deprecated.
ContentNameSearchResult	getResult() Deprecated.
void	setContentNameSearchService(ContentNameSearchService contentNameSearchService) Deprecated.
void	setLimit(int limit) Deprecated.
void	setMaxPerCategory(int maxPerCategory) Deprecated.
void	setQuery(String query) Deprecated.
void	setServletRequest(javax.servlet.http.HttpServletRequest httpServletRequest) Deprecated.
void	setSpaceKey(String spaceKey) Deprecated.
void	setType(String[] types) Deprecated.

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getConfluenceAccessManager, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserHasBrowseUsersPermission, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermitted, isPrintableVersion, isSharedMode, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiDateFormatService, setApiPersonService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware

validate

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.xwork.Action

Overrides:

execute in class com.opensymphony.xwork.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.

getResult

public ContentNameSearchResult getResult()

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 com.opensymphony.webwork.interceptor.ServletRequestAware

setContentNameSearchService

public void setContentNameSearchService(ContentNameSearchService contentNameSearchService)

Deprecated.