com.atlassian.confluence.user

Interface PersonalInformationManager

All Known Implementing Classes:

DefaultPersonalInformationManager

public interface PersonalInformationManager

Method Summary

Methods

Modifier and Type	Method and Description
PersonalInformation	createPersonalInformation(com.atlassian.user.User user) Creates a new PersonalInformation for the specified user.
PersonalInformation	getOrCreatePersonalInformation(com.atlassian.user.User user) Retrieve the personal information for a user.
PersonalInformation	getPersonalInformation(com.atlassian.user.User user) Deprecated. since 4.2.5 - use getOrCreatePersonalInformation
boolean	hasPersonalInformation(java.lang.String username)
void	removePersonalInformation(ConfluenceUser user)
void	removePersonalInformation(java.lang.String username) Deprecated. Since 5.2. Use removePersonalInformation(ConfluenceUser).
void	savePersonalInformation(PersonalInformation newInfo, PersonalInformation oldInfo) Saves personal information object.
void	savePersonalInformation(com.atlassian.user.User user, java.lang.String newInfo, java.lang.String fullName) Saves personal information and full name against the user object.

Method Detail

getPersonalInformation

@Deprecated
PersonalInformation getPersonalInformation(com.atlassian.user.User user)

Deprecated. since 4.2.5 - use getOrCreatePersonalInformation

Retrieve the personal information for a user. If no personal information exists in the database, one will be created.

Parameters:

user - the user to retrieve personal information for

Returns:

the personal information for that user

Throws:

java.lang.NullPointerException - if user is null

getOrCreatePersonalInformation

PersonalInformation getOrCreatePersonalInformation(com.atlassian.user.User user)

Retrieve the personal information for a user. If no personal information exists in the database, one will be created.

Parameters:

user - the user to retrieve personal information for

Returns:

the personal information for that user

Throws:

java.lang.NullPointerException - if user is null

Since:

4.2.5

savePersonalInformation

void savePersonalInformation(PersonalInformation newInfo,
                           PersonalInformation oldInfo)

Saves personal information object.

Parameters:

newInfo -

oldInfo -

savePersonalInformation

void savePersonalInformation(com.atlassian.user.User user,
                           java.lang.String newInfo,
                           java.lang.String fullName)

Saves personal information and full name against the user object. Will only store the new information if either the information or full name has changed.

removePersonalInformation

@Deprecated
void removePersonalInformation(java.lang.String username)

Deprecated. Since 5.2. Use removePersonalInformation(ConfluenceUser).

removePersonalInformation

void removePersonalInformation(ConfluenceUser user)

createPersonalInformation

PersonalInformation createPersonalInformation(com.atlassian.user.User user)

Creates a new PersonalInformation for the specified user. Returns the existing one if it already exists.

hasPersonalInformation

boolean hasPersonalInformation(java.lang.String username)

Returns:

true if a there is a PersonalInformation object corresponding to this user, if this method returns false calls to getPersonalInformation and getOrCreatePersonalInformation will create a new PersonalInformation object for this user