public interface ProfileManager
Modifier and Type | Method and Description |
---|---|
Profile |
addNewPopulatedProfile(User user,
String profileName,
Map attributes)
Adds a new profile based on attribute name/value pairs.
|
Profile |
addNewProfile(User user,
SOAPPrincipal principal,
Locale locale,
String profileName)
Creates and adds a new profile to a given user.
|
void |
deleteProfile(User user,
long profileID)
Deletes a the given profile from a user.
|
Profile |
getProfile(User user,
long profileID)
Retrieves the requested profile from a user.
|
void |
makeDefaultProfile(User user,
long profileID)
Changes the default profile of a user.
|
void |
renameProfile(User user,
long profileID,
String newName)
Rename an existing profile of a user.
|
void |
updateProfile(User user,
long profileID,
Map attributes)
Updates a user's profile given a map of attributes.
|
Profile addNewProfile(User user, SOAPPrincipal principal, Locale locale, String profileName) throws ProfileAlreadyExistsException
user
- the user object to add the new profile to.principal
- the SOAPPrincipal which contains basic attribute data.locale
- the Locale of the user (to get country/language information).profileName
- the name of the new profile.ProfileAlreadyExistsException
- if the user already has a profile with the given profile name.Profile addNewPopulatedProfile(User user, String profileName, Map attributes) throws ProfileAlreadyExistsException
user
- user that owns the profile.profileName
- the name of the new profile.attributes
- MapProfileAlreadyExistsException
- if the user already has a profile with the given profile name.void updateProfile(User user, long profileID, Map attributes) throws ProfileDoesNotExistException, ProfileAccessViolationException
user
- user that owns the profile.profileID
- profile ID of the profile to update.attributes
- MapProfileDoesNotExistException
- if profile with requested profileID does not exist.ProfileAccessViolationException
- if the user does not own the profile with the requested profileID.void makeDefaultProfile(User user, long profileID) throws ProfileDoesNotExistException, ProfileAccessViolationException
user
- user that owns the profile.profileID
- profile ID of the profile to set as default.ProfileDoesNotExistException
- if profile with requested profileID does not exist.ProfileAccessViolationException
- if the user does not own the profile with the requested profileID.void deleteProfile(User user, long profileID) throws ProfileDoesNotExistException, ProfileAccessViolationException, DefaultProfileDeleteException
user
- user that owns the profile.profileID
- profile ID of the profile to update.ProfileDoesNotExistException
- if profile with requested profileID does not exist.ProfileAccessViolationException
- if the user does not own the profile with the requested profileID.DefaultProfileDeleteException
- if the profile requested for deletion is the default profile of the user.void renameProfile(User user, long profileID, String newName) throws ProfileDoesNotExistException, ProfileAccessViolationException, ProfileAlreadyExistsException
user
- user user that owns the profile.profileID
- profileID profile ID of the profile to rename.newName
- new name of the profile.ProfileDoesNotExistException
- if profile with requested profileID does not exist.ProfileAccessViolationException
- if the user does not own the profile with the requested profileID.ProfileAlreadyExistsException
- if user already has a profile with the new name.Profile getProfile(User user, long profileID) throws ProfileDoesNotExistException, ProfileAccessViolationException
user
- user that owns the profile.profileID
- profile ID of the profile to retrieve.ProfileAccessViolationException
- profile with given profileID exists but is not owned by the user.ProfileDoesNotExistException
- profile with given profileID does not exist.Copyright © 2013 Atlassian. All Rights Reserved.