Package org.odpi.openmetadata.viewservices.myprofile.api

Interface PersonalProfileManagementInterface

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

  • Method Details

    • 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 org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the employee number or full name is null.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.
      org.odpi.openmetadata.frameworks.connectors.ffdc.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 org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the known name is null or the qualifiedName does not match the profileGUID.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.
      org.odpi.openmetadata.frameworks.connectors.ffdc.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 org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the qualifiedName or guid is null or not recognized
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.

    • getKarmaPoints

      long getKarmaPoints(String userId, String profileUserId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getContactMethods

      List<org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ContactMethodProperties> getContactMethods(String userId, String profileUserId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addContactMethod

      String addContactMethod(String userId, String externalSourceGUID, String externalSourceName, String profileUserId, org.odpi.openmetadata.frameworks.openmetadata.enums.ContactMethodType type, String service, String value) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid. Another property is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • deleteContactMethod

      void deleteContactMethod(String userId, String externalSourceGUID, String externalSourceName, String profileUserId, String contactMethodGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.ContactMethodType type) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid. Another property is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getPersonalProfileByGUID

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.PersonalProfileUniverse getPersonalProfileByGUID(String userId, String profileGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.

    • getPersonalProfileForUser

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.PersonalProfileUniverse getPersonalProfileForUser(String userId, String profileUserId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.

    • getPersonalProfileByQualifiedName

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.PersonalProfileUniverse getPersonalProfileByQualifiedName(String userId, String qualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the employee number.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available, or there is a problem retrieving the profile.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.

    • getPersonalProfilesByName

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.PersonalProfileUniverse> getPersonalProfilesByName(String userId, String name) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the name is null.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.