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

Interface MyRolesAndActionsInterface

public interface MyRolesAndActionsInterface
MyRolesAndActionsInterface covers the ability to query a person's roles and any actions (to dos) assigned to those roles.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement>
    getMyToDos(String userId, org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus toDoStatus, int startFrom, int pageSize)
    Return a list of to dos assigned to the calling user.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement>
    getMyToDosByActor(String userId, String actorGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus status, int startFrom, int pageSize)
    Return a list of to dos assigned to the calling user.

  • Method Details

    • getMyToDos

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement> getMyToDos(String userId, org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus toDoStatus, 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
      Return a list of to dos assigned to the calling user.
      Parameters:
      userId - userId of user making request.
      toDoStatus - status of the to do (null means current active)
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of to do details
      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.

    • getMyToDosByActor

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement> getMyToDosByActor(String userId, String actorGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus status, 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
      Return a list of to dos assigned to the calling user.
      Parameters:
      userId - userId of user making request.
      actorGUID - unique identifier of the user's actor.
      status - status of the to do (null means current active)
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of to do details
      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.