Package org.odpi.openmetadata.accessservices.communityprofile.api

Interface ToDoManagementInterface

public interface ToDoManagementInterface

  • Method Details

    • createToDo

      String createToDo(String userId, String originatorGUID, String assignToRoleGUID, List<String> targetElementGUIDs, ToDoProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Create a new to do action and link it to the supplied role and targets (if applicable).
      Parameters:
      userId - calling user
      originatorGUID - optional originator element (such as a meeting or project or asset)
      assignToRoleGUID - optional role to assign the action to
      targetElementGUIDs - optional list of elements that the action is to target
      properties - properties of the to do action
      Returns:
      unique identifier of the to do
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter 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

    • updateToDo

      void updateToDo(String userId, String toDoGUID, boolean isMergeUpdate, ToDoProperties toDoProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Update the properties associated with a To Do.
      Parameters:
      userId - calling user
      toDoGUID - unique identifier of the to do
      isMergeUpdate - should the toDoProperties overlay the existing stored properties or replace them
      toDoProperties - properties to change
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter 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

    • deleteToDo

      void deleteToDo(String userId, String toDoGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Delete an existing to do.
      Parameters:
      userId - calling user
      toDoGUID - unique identifier of the to do
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter 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

    • getToDo

      ToDoElement getToDo(String userId, String toDoGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Retrieve a to do by unique identifier.
      Parameters:
      userId - calling user
      toDoGUID - unique identifier of the to do
      Returns:
      to do bean
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter 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

    • getActionsForElement

      List<ToDoElement> getActionsForElement(String userId, String elementGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Retrieve the to dos that are chained off of an element.
      Parameters:
      userId - calling user
      elementGUID - unique identifier of the element to start with
      startFrom - initial position of the results to return
      pageSize - maximum number of results to return
      Returns:
      list of to do beans
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter 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

    • getAssignedActions

      List<ToDoElement> getAssignedActions(String userId, String roleGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Retrieve the to dos for a particular person role.
      Parameters:
      userId - calling user
      roleGUID - unique identifier of the role
      startFrom - initial position of the results to return
      pageSize - maximum number of results to return
      Returns:
      list of to do beans
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter 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