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

Interface MyFavouriteCollectionsInterface

public interface MyFavouriteCollectionsInterface

MyFavouriteCollectionsInterface covers the management of the MyAssets, MyProjects and MyCommunities collections associated with a person's personal profile.

Method Summary

Modifier and Type	Method	Description
void	addToMyAssets(String userId, String assetGUID)	Add an asset to the identified user's list of favorite assets.
void	addToMyCommunities(String userId, String communityGUID)	Add a community to the identified user's list of favorite communities.
void	addToMyProjects(String userId, String projectGUID)	Add a project to the identified user's list of favorite projects.
List<AssetCollectionMember>	getMyAssets(String userId, int startFrom, int pageSize)	Return a list of assets that the specified user has added to their favorites list.
List<CommunityCollectionMember>	getMyCommunities(String userId, int startFrom, int pageSize)	Return a list of communities that the specified user has added to their favorites list.
List<ProjectCollectionMember>	getMyProjects(String userId, int startFrom, int pageSize)	Return a list of projects that the specified user has added to their favorites list.
void	removeFromMyAssets(String userId, String assetGUID)	Remove an asset from identified user's list of favorite assets.
void	removeFromMyCommunities(String userId, String communityGUID)	Remove a community from identified user's list of favorite communities.
void	removeFromMyProjects(String userId, String projectGUID)	Remove a project from identified user's list of favorite projects.

Method Detail

getMyAssets

List<AssetCollectionMember> getMyAssets(String userId,
                                        int startFrom,
                                        int pageSize)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        UserNotAuthorizedException

Return a list of assets that the specified user has added to their favorites list.

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 asset 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.

addToMyAssets

void addToMyAssets(String userId,
                   String assetGUID)
            throws InvalidParameterException,
                   PropertyServerException,
                   UserNotAuthorizedException

Add an asset to the identified user's list of favorite assets.

Parameters:

userId - userId of user making request.

assetGUID - unique identifier of the asset.

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem updating information in the property server(s).

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

removeFromMyAssets

void removeFromMyAssets(String userId,
                        String assetGUID)
                 throws InvalidParameterException,
                        PropertyServerException,
                        UserNotAuthorizedException

Remove an asset from identified user's list of favorite assets.

Parameters:

userId - userId of user making request.

assetGUID - unique identifier of the asset.

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem updating information in the property server(s).

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

getMyProjects

List<ProjectCollectionMember> getMyProjects(String userId,
                                            int startFrom,
                                            int pageSize)
                                     throws InvalidParameterException,
                                            PropertyServerException,
                                            UserNotAuthorizedException

Return a list of projects that the specified user has added to their favorites list.

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 project 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.

addToMyProjects

void addToMyProjects(String userId,
                     String projectGUID)
              throws InvalidParameterException,
                     PropertyServerException,
                     UserNotAuthorizedException

Add a project to the identified user's list of favorite projects.

Parameters:

userId - userId of user making request.

projectGUID - unique identifier of the project.

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem updating information in the property server(s).

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

removeFromMyProjects

void removeFromMyProjects(String userId,
                          String projectGUID)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException

Remove a project from identified user's list of favorite projects.

Parameters:

userId - userId of user making request.

projectGUID - unique identifier of the project.

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem updating information in the property server(s).

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

getMyCommunities

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

Return a list of communities that the specified user has added to their favorites list.

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.

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

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

addToMyCommunities

void addToMyCommunities(String userId,
                        String communityGUID)
                 throws InvalidParameterException,
                        PropertyServerException,
                        UserNotAuthorizedException

Add a community to the identified user's list of favorite communities.

Parameters:

userId - userId of user making request.

communityGUID - unique identifier of the community.

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem updating information in the property server(s).

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

removeFromMyCommunities

void removeFromMyCommunities(String userId,
                             String communityGUID)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Remove a community from identified user's list of favorite communities.

Parameters:

userId - userId of user making request.

communityGUID - unique identifier of the community.

Throws:

InvalidParameterException - one of the parameters is invalid

PropertyServerException - there is a problem updating information in the property server(s)

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