com.atlassian.confluence.labels.actions
Class AddSpaceToFavouriteAjaxAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.confluence.core.ConfluenceActionSupport
          extended by com.atlassian.confluence.labels.actions.AddSpaceToFavouriteAjaxAction
All Implemented Interfaces:
Beanable, WebInterface, SpaceAware, Spaced, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

public final class AddSpaceToFavouriteAjaxAction
extends ConfluenceActionSupport
implements Beanable, SpaceAware

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
CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, log, 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
AddSpaceToFavouriteAjaxAction()
           
 
Method Summary
 String execute()
           
 Map<String,Collection<Label>> getBean()
           
protected  AddLabelsCommand getCommand()
           
 Labelable getEntity()
          Used so that the links are correctly built when JS is disabled
 Space getSpace()
           
 boolean isPermitted()
           
 boolean isSpaceRequired()
          If the action requires that the space be set before being run, then it should return true to this method.
 boolean isViewPermissionRequired()
           
 void setEntityId(long entityId)
           
 void setLabelsService(LabelsService labelsService)
           
 void setSpace(Space space)
          IOC method for setting the space on the action.
 
Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getBootstrapManager, getCancelResult, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setBootstrapManager, setCancel, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, 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
 

Constructor Detail

AddSpaceToFavouriteAjaxAction

public AddSpaceToFavouriteAjaxAction()
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

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)

setSpace

public void setSpace(Space space)
Description copied from interface: SpaceAware
IOC method for setting the space on the action. This is called from the interceptor

Specified by:
setSpace in interface SpaceAware
Parameters:
space - the space that the action will be working on.

isSpaceRequired

public boolean isSpaceRequired()
Description copied from interface: SpaceAware
If the action requires that the space be set before being run, then it should return true to this method. If the action requires a space, but no space is available, then the interceptor will automatically redirect to the 'pagenotfound' result

Specified by:
isSpaceRequired in interface SpaceAware
Returns:
true if the action requires a space in order to execute

isViewPermissionRequired

public boolean isViewPermissionRequired()
Specified by:
isViewPermissionRequired in interface SpaceAware
Returns:
true if the action requires view space permission

getSpace

public Space getSpace()
Specified by:
getSpace in interface Spaced

setLabelsService

public void setLabelsService(LabelsService labelsService)


Copyright © 2003-2011 Atlassian. All Rights Reserved.