org.odpi.openmetadata.accessservices.assetconsumer.handlers

Class FeedbackHandler

java.lang.Object

org.odpi.openmetadata.accessservices.assetconsumer.handlers.FeedbackHandler

All Implemented Interfaces:

AssetConsumerFeedbackInterface

public class FeedbackHandler
extends Object
implements AssetConsumerFeedbackInterface

FeedbackHandler manages the creation of asset feedback (likes, ratings, comments and tags) in the property server.

Constructor Summary

Constructors

Constructor and Description
FeedbackHandler(String serviceName, OMRSRepositoryConnector repositoryConnector) Construct the feedback handler with a link to the property server's connector and this access service's official name.

Method Summary

Modifier and Type	Method and Description
String	addCommentReply(String userId, String commentGUID, CommentType commentType, String commentText) Adds a comment to another comment.
String	addCommentToAsset(String userId, String assetGUID, CommentType commentType, String commentText) Adds a comment to the asset.
String	addLikeToAsset(String userId, String assetGUID) Adds a "Like" to the asset.
String	addReviewToAsset(String userId, String assetGUID, StarRating starRating, String review) Adds a star rating and optional review text to the asset.
void	removeCommentFromAsset(String userId, String commentGUID) Removes a comment added to the asset by this user.
void	removeLikeFromAsset(String userId, String likeGUID) Removes a "Like" added to the asset by this user.
void	removeReviewFromAsset(String userId, String reviewGUID) Removes of a review that was added to the asset by this user.
void	updateComment(String userId, String commentGUID, CommentType commentType, String commentText) Update an existing comment.
void	updateReviewOnAsset(String userId, String reviewGUID, StarRating starRating, String review) Updates the rating and optional review text attached to the asset by this user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FeedbackHandler

public FeedbackHandler(String serviceName,
                       OMRSRepositoryConnector repositoryConnector)

Construct the feedback handler with a link to the property server's connector and this access service's official name.

Parameters:

serviceName - name of this service

repositoryConnector - connector to the property server.

Method Detail

addReviewToAsset

public String addReviewToAsset(String userId,
                               String assetGUID,
                               StarRating starRating,
                               String review)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Adds a star rating and optional review text to the asset.

Specified by:

addReviewToAsset in interface AssetConsumerFeedbackInterface

Parameters:

userId - userId of user making request.

assetGUID - unique identifier for the asset.

starRating - StarRating enumeration for not recommended, one to five stars.

review - user review of asset. This can be null.

Returns:

guid of new review object.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the asset properties to the property server.

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

updateReviewOnAsset

public void updateReviewOnAsset(String userId,
                                String reviewGUID,
                                StarRating starRating,
                                String review)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Updates the rating and optional review text attached to the asset by this user.

Specified by:

updateReviewOnAsset in interface AssetConsumerFeedbackInterface

Parameters:

userId - userId of user making request.

reviewGUID - unique identifier for the review.

starRating - StarRating enumeration for none, one to five stars.

review - user review of asset. This can be null.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the asset properties to the property server.

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

removeReviewFromAsset

public void removeReviewFromAsset(String userId,
                                  String reviewGUID)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Removes of a review that was added to the asset by this user.

Specified by:

removeReviewFromAsset in interface AssetConsumerFeedbackInterface

Parameters:

userId - userId of user making request.

reviewGUID - unique identifier for the review object.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the asset properties in the property server.

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

addLikeToAsset

public String addLikeToAsset(String userId,
                             String assetGUID)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Adds a "Like" to the asset.

Specified by:

addLikeToAsset in interface AssetConsumerFeedbackInterface

Parameters:

userId - userId of user making request.

assetGUID - unique identifier for the asset

Returns:

guid of new like object.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the asset properties to the property server.

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

removeLikeFromAsset

public void removeLikeFromAsset(String userId,
                                String likeGUID)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Removes a "Like" added to the asset by this user.

Specified by:

removeLikeFromAsset in interface AssetConsumerFeedbackInterface

Parameters:

userId - userId of user making request.

likeGUID - unique identifier for the like object.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the asset properties in the property server.

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

addCommentToAsset

public String addCommentToAsset(String userId,
                                String assetGUID,
                                CommentType commentType,
                                String commentText)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Adds a comment to the asset.

Specified by:

addCommentToAsset in interface AssetConsumerFeedbackInterface

Parameters:

userId - userId of user making request.

assetGUID - unique identifier for the asset.

commentType - type of comment enum.

commentText - the text of the comment.

Returns:

guid of new comment.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the asset properties to the property server.

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

addCommentReply

public String addCommentReply(String userId,
                              String commentGUID,
                              CommentType commentType,
                              String commentText)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Adds a comment to another comment.

Specified by:

addCommentReply in interface AssetConsumerFeedbackInterface

Parameters:

userId - userId of user making request.

commentGUID - unique identifier for an existing comment. Used to add a reply to a comment.

commentType - type of comment enum.

commentText - the text of the comment.

Returns:

guid of new comment.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the asset properties to the property server.

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

updateComment

public void updateComment(String userId,
                          String commentGUID,
                          CommentType commentType,
                          String commentText)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException

Update an existing comment.

Specified by:

updateComment in interface AssetConsumerFeedbackInterface

Parameters:

userId - userId of user making request.

commentGUID - unique identifier for the comment to change.

commentType - type of comment enum.

commentText - the text of the comment.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the asset properties to the property server.

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

removeCommentFromAsset

public void removeCommentFromAsset(String userId,
                                   String commentGUID)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Removes a comment added to the asset by this user.

Specified by:

removeCommentFromAsset in interface AssetConsumerFeedbackInterface

Parameters:

userId - userId of user making request.

commentGUID - unique identifier for the comment object.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem updating the asset properties in the property server.

UserNotAuthorizedException - the user does not have permission to perform this request.