|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserPropertyManager
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.
Method Summary | |
---|---|
com.opensymphony.module.propertyset.PropertySet |
getPropertySet(ApplicationUser user)
Get the property set associated with a user. |
com.opensymphony.module.propertyset.PropertySet |
getPropertySet(com.atlassian.crowd.embedded.api.User user)
Deprecated. Use getPropertySet(ApplicationUser) or getPropertySetForUserKey(String) instead. Since v6.2. |
com.opensymphony.module.propertyset.PropertySet |
getPropertySetForUserKey(String userKey)
Get the property set associated with a user. |
Method Detail |
---|
@Nonnull com.opensymphony.module.propertyset.PropertySet getPropertySet(@Nonnull ApplicationUser user)
user
- the user that the property set is associated with.
IllegalArgumentException
- if user
is null
IllegalStateException
- if the user does not have an ID mapping, which suggests that
the user does not actually exist@Deprecated @Nonnull com.opensymphony.module.propertyset.PropertySet getPropertySet(@Nonnull com.atlassian.crowd.embedded.api.User user)
getPropertySet(ApplicationUser)
or getPropertySetForUserKey(String)
instead. Since v6.2.
user
- the user that the property set is associated with.
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 com.opensymphony.module.propertyset.PropertySet getPropertySetForUserKey(String userKey)
userKey
- the key for the user that the property set is associated with.
IllegalArgumentException
- if userKey
is null
IllegalStateException
- if the user does not have an ID mapping, which suggests that
the user does not actually exist
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |