com.atlassian.confluence.labels.actions
Class EditLabelAction

java.lang.Object
  extended bycom.opensymphony.xwork.ActionSupport
      extended bycom.atlassian.confluence.core.ConfluenceActionSupport
          extended bycom.atlassian.confluence.labels.actions.EditLabelAction
All Implemented Interfaces:
com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, Serializable, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware

public class EditLabelAction
extends ConfluenceActionSupport

Simple action to edit a content objects labels.

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, 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
EditLabelAction()
           
 
Method Summary
 String execute()
          Update the labels associated with the labelable instance.
 String getId()
          Retrieve the currently specified id of the object being updated.
 Labelable getLabelable()
          Retrieve the instance being edited.
 String getLabelNames()
          Retrieve a comma separated string of label names.
 List getLabels()
          Simple getter to retrieve the labels currently associated with the labelable instance.
 boolean isPermitted()
           
protected  Labelable load()
           
 void setContentEntityManager(ContentEntityManager manager)
           
 void setId(String id)
          The content id to uniquely identify the object being updated.
 void setLabelNames(String names)
          Set a comma separated string of label names.
 void validate()
          Process the validation rules.
 
Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addPermissionTypeTo, addToHistory, doDefault, getActionName, getBootstrapManager, getCancelResult, getDateFormatter, getDefaultResourceBundle, getEditorLanguage, getEventManager, getGlobalHelper, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSpaceHelper, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, setBootstrapManager, setCancel, setEventManager, setFormatSettingsManager, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setPermissionCheck, setPermissionManager, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EditLabelAction

public EditLabelAction()
Method Detail

setId

public void setId(String id)
The content id to uniquely identify the object being updated.

Parameters:
id -

getId

public String getId()
Retrieve the currently specified id of the object being updated.

Returns:
content id

setContentEntityManager

public void setContentEntityManager(ContentEntityManager manager)

getLabels

public List getLabels()
Simple getter to retrieve the labels currently associated with the labelable instance.

Returns:
a list of Label instances.

getLabelable

public Labelable getLabelable()
Retrieve the instance being edited.

Returns:
a labelable instance.

getLabelNames

public String getLabelNames()
Retrieve a comma separated string of label names.

Returns:
a comma separated string

setLabelNames

public void setLabelNames(String names)
Set a comma separated string of label names.

Parameters:
names -

validate

public void validate()
Process the validation rules.


execute

public String execute()
               throws Exception
Update the labels associated with the labelable instance.

Returns:
Throws:
Exception

load

protected Labelable load()

isPermitted

public boolean isPermitted()
Overrides:
isPermitted in class ConfluenceActionSupport


Confluence is developed by Atlassian.