Package com.atlassian.confluence.labels.actions

Class AddFavouriteAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.labels.actions.AddFavouriteAction

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

public final class AddFavouriteAction
extends ConfluenceActionSupport
implements Beanable

Makes a page or blogpost the favourite of the specified user. Used for JSON requests, a list of the labels added are available under the 'labels' key of the bean.

See Also:

• Serialized Form

Field Summary

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

accessModeService, CANCEL, confluenceAccessManager, contentUiSupport, eventPublisher, formatSettingsManager, globalSettingsManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, localeManager, loginManager, messageHolder, permissionManager, pluginAccessor, PREVIEW, spacePermissionManager, systemInformationService, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork2.ActionSupport

container

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
AddFavouriteAction()

Method Summary

Modifier and Type	Method	Description
String	execute()
Map<String,Collection<Label>>	getBean()
protected AddLabelsCommand	getCommand()
Labelable	getEntity()	Used so that the links are correctly built when JS is disabled
boolean	isPermitted()	Consulted by PermissionCheckInterceptor.
void	setEntityId(long entityId)
void	setLabelsService(LabelsService labelsService)

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, getActionErrors, getActionMessages, getActionName, getAuthenticatedUser, getBootstrapStatusProvider, getCancelResult, getCurrentRequest, getDateFormatter, getDefaultTimeZone, getFieldErrors, getGlobalSettings, getHelper, getI18n, getLocale, getMessageHolder, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getTimeZone, getUserByName, getUserInterfaceState, getWebInterfaceContext, isAnonymousUser, isEmailVisible, setAccessModeService, setBootstrapStatusProvider, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventPublisher, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSkipIsPermitted, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, shouldSkipIsPermitted

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

getText, getText, getText, getText, getText, getText, getText, getText, getTextStrict

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getContainer, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opensymphony.xwork2.LocaleProvider

isValidLocale, isValidLocaleString, toLocale

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

validate

Constructor Details

AddFavouriteAction

public AddFavouriteAction()

Method Details

getBean

public Map<String,Collection<Label>> getBean()

Specified by:

getBean in interface Beanable

execute

public String execute()

Specified by:

execute in interface com.opensymphony.xwork2.Action

Overrides:

execute in class com.opensymphony.xwork2.ActionSupport

isPermitted

public boolean isPermitted()

Description copied from class: ConfluenceActionSupport

Consulted by PermissionCheckInterceptor.

Overrides:

isPermitted in class ConfluenceActionSupport

getEntity

public Labelable getEntity()

Used so that the links are correctly built when JS is disabled

Returns:

The entity the label is added to

getCommand

protected AddLabelsCommand getCommand()

setEntityId

public void setEntityId(long entityId)

setLabelsService

public void setLabelsService(LabelsService labelsService)