Interface PersonalProfileManagementInterface


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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String addContactMethod​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String profileUserId, ContactMethodType type, java.lang.String service, java.lang.String value)
      Add a new contact method to the requesting user's profile.
      java.lang.String createPersonalProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String profileUserId, java.lang.String qualifiedName, java.lang.String fullName, java.lang.String knownName, java.lang.String jobTitle, java.lang.String jobRoleDescription, java.util.Map<java.lang.String,​java.lang.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​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String profileUserId, java.lang.String contactMethodGUID, ContactMethodType type)
      Remove an obsolete contact method from the requesting user's profile.
      void deletePersonalProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String profileGUID, java.lang.String qualifiedName)
      Delete the personal profile.
      java.util.List<ContactMethodProperties> getContactMethods​(java.lang.String userId, java.lang.String profileUserId)
      Return the list of contact methods for this user.
      long getKarmaPoints​(java.lang.String userId, java.lang.String profileUserId)
      Return the total karma points for this user.
      PersonalProfileUniverse getPersonalProfileByGUID​(java.lang.String userId, java.lang.String profileGUID)
      Retrieve a personal profile by guid.
      PersonalProfileUniverse getPersonalProfileByQualifiedName​(java.lang.String userId, java.lang.String qualifiedName)
      Retrieve a personal profile by personnel/serial/unique employee number of the individual.
      PersonalProfileUniverse getPersonalProfileForUser​(java.lang.String userId, java.lang.String profileUserId)
      Retrieve a personal profile by userId.
      java.util.List<PersonalProfileUniverse> getPersonalProfilesByName​(java.lang.String userId, java.lang.String name)
      Return a list of candidate personal profiles for an individual.
      void updatePersonalProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String profileGUID, java.lang.String qualifiedName, java.lang.String fullName, java.lang.String knownName, java.lang.String jobTitle, java.lang.String jobRoleDescription, java.util.Map<java.lang.String,​java.lang.Object> profileProperties, java.util.Map<java.lang.String,​java.lang.String> additionalProperties)
      Update properties for the personal properties.
    • Method Detail

      • createPersonalProfile

        java.lang.String createPersonalProfile​(java.lang.String userId,
                                               java.lang.String externalSourceGUID,
                                               java.lang.String externalSourceName,
                                               java.lang.String profileUserId,
                                               java.lang.String qualifiedName,
                                               java.lang.String fullName,
                                               java.lang.String knownName,
                                               java.lang.String jobTitle,
                                               java.lang.String jobRoleDescription,
                                               java.util.Map<java.lang.String,​java.lang.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​(java.lang.String userId,
                                   java.lang.String externalSourceGUID,
                                   java.lang.String externalSourceName,
                                   java.lang.String profileGUID,
                                   java.lang.String qualifiedName,
                                   java.lang.String fullName,
                                   java.lang.String knownName,
                                   java.lang.String jobTitle,
                                   java.lang.String jobRoleDescription,
                                   java.util.Map<java.lang.String,​java.lang.Object> profileProperties,
                                   java.util.Map<java.lang.String,​java.lang.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​(java.lang.String userId,
                                   java.lang.String externalSourceGUID,
                                   java.lang.String externalSourceName,
                                   java.lang.String profileGUID,
                                   java.lang.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.
      • addContactMethod

        java.lang.String addContactMethod​(java.lang.String userId,
                                          java.lang.String externalSourceGUID,
                                          java.lang.String externalSourceName,
                                          java.lang.String profileUserId,
                                          ContactMethodType type,
                                          java.lang.String service,
                                          java.lang.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​(java.lang.String userId,
                                 java.lang.String externalSourceGUID,
                                 java.lang.String externalSourceName,
                                 java.lang.String profileUserId,
                                 java.lang.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.