org.odpi.openmetadata.accessservices.communityprofile.handlers

Class ContributionRecordHandler

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.handlers.ContributionRecordHandler

public class ContributionRecordHandler
extends Object

ContributionRecordHandler manages the record of a person's contribution to the open metadata ecosystem. The contribution record is stored as a ContributionRecord entity linked to the Person entity for the individual via a PersonalContribution relationship

Constructor Summary

Constructors

Constructor and Description
ContributionRecordHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, OMRSRepositoryHelper repositoryHelper, RepositoryHandler repositoryHandler, int karmaPointPlateau) Construct the discovery engine configuration handler caching the objects needed to operate within a single server instance.

Method Summary

Modifier and Type	Method and Description
void	deleteContributionRecord(String userId, String personalProfileGUID, String qualifiedName, String methodName) Delete the contribution record for a person.
ContributionRecord	getContributionRecord(String userId, String personalProfileGUID, String qualifiedName, String methodName) Return the appropriate contribution record for the identified person.
ContributionRecord	incrementKarmaPoints(String userId, String personalProfileGUID, String qualifiedName, int karmaPointIncrement, String methodName) Increment a person's karma points.
void	updateContributionRecord(String userId, String personalProfileGUID, String qualifiedName, Map<String,Object> extendedProperties, Map<String,String> additionalProperties, String methodName) Update the ancillary properties of a contribution record

Methods inherited from class java.lang.Object

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

Constructor Detail

ContributionRecordHandler

public ContributionRecordHandler(String serviceName,
                                 String serverName,
                                 InvalidParameterHandler invalidParameterHandler,
                                 OMRSRepositoryHelper repositoryHelper,
                                 RepositoryHandler repositoryHandler,
                                 int karmaPointPlateau)

Construct the discovery engine configuration handler caching the objects needed to operate within a single server instance.

Parameters:

serviceName - name of the consuming service

serverName - name of this server instance

invalidParameterHandler - handler for invalid parameters

repositoryHelper - helper used by the converters

repositoryHandler - handler for calling the repository services

karmaPointPlateau - the number of karma points to reach a plateau

Method Detail

getContributionRecord

public ContributionRecord getContributionRecord(String userId,
                                                String personalProfileGUID,
                                                String qualifiedName,
                                                String methodName)
                                         throws InvalidParameterException,
                                                PropertyServerException,
                                                UserNotAuthorizedException

Return the appropriate contribution record for the identified person.

Parameters:

userId - calling user

personalProfileGUID - unique identifier of personal profile

qualifiedName - qualified name of their personal profile.

methodName - calling method

Returns:

contribution record or null if does not exist

Throws:

InvalidParameterException - the userId or guid is null

PropertyServerException - the metadata repository is not available

UserNotAuthorizedException - the user is not authorized to issue this request

updateContributionRecord

public void updateContributionRecord(String userId,
                                     String personalProfileGUID,
                                     String qualifiedName,
                                     Map<String,Object> extendedProperties,
                                     Map<String,String> additionalProperties,
                                     String methodName)
                              throws InvalidParameterException,
                                     PropertyServerException,
                                     UserNotAuthorizedException

Update the ancillary properties of a contribution record

Parameters:

userId - calling user

personalProfileGUID - unique identifier of personal profile

qualifiedName - qualified name of their personal profile

extendedProperties - subtype properties

additionalProperties - additional properties

methodName - calling method

Throws:

InvalidParameterException - the userId, qualified name or guid is null

PropertyServerException - the metadata repository is not available

UserNotAuthorizedException - the user is not authorized to issue this request

incrementKarmaPoints

public ContributionRecord incrementKarmaPoints(String userId,
                                               String personalProfileGUID,
                                               String qualifiedName,
                                               int karmaPointIncrement,
                                               String methodName)
                                        throws InvalidParameterException,
                                               PropertyServerException,
                                               UserNotAuthorizedException

Increment a person's karma points. If this is their first award, a contribution record will be created automatically.

Parameters:

userId - calling user

personalProfileGUID - unique identifier of personal profile

qualifiedName - qualified name of their personal profile

karmaPointIncrement - number of points to add to the contribution record.

methodName - calling method

Returns:

updated record or null if not found

Throws:

InvalidParameterException - the userId, qualified name or guid is null

PropertyServerException - the metadata repository is not available

UserNotAuthorizedException - the user is not authorized to issue this request

deleteContributionRecord

public void deleteContributionRecord(String userId,
                                     String personalProfileGUID,
                                     String qualifiedName,
                                     String methodName)
                              throws InvalidParameterException,
                                     PropertyServerException,
                                     UserNotAuthorizedException

Delete the contribution record for a person.

Parameters:

userId - calling user

personalProfileGUID - unique identifier of personal profile

qualifiedName - qualified name of their personal profile.

methodName - calling method

Throws:

InvalidParameterException - the userId of qualified name is null

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.