Package org.odpi.openmetadata.accessservices.communityprofile.server

Class PersonalProfileRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.communityprofile.server.PersonalProfileRESTServices
public class PersonalProfileRESTServices extends Object
The PersonalProfileRESTServices provides the server-side implementation of the Community Profile Open Metadata Assess Service (OMAS) capability for managing personal profiles. This interface provides connections to assets and APIs for adding feedback on the asset.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PersonalProfileRESTServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createPersonalProfile(String serverName, String userId, org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileRequestBody requestBody)
    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.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    deletePersonalProfile(String serverName, String userId, String profileGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileValidatorRequestBody requestBody)
    Delete the personal profile.
    org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileResponse
    getPersonalProfileByGUID(String serverName, String userId, String profileGUID)
    Retrieve a personal profile by guid.
    org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileResponse
    getPersonalProfileByQualifiedName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Retrieve a personal profile by personnel/serial/unique employee number of the individual.
    org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileResponse
    getPersonalProfileForUser(String serverName, String userId, String profileUserId)
    Return the profile for this user.
    org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileListResponse
    getPersonalProfilesByName(String serverName, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Return a list of candidate personal profiles for an individual.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updatePersonalProfile(String serverName, String userId, String profileGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileRequestBody requestBody)
    Update properties for the personal properties.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PersonalProfileRESTServices

      public PersonalProfileRESTServices()
      Default constructor

  • Method Details

    • createPersonalProfile

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createPersonalProfile(String serverName, String userId, org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileRequestBody requestBody)
      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:
      serverName - name of server instance to call
      userId - the name of the calling user.
      requestBody - properties about the individual.
      Returns:
      Unique identifier for the personal profile or InvalidParameterException the employee number or full name is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • updatePersonalProfile

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updatePersonalProfile(String serverName, String userId, String profileGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileRequestBody requestBody)
      Update properties for the personal properties. Null values result in empty fields in the profile.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      profileGUID - unique identifier for the profile.
      requestBody - properties about the individual.
      Returns:
      void response or NoProfileForUserException there is no profile for the user or InvalidParameterException the full name is null or the qualifiedName does not match the profileGUID or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • deletePersonalProfile

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deletePersonalProfile(String serverName, String userId, String profileGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileValidatorRequestBody requestBody)
      Delete the personal profile.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      profileGUID - unique identifier for the profile.
      requestBody - personnel/serial/unique employee number of the individual.
      Returns:
      void response or UnrecognizedGUIDException the unique identifier of the personal profile is either null or invalid or InvalidParameterException the employee number or full name is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • getPersonalProfileForUser

      public org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileResponse getPersonalProfileForUser(String serverName, String userId, String profileUserId)
      Return the profile for this user.
      Parameters:
      serverName - name of the server instances for this request
      userId - userId of the user making the request.
      profileUserId - userId for person that profile belongs to
      Returns:
      profile response object or null or InvalidParameterException the userId is null or invalid or PropertyServerException there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getPersonalProfileByGUID

      public org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileResponse getPersonalProfileByGUID(String serverName, String userId, String profileGUID)
      Retrieve a personal profile by guid.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      profileGUID - unique identifier for the profile.
      Returns:
      personal profile object or UnrecognizedGUIDException the unique identifier of the personal profile is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • getPersonalProfileByQualifiedName

      public org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileResponse getPersonalProfileByQualifiedName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
      Retrieve a personal profile by personnel/serial/unique employee number of the individual.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      requestBody - name information
      Returns:
      personal profile object or InvalidParameterException the employee number or full name is null or EmployeeNumberNotUniqueException more than one personal profile was found or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • getPersonalProfilesByName

      public org.odpi.openmetadata.accessservices.communityprofile.rest.PersonalProfileListResponse getPersonalProfilesByName(String serverName, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
      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:
      serverName - name of server instance to call
      userId - the name of the calling user.
      startFrom - scan pointer
      pageSize - maximum number of results
      requestBody - name information
      Returns:
      list of personal profile objects or InvalidParameterException the name is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.