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

Interface MyPersonalProfileInterface

public interface MyPersonalProfileInterface
MyPersonalProfileInterface covers the management of a user's personal profile.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    addMyContactMethod(String userId, org.odpi.openmetadata.frameworks.openmetadata.enums.ContactMethodType type, String service, String value)
    Add a new contact method to the requesting user's profile.
    void
    deleteMyContactMethod(String userId, String contactMethodGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.ContactMethodType type)
    Remove an obsolete contact method from the requesting user's profile.
    void
    deleteMyProfile(String userId, String qualifiedName)
    Delete the profile for the requesting user.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ContactMethodElement>
    getMyContactDetails(String userId)
    Return the list of contact methods for this user.
    long
    getMyKarmaPoints(String userId)
    Return the total karma points for this user.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.PersonalProfileUniverse
    getMyProfile(String userId)
    Return the profile for this user.
    void
    setUpMyProfile(String userId, String qualifiedName, String fullName, String knownName, String jobTitle, String jobRoleDescription, Map<String,String> additionalProperties)
    Create or update the profile for the requesting user.

  • Method Details

    • getMyProfile

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.PersonalProfileUniverse getMyProfile(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the profile for this user.
      Parameters:
      userId - userId of the user making the request.
      Returns:
      profile object
      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.

    • getMyKarmaPoints

      long getMyKarmaPoints(String userId) 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.
      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.

    • getMyContactDetails

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ContactMethodElement> getMyContactDetails(String userId) 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.
      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.

    • setUpMyProfile

      void setUpMyProfile(String userId, 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 or update the profile for the requesting user. This is only permitted if the profile is not locked to (managed by) an external system.
      Parameters:
      userId - the name of the calling user.
      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.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters 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.

    • addMyContactMethod

      String addMyContactMethod(String userId, 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.
      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.

    • deleteMyContactMethod

      void deleteMyContactMethod(String userId, 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.
      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.

    • deleteMyProfile

      void deleteMyProfile(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
      Delete the profile for the requesting user. This is only permitted if the profile is not locked to (managed by) an external system and if the person is not appointed to any roles.
      Parameters:
      userId - the name of the calling user.
      qualifiedName - personnel/serial/unique employee number of the individual.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters 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.