org.odpi.openmetadata.commonservices.generichandlers

Class ContributionRecordHandler<B>

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.ContributionRecordHandler<B>

public class ContributionRecordHandler<B>
extends OpenMetadataAPIGenericHandler<B>

ContributionRecordHandler manages the ContributionRecord entity that records the karma points for an individual. There is on 1-1 relationship between the Person entity and the ContributionRecord and so the profile GUID is passed on the parameters. ContributionRecords are always maintainable by the local cohort.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors

Constructor and Description

ContributionRecordHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, int karmaPointPlateau, AuditLog auditLog) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
B	getContributionRecord(String userId, String profileGUID, String profileGUIDParameterName, String methodName) Return the ContributionRecord attached to a supplied person profile.
int	getKarmaPointPlateau(int karmaPointTotal) Return the karma point plateau for an individual.
B	incrementKarmaPoints(String userId, String profileGUID, String profileGUIDParameterName, String qualifiedName, int karmaPointIncrement, String methodName) Increment a person's karma points.
void	removeContributionRecord(String userId, String profileGUID, String profileGUIDParameterName, String methodName) Remove the requested contribution record.
void	saveContributionRecord(String userId, String profileGUID, String profileGUIDParameterName, String qualifiedName, long karmaPoints, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, String methodName) Set up the contribution values in a Person profile.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByIntValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkAllElements, unlinkConnectedElement, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

ContributionRecordHandler

public ContributionRecordHandler(OpenMetadataAPIGenericConverter<B> converter,
                                 Class<B> beanClass,
                                 String serviceName,
                                 String serverName,
                                 InvalidParameterHandler invalidParameterHandler,
                                 RepositoryHandler repositoryHandler,
                                 OMRSRepositoryHelper repositoryHelper,
                                 String localServerUserId,
                                 OpenMetadataServerSecurityVerifier securityVerifier,
                                 List<String> supportedZones,
                                 List<String> defaultZones,
                                 List<String> publishZones,
                                 int karmaPointPlateau,
                                 AuditLog auditLog)

Construct the handler information needed to interact with the repository services

Parameters:

converter - specific converter for this bean class

beanClass - name of bean class that is represented by the generic class B

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

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

supportedZones - list of zones that the access service is allowed to serve Asset instances from

defaultZones - list of zones that the access service should set in all new Asset instances

publishZones - list of zones that the access service sets up in published Asset instances

karmaPointPlateau - number of karma points to a plateau

auditLog - destination for audit log events

Method Detail

getContributionRecord

public B getContributionRecord(String userId,
                               String profileGUID,
                               String profileGUIDParameterName,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Return the ContributionRecord attached to a supplied person profile.

Parameters:

userId - calling user

profileGUID - identifier for the entity that the contribution record is attached to

profileGUIDParameterName - name of parameter supplying the GUID

methodName - calling method

Returns:

list of 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

incrementKarmaPoints

public B incrementKarmaPoints(String userId,
                              String profileGUID,
                              String profileGUIDParameterName,
                              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

profileGUID - unique identifier of personal profile

profileGUIDParameterName - parameter supply profileGUID

qualifiedName - unique name for this 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

saveContributionRecord

public void saveContributionRecord(String userId,
                                   String profileGUID,
                                   String profileGUIDParameterName,
                                   String qualifiedName,
                                   long karmaPoints,
                                   Map<String,String> additionalProperties,
                                   String suppliedTypeName,
                                   Map<String,Object> extendedProperties,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Set up the contribution values in a Person profile.

Parameters:

userId - userId of user making request.

profileGUID - unique identifier for the connected Person entity.

profileGUIDParameterName - parameter supplying the profileGUID

qualifiedName - unique name for this contribution record

karmaPoints - contribution points for the individual

additionalProperties - additional properties for the contribution record

extendedProperties - additional properties from defined subtypes

suppliedTypeName - name of subtype or null

methodName - calling method

Throws:

InvalidParameterException - the endpoint bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

removeContributionRecord

public void removeContributionRecord(String userId,
                                     String profileGUID,
                                     String profileGUIDParameterName,
                                     String methodName)
                              throws InvalidParameterException,
                                     PropertyServerException,
                                     UserNotAuthorizedException

Remove the requested contribution record.

Parameters:

userId - calling user

profileGUID - unique identifier for the connected Person entity.

profileGUIDParameterName - parameter supplying the profileGUID

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getKarmaPointPlateau

public int getKarmaPointPlateau(int karmaPointTotal)

Return the karma point plateau for an individual.

Parameters:

karmaPointTotal - current points

Returns:

current plateau