com.atlassian.jira.web.action.user
Interface UserProfileAction

All Known Implementing Classes:

AddPortalPage, ConfigurePortalPages, EditPortalPage, SaveConfiguration

public interface UserProfileAction

An interface that lists the methods assumed to exist when the action runs under the context of a UserProfile. This should introduce some type safety to these actions.

Since:

v3.13

Method Summary

java.lang.String	getDisplayEmail(java.lang.String email) Get a string that can be used to describe the passed e-mail.
com.opensymphony.user.User	getUser() Return the current user.
boolean	isHasViewGroupPermission(java.lang.String group, com.opensymphony.user.User user) Returns whether or not the passed caller is allowed to see the passed group.

Method Detail

getDisplayEmail

java.lang.String getDisplayEmail(java.lang.String email)

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.

Parameters:

email - the e-mail to convert.

Returns:

the encoded e-mail address.

isHasViewGroupPermission

boolean isHasViewGroupPermission(java.lang.String group,
                                 com.opensymphony.user.User user)

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

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.

getUser

com.opensymphony.user.User getUser()

Return the current user.

Returns:

the current user.