com.atlassian.jira.web.action.user
Class ConfigurePortalPages

java.lang.Object
  webwork.action.ActionSupport
      com.atlassian.jira.action.JiraActionSupport
          com.atlassian.jira.web.action.JiraWebActionSupport
              com.atlassian.jira.web.action.user.ConfigurePortalPages

All Implemented Interfaces:

ErrorCollection, I18nHelper, UserProfileAction, SharedEntitySearchAction, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

public class ConfigurePortalPages
extends JiraWebActionSupport
implements UserProfileAction, SharedEntitySearchAction

This action is the place we manage Portal Pages, aka Dashboard pages from

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.web.action.util.sharing.SharedEntitySearchAction

SharedEntitySearchAction.FieldNameMapper, SharedEntitySearchAction.QueryValidator

Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper

I18nHelper.BeanFactory

Field Summary

Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

ISSUE_NOT_FOUND_RESULT, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters

Fields inherited from class com.atlassian.jira.action.JiraActionSupport

log

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

ConfigurePortalPages(PortalPageService portalPageService, JiraAuthenticationContext authenticationContext, EmailFormatter emailFormatter, GroupPermissionChecker groupPermissionChecker, FavouritesService favouritesService, PermissionManager permissionManager, ShareTypeFactory shareTypeFactory, UserFormatManager userFormatManager, com.atlassian.plugin.webresource.WebResourceManager webResourceManager, UserHistoryManager userHistoryManager)

Method Summary

String	doDefault() Default method runs when displaying portal pages.
String	doMoveDown()
String	doMoveToEnd()
String	doMoveToStart()
String	doMoveUp()
Long	getCopyPageId()
PortalPage	getCurrentPortalPage()
String	getDescription()
String	getDisplayEmail(String email) Get a string that can be used to describe the passed e-mail.
int	getEndPosition()
String	getGroupShare()
String	getNextUrl()
Long	getPageId()
String	getPageName(PortalPage portalPage)
List	getPages()
Long	getPagingOffset()
String	getPortalPageName()
com.atlassian.jira.web.action.user.ConfigurePortalPages.PortalPageViewHelper	getPortalPageViewHelper()
int	getPosition()
String	getPreviousUrl()
String	getProjectShare()
String	getRoleShare()
String	getSearchEmptyMessageKey()
String	getSearchName()
String	getSearchOwnerUserName()
String	getSearchShareType()
String	getSortColumn()
int	getStartPosition()
int	getTotalResultCount()
User	getUser() Return the current user.
String	getView()
boolean	isContentOnly()
boolean	isHasViewGroupPermission(String group, User user) Returns whether or not the passed caller is allowed to see the passed group.
boolean	isSearchRequested()
boolean	isSortAscending()
void	setContentOnly(boolean contentOnly)
void	setCopyPageId(Long copyPageId)
void	setDescription(String description)
void	setGroupShare(String groupShare)
void	setPageId(Long pageId)
void	setPagingOffset(Long pagingOffset)
void	setPortalPageName(String portalPageName)
void	setPosition(int position)
void	setProjectShare(String projectShare)
void	setRoleShare(String roleShare)
void	setSearchName(String searchName)
void	setSearchOwnerUserName(String searchOwnerUserName)
void	setSearchShareType(String searchShareType)
void	setSortAscending(boolean sortAscending)
void	setSortColumn(String sortColumn)
void	setView(String view)

Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

addErrorCollection, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, forceRedirect, getApplicationProperties, getAssignableUsers, getAssignableUsers, getComponentManager, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDescTranslation, getExternalLinkUtils, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getJiraServiceContext, getLanguage, getLoggedInUser, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getPropertySet, getRandomHint, getRedirect, getRedirectChecker, getRemoteUser, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getTimeFormat, getUriValidator, getUserFullName, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, htmlEncode, insertContextPath, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isInlineDialogMode, isSystemAdministrator, isUserExists, returnComplete, returnComplete, returnCompleteWithInlineRedirect, setConglomerateCookieValue, setInline, setReturnUrl, setSelectedProjectId

Methods inherited from class com.atlassian.jira.action.JiraActionSupport

addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getComponentInstanceOfType, getDefaultResourceBundle, getDelegator, getI18nHelper, getKeysForPrefix, getLocale, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUnescapedText, getUserPreferences, getWatcherManager, hasAnyErrors, isEnterprise, isIndexing, isProfessional, isProfessionalOrEnterprise, isStandard, removeKeyOrAddError

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doExecute, doValidation, getCommandName, getErrorMessages, getErrors, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, 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.jira.util.ErrorCollection

addError, addErrorMessage, addErrorMessages, addErrors, getErrorMessages, getErrors, hasAnyErrors, setErrorMessages

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Constructor Detail

ConfigurePortalPages

