com.atlassian.confluence.user.actions

Class EditNotificationsAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.user.actions.AbstractUserProfileAction

com.atlassian.confluence.user.actions.EditNotificationsAction

All Implemented Interfaces:

PageAware, WebInterface, SpaceAware, Spaced, UserAware, BreadcrumbAware, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

public class EditNotificationsAction
extends AbstractUserProfileAction
implements SpaceAware, PageAware

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.confluence.user.actions.AbstractUserProfileAction

attachmentManager, favouriteManager, followManager, HOMEPAGE_DASHBOARD, HOMEPAGE_PROFILE, HOMEPAGE_SITEHOME, HTML_FRIENDLY_NAME, HTML_MIME_TYPE, notificationManager, personalInformationManager, spaceManager, statusTextRenderer, TEXT_FRIENDLY_NAME, TEXT_MIME_TYPE, userDetailsManager, userStatusManager, wikiStyleRenderer

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

Constructors

Constructor and Description
EditNotificationsAction()

Method Summary

Modifier and Type	Method and Description
String	doAddPageNotification()
String	doAddSpaceNotification()
String	doRemovePageNotification()
String	doRemoveSpaceNotification()
String	execute()
AbstractPage	getPage()
long	getPageId()
List	getPageNotificationsForUser()
int	getPageSize()
List	getPaginatedItems()
PaginationSupport	getPaginationSupport()
Space	getSpace()
String	getSpaceKey()
String	getSpaceName()
List	getSpaceNotificationsForUser()
AddWatchLink	getUndoLink()
boolean	isChangesSaved()
boolean	isLatestVersionRequired() If the action can only work on the most recent version of a page, this will cause the interceptor to silently replace the version that it looks up with the most recent version, if necessary.
boolean	isPageRequired() If the action requires that the page be set before being run, then it should return true to this method.
boolean	isPermitted()
boolean	isSpaceRequired() If the action requires that the space be set before being run, then it should return true to this method.
void	resetPagination()
void	setChangesSaved(boolean changesSaved)
void	setContentType(String contentType)
void	setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)
void	setPage(AbstractPage page) IOC method for setting the page on the action.
void	setPageId(long pageId)
void	setSpace(Space space) IOC method for setting the space on the action.
void	setSpaceKey(String spaceKey)
void	setStartIndex(int startIndex)

Methods inherited from class com.atlassian.confluence.user.actions.AbstractUserProfileAction

currentUserHasLicensedAccess, getAttachments, getBreadcrumb, getContext, getCurrentStatus, getEmail, getFullName, getHasStatusUpdates, getPageTitle, getPersonalInformation, getPersonalInformationEntity, getPersonalSpaceKey, getRenderedAboutMe, getStatusTextRenderer, getUser, getUsername, getUserPreferences, getUserProfilePicture, getUserProperty, getWebInterfaceContext, hasPersonalSpace, isFavourite, isFollowing, isHasAboutMe, isMyProfile, isUserRequired, isViewingMyProfile, isViewPermissionRequired, setAttachmentManager, setFavouriteManager, setFollowManager, setNotificationManager, setPersonalInformation, setPersonalInformationManager, setSpaceManager, setStatusTextRenderer, setUserDetailsManager, setUserStatusManager, setWikiStyleRenderer

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getConfluenceAccessManager, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSharedMode, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setApiDateFormatService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, 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.spaces.actions.SpaceAware

isViewPermissionRequired

Methods inherited from interface com.atlassian.confluence.pages.actions.PageAware

isEditPermissionRequired, isViewPermissionRequired

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware

validate

Constructor Detail

EditNotificationsAction

public EditNotificationsAction()

Method Detail

setEventPublisher

public void setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)

getPaginationSupport

public PaginationSupport getPaginationSupport()

setStartIndex

public void setStartIndex(int startIndex)

getPageSize

public int getPageSize()

getPaginatedItems

public List getPaginatedItems()

doAddSpaceNotification

public String doAddSpaceNotification()

doRemoveSpaceNotification

public String doRemoveSpaceNotification()

doAddPageNotification

public String doAddPageNotification()

doRemovePageNotification

public String doRemovePageNotification()

getPageNotificationsForUser

public List getPageNotificationsForUser()

getSpaceNotificationsForUser

public List getSpaceNotificationsForUser()

execute

public String execute()
               throws Exception

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class com.opensymphony.xwork.ActionSupport

Throws:

Exception

resetPagination

public void resetPagination()

getPage

public AbstractPage getPage()

Specified by:

getPage in interface PageAware

Returns:

page the page that the action worked on

setPage

public void setPage(AbstractPage page)

Description copied from interface: PageAware

IOC method for setting the page on the action. This is called from the interceptor

Specified by:

setPage in interface PageAware

Parameters:

page - the page that the action will be working on.

getSpaceKey

public String getSpaceKey()

getSpaceName

public String getSpaceName()

setSpaceKey

public void setSpaceKey(String spaceKey)

getUndoLink

public AddWatchLink getUndoLink()

isPageRequired

public boolean isPageRequired()

Description copied from interface: PageAware

If the action requires that the page be set before being run, then it should return true to this method. If the action requires a page, but no page is available, then the interceptor will automatically redirect to the 'pagenotfound' result

Specified by:

isPageRequired in interface PageAware

Returns:

true if the action requires a page in order to execute

isLatestVersionRequired

public boolean isLatestVersionRequired()

Description copied from interface: PageAware

If the action can only work on the most recent version of a page, this will cause the interceptor to silently replace the version that it looks up with the most recent version, if necessary.

Specified by:

isLatestVersionRequired in interface PageAware

Returns:

true if the action requires the most recent version of a page

isPermitted

public boolean isPermitted()

Overrides:

isPermitted in class ConfluenceActionSupport

setPageId

public void setPageId(long pageId)

getPageId

public long getPageId()

isChangesSaved

public boolean isChangesSaved()

setChangesSaved

public void setChangesSaved(boolean changesSaved)

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

getSpace

public Space getSpace()

Specified by:

getSpace in interface Spaced

setContentType

public void setContentType(String contentType)