public interface

UserPropertyManager

com.atlassian.jira.user.UserPropertyManager
Known Indirect Subclasses

Class Overview

The manager allows the caller to get the PropertySet associated with a user. Property sets are live objects and changes to the property set are persisted when they occur. The properties that are stored in the user's property set are not part of the JIRA API, and modifying the property set directly may have unexpected side-effects. In most cases, it will make more sense to use the UserPreferencesManager to obtain a user's preferences, instead.

Summary

Public Methods
@Deprecated @Nonnull PropertySet getPropertySet(User user)
This method is deprecated. Use getPropertySet(ApplicationUser) or getPropertySetForUserKey(String) instead. Since v6.2.
@Nonnull PropertySet getPropertySet(ApplicationUser user)
Get the property set associated with a user.
@Nonnull PropertySet getPropertySetForUserKey(String userKey)
Get the property set associated with a user.

Public Methods

@Deprecated @Nonnull public PropertySet getPropertySet (User user)

This method is deprecated.
Use getPropertySet(ApplicationUser) or getPropertySetForUserKey(String) instead. Since v6.2.

Get the property set associated with a user.

Parameters
user the user that the property set is associated with.
Returns
  • property set
Throws
IllegalArgumentException if user is null
IllegalStateException if the user does not have an ID mapping, which suggests that the user does not actually exist

@Nonnull public PropertySet getPropertySet (ApplicationUser user)

Get the property set associated with a user.

Parameters
user the user that the property set is associated with.
Returns
  • the property set for this user
Throws
IllegalArgumentException if user is null
IllegalStateException if the user does not have an ID mapping, which suggests that the user does not actually exist

@Nonnull public PropertySet getPropertySetForUserKey (String userKey)

Get the property set associated with a user.

Parameters
userKey the key for the user that the property set is associated with.
Returns
  • property set
Throws
IllegalArgumentException if userKey is null
IllegalStateException if the user does not have an ID mapping, which suggests that the user does not actually exist