Package org.odpi.openmetadata.samples.governanceactions.clinicaltrials

Class CocoClinicalTrialBaseService

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionServiceConnector

org.odpi.openmetadata.frameworks.governanceaction.GeneralGovernanceActionService

org.odpi.openmetadata.samples.governanceactions.clinicaltrials.CocoClinicalTrialBaseService

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, GovernanceActionService

Direct Known Subclasses:

CocoClinicalTrialCertifyHospitalService, CocoClinicalTrialHospitalOnboardingService, CocoClinicalTrialNominateHospitalService, CocoClinicalTrialSetUpService

public class CocoClinicalTrialBaseService
extends GeneralGovernanceActionService

Provides shared functions for the clinical trial services.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CocoClinicalTrialBaseService.PersonContactDetails

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

ConnectorBase.ProtectedConnection

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.GeneralGovernanceActionService

governanceContext

Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionServiceConnector

auditLog, governanceServiceName, propertyHelper

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
CocoClinicalTrialBaseService()

Method Summary

Modifier and Type	Method	Description
protected void	checkCertificationValidForProject(String projectGUID, String certificationTypeGUID)	Check that the certification type is associated with the requested project.
protected String	createGovernanceActionProcess(String processQualifiedName, String processName, String processDescription)	Create the governance action process asset.
protected CocoClinicalTrialBaseService.PersonContactDetails	getContactDetailsForPersonGUID(String personGUID)	Retrieve the email for a specific person.

Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.GeneralGovernanceActionService

disconnect, getProperty, setGovernanceContext, start

Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionServiceConnector

getArrayRequestParameter, getBooleanRequestParameter, getConnectorComponentDescription, getIntRequestParameter, getLongRequestParameter, getStringRequestParameter, handleUnexpectedException, setAuditLog, setGovernanceServiceName, validateContext

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

combineConfigurationProperties, disconnectConnectors, equals, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector

clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, setStatisticProperty, setStatisticTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CocoClinicalTrialBaseService

public CocoClinicalTrialBaseService()

Method Details

getContactDetailsForPersonGUID

protected CocoClinicalTrialBaseService.PersonContactDetails getContactDetailsForPersonGUID(String personGUID)
                                                                                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve the email for a specific person.

Parameters:

personGUID - unique identifier of the person entity for the individual

Returns:

email address for the individual; or null if it is not found

Throws:

InvalidParameterException - invalid parameter

PropertyServerException - problem access the metadata repository/server

UserNotAuthorizedException - security problem

checkCertificationValidForProject

protected void checkCertificationValidForProject(String projectGUID,
 String certificationTypeGUID)
                                          throws ConnectorCheckedException,
InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Check that the certification type is associated with the requested project. Otherwise, the certification does not make sense.

Parameters:

projectGUID - unique identifier of the project

certificationTypeGUID - unique identifier of the certification type

Throws:

ConnectorCheckedException - the certification type is not linked to the project

InvalidParameterException - invalid parameter passed somehow

PropertyServerException - problem connecting to the open metadata repository

UserNotAuthorizedException - security problem

createGovernanceActionProcess

protected String createGovernanceActionProcess(String processQualifiedName,
 String processName,
 String processDescription)
                                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create the governance action process asset.

Parameters:

processQualifiedName - new qualified name for the process

processName - new name for the process

processDescription - new description for the process

Returns:

unique identifier of new governance action process

Throws:

InvalidParameterException - parameter error

PropertyServerException - repository error

UserNotAuthorizedException - authorization error