com.atlassian.confluence.labels.actions
Class AddLabelAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.confluence.core.ConfluenceActionSupport
          extended by com.atlassian.confluence.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, java.io.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
CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, 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
AddLabelAction()
           
 
Method Summary
 java.lang.String execute()
           
 java.util.Map<java.lang.String,java.util.Collection<Label>> getBean()
           
protected  AddLabelsCommand getCommand()
           
 Labelable getEntity()
          Used so that the links are correctly built when JS is disabled
 java.lang.String getEntityType()
           
 boolean isPermitted()
           
 void setEntityId(long entityId)
           
 void setEntityType(java.lang.String type)
           
 void setLabelsService(LabelsService labelsService)
           
 void setLabelString(java.lang.String labelString)
           
 
Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setApiDateFormatService, setBootstrapManager, setCancel, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, 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

AddLabelAction

public AddLabelAction()
Method Detail

getBean

public java.util.Map<java.lang.String,java.util.Collection<Label>> getBean()
Specified by:
getBean in interface Beanable

execute

public java.lang.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(java.lang.String labelString)

setLabelsService

public void setLabelsService(LabelsService labelsService)

setEntityType

public void setEntityType(java.lang.String type)

getEntityType

public java.lang.String getEntityType()


Copyright © 2003-2014 Atlassian. All Rights Reserved.