Package org.odpi.openmetadata.accessservices.communityprofile.api

Interface PersonalProfileManagementInterface

public interface PersonalProfileManagementInterface

PersonalProfileManagementInterface defines the client interface for an administrator setting up a profile for an individual.

Method Summary

Modifier and Type	Method	Description
String	addContactMethod(String userId, String externalSourceGUID, String externalSourceName, String profileUserId, ContactMethodType type, String service, String value)	Add a new contact method to the requesting user's profile.
String	createPersonalProfile(String userId, String externalSourceGUID, String externalSourceName, String profileUserId, String qualifiedName, String fullName, String knownName, String jobTitle, String jobRoleDescription, Map<String,String> additionalProperties)	Create a personal profile for an individual who is to be appointed to a governance role but does not have a profile in open metadata.
void	deleteContactMethod(String userId, String externalSourceGUID, String externalSourceName, String profileUserId, String contactMethodGUID, ContactMethodType type)	Remove an obsolete contact method from the requesting user's profile.
void	deletePersonalProfile(String userId, String externalSourceGUID, String externalSourceName, String profileGUID, String qualifiedName)	Delete the personal profile.
List<ContactMethodProperties>	getContactMethods(String userId, String profileUserId)	Return the list of contact methods for this user.
long	getKarmaPoints(String userId, String profileUserId)	Return the total karma points for this user.
PersonalProfileUniverse	getPersonalProfileByGUID(String userId, String profileGUID)	Retrieve a personal profile by guid.
PersonalProfileUniverse	getPersonalProfileByQualifiedName(String userId, String qualifiedName)	Retrieve a personal profile by personnel/serial/unique employee number of the individual.
PersonalProfileUniverse	getPersonalProfileForUser(String userId, String profileUserId)	Retrieve a personal profile by userId.
List<PersonalProfileUniverse>	getPersonalProfilesByName(String userId, String name)	Return a list of candidate personal profiles for an individual.
void	updatePersonalProfile(String userId, String externalSourceGUID, String externalSourceName, String profileGUID, String qualifiedName, String fullName, String knownName, String jobTitle, String jobRoleDescription, Map<String,Object> profileProperties, Map<String,String> additionalProperties)	Update properties for the personal properties.

Method Detail

createPersonalProfile

String createPersonalProfile(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String profileUserId,
                             String qualifiedName,
                             String fullName,
                             String knownName,
                             String jobTitle,
                             String jobRoleDescription,
                             Map<String,String> additionalProperties)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Create a personal profile for an individual who is to be appointed to a governance role but does not have a profile in open metadata.

Parameters:

userId - the name of the calling user.

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

profileUserId - userId of the individual whose profile this is.

qualifiedName - personnel/serial/unique employee number of the individual.

fullName - full name of the person.

knownName - known name or nickname of the individual.

jobTitle - job title of the individual.

jobRoleDescription - job description of the individual.

additionalProperties - additional properties about the individual.

Returns:

Unique identifier for the personal profile.

Throws:

InvalidParameterException - the employee number or full name is null.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

updatePersonalProfile

void updatePersonalProfile(String userId,
                           String externalSourceGUID,
                           String externalSourceName,
                           String profileGUID,
                           String qualifiedName,
                           String fullName,
                           String knownName,
                           String jobTitle,
                           String jobRoleDescription,
                           Map<String,Object> profileProperties,
                           Map<String,String> additionalProperties)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Update properties for the personal properties. Null values result in empty fields in the profile.

Parameters:

userId - the name of the calling user.

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

profileGUID - unique identifier for the profile.

qualifiedName - personnel/serial/unique employee number of the individual. Used to verify the profileGUID.

fullName - full name of the person.

knownName - known name or nickname of the individual.

jobTitle - job title of the individual.

jobRoleDescription - job description of the individual.

profileProperties - properties about the individual for a new type that is the subclass of Person.

additionalProperties - additional properties about the individual.

Throws:

InvalidParameterException - the known name is null or the qualifiedName does not match the profileGUID.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

deletePersonalProfile

