com.atlassian.jira.plugin.profile
Class FullProfileUserFormat

java.lang.Object
  extended by com.atlassian.jira.plugin.profile.FullProfileUserFormat
All Implemented Interfaces:
UserFormat

public class FullProfileUserFormat
extends Object
implements UserFormat

Provides the full user's profile that is used to display the column on the left in the View Profile page.

Since:
v3.13

Field Summary
 
Fields inherited from interface com.atlassian.jira.plugin.profile.UserFormat
VIEW_TEMPLATE
 
Constructor Summary
FullProfileUserFormat(EmailFormatter emailFormatter, PermissionManager permissionManager, JiraAuthenticationContext authenticationContext, GroupPermissionChecker groupPermissionChecker, WebFragmentWebComponent webFragmentWebComponent, UserUtil userUtil, UserFormatModuleDescriptor moduleDescriptor)
           
 
Method Summary
 String format(String username, String id)
          Renders the formatted user for a given section on the screen.
 String format(String username, String id, Map params)
          Renders the formatted user for a given section on the screen.
 String getDisplayEmail(User user)
           
 String getUserLinks(User profileUser, String template)
           
 Map getUserProperties(User user)
          These user properties are currently only visible to JIRA Administrators
 boolean hasViewGroupPermission(String group)
           
 boolean isEmailVisible(User user)
           
 boolean isHasPermission(int permissionsId)
           
 boolean isUserLoggedinUser(User user)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FullProfileUserFormat

public FullProfileUserFormat(EmailFormatter emailFormatter,
                             PermissionManager permissionManager,
                             JiraAuthenticationContext authenticationContext,
                             GroupPermissionChecker groupPermissionChecker,
                             WebFragmentWebComponent webFragmentWebComponent,
                             UserUtil userUtil,
                             UserFormatModuleDescriptor moduleDescriptor)
Method Detail

format

public String format(String username,
                     String id)
Description copied from interface: UserFormat
Renders the formatted user for a given section on the screen. Please note that the username may be null (for anonymous user's) or the user may not exist. Implementations should handle these cases.

Extra context can be passed to the renderer via the id attribute. Ideally an implementation might include this id in the rendered output such that it can be used for test assertions.

Specified by:
format in interface UserFormat
Parameters:
username - the user's username to format.
id - A value providing extra context to the rendering process.
Returns:
the formatted user

format

public String format(String username,
                     String id,
                     Map params)
Description copied from interface: UserFormat
Renders the formatted user for a given section on the screen. Please note that the username may be null (for anonymous user's) or the user may not exist. Implementations should handle these cases.

Extra context can be passed to the renderer via the params attribute.

Specified by:
format in interface UserFormat
Parameters:
username - the user's username to format.
params - Additional context to pass to the renderer
Returns:
the formatted user

isUserLoggedinUser

public boolean isUserLoggedinUser(User user)

isEmailVisible

public boolean isEmailVisible(User user)

getDisplayEmail

public String getDisplayEmail(User user)

hasViewGroupPermission

public boolean hasViewGroupPermission(String group)

getUserLinks

public String getUserLinks(User profileUser,
                           String template)

getUserProperties

public Map getUserProperties(User user)
These user properties are currently only visible to JIRA Administrators

Parameters:
user - The user to get properties for.
Returns:
java.util.Map of user properties

isHasPermission

public boolean isHasPermission(int permissionsId)


Copyright © 2002-2008 Atlassian. All Rights Reserved.