Package org.odpi.openmetadata.viewservices.myprofile.server

Class MyProfileRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.myprofile.server.MyProfileRESTServices
public class MyProfileRESTServices extends TokenController
The MyProfileRESTServices provides the server-side implementation of the My Profile Open Metadata View Service (OMVS). This interface provides access to a person's profile, roles and network.

  • Constructor Details

    • MyProfileRESTServices

      public MyProfileRESTServices()
      Default constructor

  • Method Details

    • getMyProfile

      public PersonalProfileResponse getMyProfile(String serverName)
      Return the profile for this user.
      Parameters:
      serverName - name of the server instances for this request
      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.

    • createToDo

      public GUIDResponse createToDo(String serverName, ToDoRequestBody requestBody)
      Create a new to do action and link it to the supplied role and targets (if applicable).
      Parameters:
      serverName - name of the server instances for this request
      requestBody - properties of the to do action
      Returns:
      unique identifier of the to do or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • updateToDo

      public VoidResponse updateToDo(String serverName, String toDoGUID, boolean isMergeUpdate, ToDoProperties toDoProperties)
      Update the properties associated with a "To Do".
      Parameters:
      serverName - name of the server instances for this request
      toDoGUID - unique identifier of the to do
      isMergeUpdate - should the toDoProperties overlay the existing stored properties or replace them
      toDoProperties - properties to change
      Returns:
      void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • updateActionTargetProperties

      public VoidResponse updateActionTargetProperties(String serverName, String actionTargetGUID, boolean isMergeUpdate, ToDoActionTargetProperties actionTargetProperties)
      Update the properties associated with an Action Target.
      Parameters:
      serverName - name of the server instances for this request
      actionTargetGUID - unique identifier of the action target relationship
      isMergeUpdate - should the actionTargetProperties overlay the existing stored properties or replace them
      actionTargetProperties - properties to change
      Returns:
      void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • reassignToDo

      public VoidResponse reassignToDo(String serverName, String toDoGUID, String actorGUID, NullRequestBody requestBody)
      Assign a "To Do" to a new actor.
      Parameters:
      serverName - name of the server instances for this request
      toDoGUID - unique identifier of the to do
      actorGUID - actor to assign the action to
      requestBody - null request body
      Returns:
      void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • deleteToDo

      public VoidResponse deleteToDo(String serverName, String toDoGUID, NullRequestBody requestBody)
      Delete an existing to do.
      Parameters:
      serverName - name of the server instances for this request
      toDoGUID - unique identifier of the to do
      requestBody - null request body
      Returns:
      void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getToDo

      public ToDoResponse getToDo(String serverName, String toDoGUID)
      Retrieve a "To Do" by unique identifier.
      Parameters:
      serverName - name of the server instances for this request
      toDoGUID - unique identifier of the to do
      Returns:
      to do bean or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getActionsForActionTarget

      public ToDosResponse getActionsForActionTarget(String serverName, String elementGUID, int startFrom, int pageSize, ToDoStatusRequestBody requestBody)
      Retrieve the "To Dos" that are chained off of an action target element.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique identifier of the element to start with
      startFrom - initial position of the results to return
      pageSize - maximum number of results to return
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getActionsForSponsor

      public ToDosResponse getActionsForSponsor(String serverName, String elementGUID, int startFrom, int pageSize, ToDoStatusRequestBody requestBody)
      Retrieve the "To Dos" that are chained off of a sponsoring element.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique identifier of the element to start with
      startFrom - initial position of the results to return
      pageSize - maximum number of results to return
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getAssignedActions

      public ToDosResponse getAssignedActions(String serverName, String actorGUID, int startFrom, int pageSize, ToDoStatusRequestBody requestBody)
      Retrieve the "To Dos" for a particular actor.
      Parameters:
      serverName - name of the server instances for this request
      actorGUID - unique identifier of the role
      startFrom - initial position of the results to return
      pageSize - maximum number of results to return
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • findToDos

      public ToDosResponse findToDos(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, ToDoStatusSearchString requestBody)
      Retrieve the "To Dos" that match the search string.
      Parameters:
      serverName - name of the server instances for this request
      startFrom - initial position of the results to return
      pageSize - maximum number of results to return
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getToDosByType

      public ToDosResponse getToDosByType(String serverName, String toDoType, int startFrom, int pageSize, ToDoStatusRequestBody requestBody)
      Retrieve the "To Dos" that match the type name and status.
      Parameters:
      serverName - name of the server instances for this request
      toDoType - type to search for
      startFrom - initial position of the results to return
      pageSize - maximum number of results to return
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call