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<ToDoElement>	getMyToDos(String userId, ToDoStatus toDoStatus, int startFrom, int pageSize)	Return a list of to dos assigned to the calling user.
List<ToDoElement>	getMyToDosByActor(String userId, String actorGUID, ToDoStatus status, int startFrom, int pageSize)	Return a list of to dos assigned to the calling user.

Method Details

getMyToDos

List<ToDoElement> getMyToDos(String userId,
 ToDoStatus toDoStatus,
 int startFrom,
 int pageSize)
                      throws InvalidParameterException,
PropertyServerException,
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:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getMyToDosByActor

List<ToDoElement> getMyToDosByActor(String userId,
 String actorGUID,
 ToDoStatus status,
 int startFrom,
 int pageSize)
                             throws InvalidParameterException,
PropertyServerException,
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:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.