com.atlassian.confluence.plugins.labels.actions

Class AddLabelAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.plugins.labels.actions.AddLabelAction

All Implemented Interfaces:

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

public final class AddLabelAction
extends ConfluenceActionSupport
implements Beanable

Adds a label to a page or blog post 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, 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
AddLabelAction()

Method Summary

Modifier and Type	Method and 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
String	getEntityType()
boolean	isPermitted()
void	setEntityId(long entityId)
void	setEntityType(String type)
void	setLabelsService(LabelsService labelsService)
void	setLabelString(String labelString)

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, getLanguageJs, 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, getUserAccessor, getUserByName, getUserFullName, getUserHasBrowseUsersPermission, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, 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, withServletRequestSupplier

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

AddLabelAction

public AddLabelAction()

Method Detail

getBean

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

Specified by:

getBean in interface Beanable

execute

public String execute()

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class com.opensymphony.xwork.ActionSupport

isPermitted

public boolean isPermitted()

Overrides:

isPermitted in class ConfluenceActionSupport

getCommand

protected AddLabelsCommand getCommand()

getEntity

public Labelable getEntity()

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

Returns:

The entity the label is added to

setEntityId

public void setEntityId(long entityId)

setLabelString

public void setLabelString(String labelString)

setLabelsService

public void setLabelsService(LabelsService labelsService)

setEntityType

public void setEntityType(String type)

getEntityType

public String getEntityType()