org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers

Class CommentHandler

java.lang.Object

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.AttachmentHandlerBase

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.FeedbackHandlerBase

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.CommentHandler

public class CommentHandler
extends FeedbackHandlerBase

CommentHandler manages Comment objects. It runs server-side in the OMAG Server Platform and retrieves Comment entities through the OMRSRepositoryConnector.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.AttachmentHandlerBase

invalidParameterHandler, lastAttachmentHandler, repositoryHandler, repositoryHelper, serverName, serviceName

Constructor Summary

Constructors

Constructor and Description
CommentHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, LastAttachmentHandler lastAttachmentHandler) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
String	addCommentReplyToAnchor(String userId, String anchorGUID, String anchorType, String attachmentGUID, CommentType commentType, String commentText, boolean isPublic, String methodName) Adds a comment to another comment.
String	addCommentToAnchor(String userId, String anchorGUID, String anchorType, CommentType commentType, String commentText, boolean isPublic, String methodName) Adds a comment to the asset.
List<Comment>	getComments(String userId, String anchorGUID, String anchorTypeName, int startingFrom, int pageSize, String methodName) Return the comments attached to an anchor entity.
void	removeCommentFromAnchor(String userId, String anchorGUID, String anchorType, String commentGUID, String methodName) Removes a comment added to the asset by this user.
void	updateComment(String userId, String anchorGUID, String anchorType, String commentGUID, CommentType commentType, String commentText, boolean isPublic, String methodName) Update an existing comment.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.FeedbackHandlerBase

countAttachments, getAttachmentLinks, getAttachments, visibleToUser

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentHandler

public CommentHandler(String serviceName,
                      String serverName,
                      InvalidParameterHandler invalidParameterHandler,
                      RepositoryHandler repositoryHandler,
                      OMRSRepositoryHelper repositoryHelper,
                      LastAttachmentHandler lastAttachmentHandler)

Construct the handler information needed to interact with the repository services

Parameters:

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

lastAttachmentHandler - handler for recording last attachment

Method Detail

getComments

public List<Comment> getComments(String userId,
                                 String anchorGUID,
                                 String anchorTypeName,
                                 int startingFrom,
                                 int pageSize,
                                 String methodName)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Return the comments attached to an anchor entity. (No special security checking is required).

Parameters:

userId - calling user

anchorGUID - identifier for the entity that the feedback is attached to

anchorTypeName - name of the type of the anchor entity

startingFrom - where to start from in the list

pageSize - maximum number of results that can be returned

methodName - calling method

Returns:

list of retrieved objects

Throws:

InvalidParameterException - the input properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addCommentToAnchor

public String addCommentToAnchor(String userId,
                                 String anchorGUID,
                                 String anchorType,
                                 CommentType commentType,
                                 String commentText,
                                 boolean isPublic,
                                 String methodName)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Adds a comment to the asset.

Parameters:

userId - userId of user making request.

anchorGUID - unique identifier for the referenceable.

anchorType - type name for the referenceable.

commentType - type of comment enum.

commentText - the text of the comment.

isPublic - indicates whether the feedback should be shared or only be visible to the originating user

methodName - calling method

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.

addCommentReplyToAnchor

public String addCommentReplyToAnchor(String userId,
                                      String anchorGUID,
                                      String anchorType,
                                      String attachmentGUID,
                                      CommentType commentType,
                                      String commentText,
                                      boolean isPublic,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Adds a comment to another comment.

Parameters:

userId - userId of user making request.

anchorGUID - unique identifier for the referenceable.

anchorType - type name for the referenceable.

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

isPublic - indicates whether the feedback should be shared or only be visible to the originating user

methodName - calling method

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 anchorGUID,
                          String anchorType,
                          String commentGUID,
                          CommentType commentType,
                          String commentText,
                          boolean isPublic,
                          String methodName)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException

Update an existing comment.

Parameters:

userId - userId of user making request.

anchorGUID - unique identifier for the anchor entity

anchorType - type name for anchor

commentGUID - unique identifier for the comment to change.

commentType - type of comment enum.

commentText - the text of the comment.

isPublic - indicates whether the feedback should be shared or only be visible to the originating user

methodName - calling method

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.

removeCommentFromAnchor

public void removeCommentFromAnchor(String userId,
                                    String anchorGUID,
                                    String anchorType,
                                    String commentGUID,
                                    String methodName)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Removes a comment added to the asset by this user.

Parameters:

userId - userId of user making request.

anchorGUID - unique identifier of anchor

anchorType - type of anchor

commentGUID - unique identifier for the comment object.

methodName - calling method

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.