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

Class LikeHandler

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

public class LikeHandler
extends FeedbackHandlerBase

LikeHandler provides access and maintenance for Like objects and their attachment to Referenceables.

Constructor Summary

Constructors

Constructor and Description
LikeHandler(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
void	addLikeToReferenceable(String userId, String anchorGUID, String anchorType, boolean isPublic, String methodName) Adds a "Like" to the asset.
List<Like>	getLikes(String userId, String anchorGUID, int startingFrom, int pageSize, String methodName) Return the Likes attached to an anchor entity.
void	removeLikeFromReferenceable(String userId, String anchorGUID, String anchorType, String methodName) Removes a "Like" added to the asset by this user.
String	saveLike(String userId, String anchorGUID, boolean isPublic, String methodName) Add or replace and existing Like for this user.

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

LikeHandler

public LikeHandler(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

getLikes

public List<Like> getLikes(String userId,
                           String anchorGUID,
                           int startingFrom,
                           int pageSize,
                           String methodName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Return the Likes attached to an anchor entity.

Parameters:

userId - calling user

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

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 or null if none found

Throws:

InvalidParameterException - the input properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

saveLike

public String saveLike(String userId,
                       String anchorGUID,
                       boolean isPublic,
                       String methodName)
                throws InvalidParameterException,
                       PropertyServerException,
                       UserNotAuthorizedException

Add or replace and existing Like for this user.

Parameters:

userId - userId of user making request.

anchorGUID - unique identifier for the anchor entity (Referenceable).

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

methodName - calling method

Returns:

unique identifier of the new Like entity

Throws:

InvalidParameterException - the endpoint bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addLikeToReferenceable

public void addLikeToReferenceable(String userId,
                                   String anchorGUID,
                                   String anchorType,
                                   boolean isPublic,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Adds a "Like" to the asset. If the user has already attached a like then the original one is over-ridden.

Parameters:

userId - userId of user making request.

anchorGUID - unique identifier for the asset where the like is to be attached.

anchorType - type of anchor entity.

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.

removeLikeFromReferenceable

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

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

Parameters:

userId - userId of user making request.

anchorGUID - unique identifier for the asset where the like is attached.

anchorType - type of anchor entity.

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 requesting user is not authorized to issue this request.