Package org.odpi.openmetadata.frameworks.openmetadata.handlers

Class LikeHandler

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.handlers.OpenMetadataHandlerBase

org.odpi.openmetadata.frameworks.openmetadata.handlers.FeedbackHandler

org.odpi.openmetadata.frameworks.openmetadata.handlers.LikeHandler

public class LikeHandler
extends FeedbackHandler

LikeHandler is the handler for managing likes.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.handlers.OpenMetadataHandlerBase

auditLog, classificationBuilder, elementBuilder, localServerName, localServiceName, metadataElementTypeName, openMetadataClient, propertyHelper, relationshipBuilder

Constructor Summary

Constructors

Constructor	Description
LikeHandler(String localServerName, AuditLog auditLog, String serviceName, OpenMetadataClient openMetadataClient)	Create a new handler.

Method Summary

Modifier and Type	Method	Description
String	addLikeToElement(String userId, String elementGUID, UpdateOptions updateOptions, LikeProperties properties)	Adds a "Like" to the element.
List<OpenMetadataRootElement>	getAttachedLikes(String userId, String elementGUID, QueryOptions queryOptions)	Return the likes attached to an element.
String	removeLikeFromElement(String userId, String elementGUID, MetadataSourceOptions metadataSourceOptions)	Removes a "Like" added to the element by this user.

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.handlers.FeedbackHandler

addFeedbackToElement, getFeedbackForUser

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.handlers.OpenMetadataHandlerBase

addDefaultType, addDefaultType, addDefaultType, addGovernanceDefinitionFamily, addMermaidToRootElement, convertRootElement, convertRootElement, convertRootElements, createElementFromTemplate, createNewElement, findRootElements, getElementHierarchies, getElementHierarchies, getElementHierarchy, getElementRelatedElements, getFullParentContext, getQueryOptions, getQueryOptions, getQueryOptions, getRelatedRootElements, getRootElementByGUID, getRootElementByUniqueName, getRootElementsByName, populateRootElement, updateElement, updateElementStatus

Methods inherited from class java.lang.Object

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

Constructor Details

LikeHandler

public LikeHandler(String localServerName,
 AuditLog auditLog,
 String serviceName,
 OpenMetadataClient openMetadataClient)

Create a new handler.

Parameters:

localServerName - name of this server (view server)

auditLog - logging destination

serviceName - local service name

openMetadataClient - access to open metadata

Method Details

addLikeToElement

public String addLikeToElement(String userId,
 String elementGUID,
 UpdateOptions updateOptions,
 LikeProperties properties)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Adds a "Like" to the element.

Parameters:

userId - userId of user making request

elementGUID - unique identifier for the element

updateOptions - provides a structure for the additional options when updating an element.

properties - properties

Returns:

unique identifier of the new like element

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

removeLikeFromElement

public String removeLikeFromElement(String userId,
 String elementGUID,
 MetadataSourceOptions metadataSourceOptions)
                             throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

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

Parameters:

userId - userId of user making request.

elementGUID - unique identifier for the like object.

metadataSourceOptions - options to control access to open metadata

Returns:

guid of like

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

getAttachedLikes

public List<OpenMetadataRootElement> getAttachedLikes(String userId,
 String elementGUID,
 QueryOptions queryOptions)
                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the likes attached to an element.

Parameters:

userId - userId of user making request.

elementGUID - unique identifier for the element that the comments are connected to (maybe a comment too).

queryOptions - multiple options to control the query

Returns:

list of likes

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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