void deletePersonalProfile(String userId,
                           String externalSourceGUID,
                           String externalSourceName,
                           String profileGUID,
                           String qualifiedName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Delete the personal profile.

Parameters:

userId - the name of the calling user.

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

profileGUID - unique identifier for the profile.

qualifiedName - personnel/serial/unique employee number of the individual.

Throws:

InvalidParameterException - the qualifiedName or guid is null or not recognized

PropertyServerException - the server is not available

UserNotAuthorizedException - the calling user is not authorized to issue the call.

getKarmaPoints

long getKarmaPoints(String userId,
                    String profileUserId)
             throws InvalidParameterException,
                    PropertyServerException,
                    UserNotAuthorizedException

Return the total karma points for this user.

Parameters:

userId - userId of the user making the request.

profileUserId - userId of the profile to update.

Returns:

int count of karma points

Throws:

InvalidParameterException - the userId is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getContactMethods

List<ContactMethodProperties> getContactMethods(String userId,
                                                String profileUserId)
                                         throws InvalidParameterException,
                                                PropertyServerException,
                                                UserNotAuthorizedException

Return the list of contact methods for this user.

Parameters:

userId - userId of the user making the request.

profileUserId - userId of the profile to update.

Returns:

list of contact methods

Throws:

InvalidParameterException - the userId is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addContactMethod

String addContactMethod(String userId,
                        String externalSourceGUID,
                        String externalSourceName,
                        String profileUserId,
                        ContactMethodType type,
                        String service,
                        String value)
                 throws InvalidParameterException,
                        PropertyServerException,
                        UserNotAuthorizedException

Add a new contact method to the requesting user's profile.

Parameters:

userId - the name of the calling user.

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

profileUserId - userId of the profile to update.

type - type of contact method.

service - service for the contact method.

value - account name for the service.

Returns:

unique identifier (guid) for the new contact method.

Throws:

InvalidParameterException - the userId is null or invalid. Another property is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

deleteContactMethod

void deleteContactMethod(String userId,
                         String externalSourceGUID,
                         String externalSourceName,
                         String profileUserId,
                         String contactMethodGUID,
                         ContactMethodType type)
                  throws InvalidParameterException,
                         PropertyServerException,
                         UserNotAuthorizedException

Remove an obsolete contact method from the requesting user's profile.

Parameters:

userId - the name of the calling user.

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

profileUserId - userId of the profile to update.

contactMethodGUID - unique identifier (guid) for the obsolete contact method.

type - type of contact method. This is used to confirm that the GUID is the right one.

Throws:

InvalidParameterException - the userId is null or invalid. Another property is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getPersonalProfileByGUID

PersonalProfileUniverse getPersonalProfileByGUID(String userId,
                                                 String profileGUID)
                                          throws InvalidParameterException,
                                                 PropertyServerException,
                                                 UserNotAuthorizedException

Retrieve a personal profile by guid.

Parameters:

userId - the name of the calling user.

profileGUID - unique identifier for the profile.

Returns:

personal profile object.

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

getPersonalProfileForUser

PersonalProfileUniverse getPersonalProfileForUser(String userId,
                                                  String profileUserId)
                                           throws InvalidParameterException,
                                                  PropertyServerException,
                                                  UserNotAuthorizedException

Retrieve a personal profile by userId.

Parameters:

userId - the name of the calling user.

profileUserId - userId associated with the profile.

Returns:

personal profile object.

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

getPersonalProfileByQualifiedName

PersonalProfileUniverse getPersonalProfileByQualifiedName(String userId,
                                                          String qualifiedName)
                                                   throws InvalidParameterException,
                                                          PropertyServerException,
                                                          UserNotAuthorizedException

Retrieve a personal profile by personnel/serial/unique employee number of the individual.

Parameters:

userId - the name of the calling user.

qualifiedName - personnel/serial/unique employee number of the individual.

Returns:

personal profile object.

Throws:

InvalidParameterException - the employee number.

PropertyServerException - the server is not available, or there is a problem retrieving the profile.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

getPersonalProfilesByName

List<PersonalProfileUniverse> getPersonalProfilesByName(String userId,
                                                        String name)
                                                 throws InvalidParameterException,
                                                        PropertyServerException,
                                                        UserNotAuthorizedException

Return a list of candidate personal profiles for an individual. It matches on full name and known name. The name may include wild card parameters.

Parameters:

userId - the name of the calling user.

name - name of individual.

Returns:

list of personal profile objects.

Throws:

InvalidParameterException - the name is null.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.