org.odpi.openmetadata.accessservices.communityprofile.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 and Description
List<PersonalRole>	getMyPersonalRoles(String userId, int startFrom, int pageSize) Return a list of the personal roles that the calling user is appointed to.
List<ToDo>	getMyToDos(String userId, ToDoStatus status, int startFrom, int pageSize) Return a list of to dos assigned to the calling user.
List<ToDo>	getMyToDosByRole(String userId, String personalRoleGUID, ToDoStatus status, int startFrom, int pageSize) Return a list of to dos assigned to the calling user.

Method Detail

getMyPersonalRoles

List<PersonalRole> getMyPersonalRoles(String userId,
                                      int startFrom,
                                      int pageSize)
                               throws InvalidParameterException,
                                      NoProfileForUserException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Return a list of the personal roles that the calling user is appointed to.

Parameters:

userId - userId of user making request.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of personal role details

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile so can not have any collections.

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

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

getMyToDos

List<ToDo> getMyToDos(String userId,
                      ToDoStatus status,
                      int startFrom,
                      int pageSize)
               throws InvalidParameterException,
                      NoProfileForUserException,
                      PropertyServerException,
                      UserNotAuthorizedException

Return a list of to dos assigned to the calling user.

Parameters:

userId - userId of user making request.

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.

NoProfileForUserException - the user does not have a profile so can not have any collections.

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

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

getMyToDosByRole

List<ToDo> getMyToDosByRole(String userId,
                            String personalRoleGUID,
                            ToDoStatus status,
                            int startFrom,
                            int pageSize)
                     throws InvalidParameterException,
                            NoProfileForUserException,
                            PropertyServerException,
                            UserNotAuthorizedException

Return a list of to dos assigned to the calling user.

Parameters:

userId - userId of user making request.

personalRoleGUID - unique identifier of the user's role.

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.

NoProfileForUserException - the user does not have a profile so can not have any collections.

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

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