Package org.odpi.openmetadata.accessservices.governanceprogram.handlers

Class AppointmentHandler

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.handlers.AppointmentHandler

public class AppointmentHandler
extends Object

AppointmentHandler is responsible for managing the relationship between a person role and a profile. It typically returns the combination of the relationship and the profile bean. Specifically it supports the return of GovernanceAppointee in GovernanceRoleAppointee and GovernanceRoleHistory.

Constructor Summary

Constructors

Constructor

Description

AppointmentHandler(org.odpi.openmetadata.commonservices.generichandlers.PersonRoleHandler<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceRoleElement> roleHandler, org.odpi.openmetadata.commonservices.generichandlers.ActorProfileHandler<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ProfileElement> profileHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)

Create an AppointmentHandler.

Method Summary

Modifier and Type	Method	Description
List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceRoleAppointee>	getCurrentGovernanceRoleAppointments(String userId, int domainIdentifier, int startFrom, int pageSize, String methodName)	Return all the governance roles and their incumbents (if any).
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceRoleHistory	getGovernanceRoleHistoryByGUID(String userId, String governanceRoleGUID, String methodName)	Retrieve a governance role description by unique guid along with the history of who has been appointed to the role.

Methods inherited from class java.lang.Object

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

Constructor Details

AppointmentHandler

public AppointmentHandler(org.odpi.openmetadata.commonservices.generichandlers.PersonRoleHandler<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceRoleElement> roleHandler,
 org.odpi.openmetadata.commonservices.generichandlers.ActorProfileHandler<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ProfileElement> profileHandler,
 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper,
 String serviceName,
 String serverName,
 org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)

Create an AppointmentHandler.

Parameters:

roleHandler - handler for person roles

profileHandler - handler for actor profiles

repositoryHelper - helper

serviceName - this service

serverName - controlling server name

auditLog - logging destination

Method Details

getCurrentGovernanceRoleAppointments

public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceRoleAppointee> getCurrentGovernanceRoleAppointments(String userId,
 int domainIdentifier,
 int startFrom,
 int pageSize,
 String methodName)
                                                                                                                                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Return all the governance roles and their incumbents (if any).

Parameters:

userId - the name of the calling user

domainIdentifier - identifier of domain - 0 means all

startFrom - where to start from in the list of definitions

pageSize - max number of results to return in one call

methodName - calling method

Returns:

list of governance role objects

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is either null or invalid.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.

getGovernanceRoleHistoryByGUID

public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceRoleHistory getGovernanceRoleHistoryByGUID(String userId,
 String governanceRoleGUID,
 String methodName)
                                                                                                                    throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Retrieve a governance role description by unique guid along with the history of who has been appointed to the role.

Parameters:

userId - the name of the calling user.

governanceRoleGUID - unique identifier (guid) of the governance role

methodName - calling method

Returns:

governance role object

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier of the governance role is either null or invalid.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.