public ConfigurePortalPages(PortalPageService portalPageService,
                            JiraAuthenticationContext authenticationContext,
                            EmailFormatter emailFormatter,
                            GroupPermissionChecker groupPermissionChecker,
                            FavouritesService favouritesService,
                            PermissionManager permissionManager,
                            ShareTypeFactory shareTypeFactory,
                            UserFormatManager userFormatManager,
                            com.atlassian.plugin.webresource.WebResourceManager webResourceManager,
                            UserHistoryManager userHistoryManager)

Method Detail

isHasViewGroupPermission

public boolean isHasViewGroupPermission(String group,
                                        User user)

Description copied from interface: UserProfileAction

Returns whether or not the passed caller is allowed to see the passed group.

Specified by:

isHasViewGroupPermission in interface UserProfileAction

Parameters:

group - the name of the group to check.

user - the user to check.

Returns:

true if the user can see the group or false otherwise.

getDisplayEmail

public String getDisplayEmail(String email)

Description copied from interface: UserProfileAction

Get a string that can be used to describe the passed e-mail. This allows JIRA to hide the passed e-mail if asked to do so.

Specified by:

getDisplayEmail in interface UserProfileAction

Parameters:

email - the e-mail to convert.

Returns:

the encoded e-mail address.

getUser

public User getUser()

Description copied from interface: UserProfileAction

Return the current user.

Specified by:

getUser in interface UserProfileAction

Returns:

the current user.

getSearchName

public String getSearchName()

Specified by:

getSearchName in interface SharedEntitySearchAction

setSearchName

public void setSearchName(String searchName)

Specified by:

setSearchName in interface SharedEntitySearchAction

getSearchOwnerUserName

public String getSearchOwnerUserName()

Specified by:

getSearchOwnerUserName in interface SharedEntitySearchAction

setSearchOwnerUserName

public void setSearchOwnerUserName(String searchOwnerUserName)

Specified by:

setSearchOwnerUserName in interface SharedEntitySearchAction

getSearchShareType

public String getSearchShareType()

Specified by:

getSearchShareType in interface SharedEntitySearchAction

setSearchShareType

public void setSearchShareType(String searchShareType)

Specified by:

setSearchShareType in interface SharedEntitySearchAction

setGroupShare

public void setGroupShare(String groupShare)

Specified by:

setGroupShare in interface SharedEntitySearchAction

getGroupShare

public String getGroupShare()

Specified by:

getGroupShare in interface SharedEntitySearchAction

getPagingOffset

public Long getPagingOffset()

Specified by:

getPagingOffset in interface SharedEntitySearchAction

setProjectShare

public void setProjectShare(String projectShare)

Specified by:

setProjectShare in interface SharedEntitySearchAction

getProjectShare

public String getProjectShare()

Specified by:

getProjectShare in interface SharedEntitySearchAction

setRoleShare

public void setRoleShare(String roleShare)

Specified by:

setRoleShare in interface SharedEntitySearchAction

getRoleShare

public String getRoleShare()

Specified by:

getRoleShare in interface SharedEntitySearchAction

setPagingOffset

public void setPagingOffset(Long pagingOffset)

Specified by:

setPagingOffset in interface SharedEntitySearchAction

getSortColumn

public String getSortColumn()

Specified by:

getSortColumn in interface SharedEntitySearchAction

setSortColumn

public void setSortColumn(String sortColumn)

Specified by:

setSortColumn in interface SharedEntitySearchAction

isSortAscending

public boolean isSortAscending()

Specified by:

isSortAscending in interface SharedEntitySearchAction

setSortAscending

public void setSortAscending(boolean sortAscending)

Specified by:

setSortAscending in interface SharedEntitySearchAction

setPageId

public void setPageId(Long pageId)

getPortalPageName

public String getPortalPageName()

setPortalPageName

public void setPortalPageName(String portalPageName)

getCopyPageId

public Long getCopyPageId()

setCopyPageId

public void setCopyPageId(Long copyPageId)

getPageId

public Long getPageId()

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getView

public String getView()

setView

public void setView(String view)

getPosition

public int getPosition()

setPosition

public void setPosition(int position)

getPageName

public String getPageName(PortalPage portalPage)

isContentOnly

public boolean isContentOnly()

setContentOnly

public void setContentOnly(boolean contentOnly)

getSearchEmptyMessageKey

public String getSearchEmptyMessageKey()

getPortalPageViewHelper

public com.atlassian.jira.web.action.user.ConfigurePortalPages.PortalPageViewHelper getPortalPageViewHelper()

isSearchRequested

public boolean isSearchRequested()

getCurrentPortalPage

public PortalPage getCurrentPortalPage()

getPages

public List getPages()

getNextUrl

public String getNextUrl()

getPreviousUrl

public String getPreviousUrl()

getStartPosition

public int getStartPosition()

getEndPosition

public int getEndPosition()

getTotalResultCount

public int getTotalResultCount()

doDefault

public String doDefault()

Default method runs when displaying portal pages.

Overrides:

doDefault in class webwork.action.ActionSupport

Returns:

the view to display

doMoveUp

public String doMoveUp()

doMoveDown

public String doMoveDown()

doMoveToStart

public String doMoveToStart()

doMoveToEnd

public String doMoveToEnd()