org.odpi.openmetadata.accessservices.communityprofile.api

Interface MyPersonalNetworkInterface

public interface MyPersonalNetworkInterface

MyPersonalNetworkInterface provides interfaces to query the personal network of the individual. This includes the teams and communities they belong and the roles they have.

Method Summary

Modifier and Type	Method and Description
List<Community>	getMyCommunities(String userId, int startFrom, int pageSize) Return a list of communities that the specified user is a member of.
List<PersonRole>	getMyRoles(String userId, int startFrom, int pageSize) Return a list of roles that the specified user is a member of.
List<Team>	getMyTeams(String userId, int startFrom, int pageSize) Return a list of teams that the specified user is a member of.

Method Detail

getMyCommunities

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

Return a list of communities that the specified user is a member of.

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 community details

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile so can not be a member of any communities.

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

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

getMyRoles

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

Return a list of roles that the specified user is a member of.

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 role details

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

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

getMyTeams

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

Return a list of teams that the specified user is a member of.

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 team details

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile so can not register as a member of any teams.

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

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