com.atlassian.confluence.admin.actions.macros
Class UpdateUserMacroAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.confluence.core.ConfluenceActionSupport
          com.atlassian.confluence.admin.actions.macros.UserMacroAction
              com.atlassian.confluence.admin.actions.macros.UpdateUserMacroAction

All Implemented Interfaces:

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 class UpdateUserMacroAction
extends UserMacroAction

Action for updating a user macro

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.confluence.admin.actions.macros.UserMacroAction

macro, macroManager, macroMetadataManager, userMacro, userMacroLibrary

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

UpdateUserMacroAction()

Method Summary

java.lang.String	doDefault() Default webwork action execution method.
java.lang.String	doUpdate() Remove the existing user macro and then add the updated user macro
java.lang.String	getMode()
java.lang.String	getOriginalName()
java.util.List<HTMLPairType>	getOutputTypes() Populates the output type select box if the macro being edited is a legacy one with a wiki markup template.
java.lang.String	getSubmitKey()
void	setOriginalName(java.lang.String originalName)
void	validate()

Methods inherited from class com.atlassian.confluence.admin.actions.macros.UserMacroAction

addUpdateMacro, countUserMacrosWithoutMetadata, countUserMacrosWithWikiTemplates, getBodyTypes, getCategories, getShowInMacroBrowser, getUserMacro, getUserMacros, isMissingMetadata, isPermitted, isWikiTemplate, setMacro, setMacroManager, setMacroMetadataManager, setShowInMacroBrowser, setUserMacro, setUserMacroLibrary, validateMacroForm, validateNewMacroName

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, 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, execute, 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

UpdateUserMacroAction

public UpdateUserMacroAction()

Method Detail

getOriginalName

public java.lang.String getOriginalName()

setOriginalName

public void setOriginalName(java.lang.String originalName)

validate

public void validate()

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface com.opensymphony.xwork.Validateable

Overrides:

validate in class com.opensymphony.xwork.ActionSupport

doDefault

public java.lang.String doDefault()
                           throws java.lang.Exception

Description copied from class: ConfluenceActionSupport

Default webwork action execution method.

Overrides:

doDefault in class UserMacroAction

Returns:

the action result

Throws:

java.lang.Exception - if something goes wrong

doUpdate

public java.lang.String doUpdate()

Remove the existing user macro and then add the updated user macro

Returns:

SUCCESS

getOutputTypes

public java.util.List<HTMLPairType> getOutputTypes()

Populates the output type select box if the macro being edited is a legacy one with a wiki markup template. Otherwise return an empty list since current Confluence has no choice of template type.

Returns:

list of output types

getMode

public java.lang.String getMode()

getSubmitKey

public java.lang.String getSubmitKey()