org.odpi.openmetadata.accessservices.governanceprogram.api

Interface GovernanceLeadershipInterface

public interface GovernanceLeadershipInterface

The GovernanceLeadershipInterface is used to manage the appointment of the governance officers. There are methods for maintaining the governance officer's appointments and linking them to an individual's personal profile.

Method Summary

Modifier and Type	Method and Description
void	appointGovernanceOfficer(String userId, String governanceOfficerGUID, String profileGUID, Date startDate) Link a person to a governance officer.
String	createGovernanceOfficer(String userId, GovernanceDomain governanceDomain, String appointmentId, String appointmentContext, String title, Map<String,String> additionalProperties, List<ExternalReference> externalReferences) Create the governance officer appointment.
void	deleteGovernanceOfficer(String userId, String governanceOfficerGUID, String appointmentId, GovernanceDomain governanceDomain) Remove the requested governance officer.
List<GovernanceOfficerProperties>	getActiveGovernanceOfficers(String userId) Return all of the currently appointed governance officers.
GovernanceOfficerProperties	getGovernanceOfficerByAppointmentId(String userId, String appointmentId) Retrieve a governance officer by unique appointment id.
GovernanceOfficerProperties	getGovernanceOfficerByGUID(String userId, String governanceOfficerGUID) Retrieve a governance officer description by unique guid.
List<GovernanceOfficerProperties>	getGovernanceOfficers(String userId) Return all of the defined governance officers.
List<GovernanceOfficerProperties>	getGovernanceOfficersByDomain(String userId, GovernanceDomain governanceDomain) Return all of the defined governance officers for a specific governance domain.
void	relieveGovernanceOfficer(String userId, String governanceOfficerGUID, String profileGUID, Date endDate) Unlink a person from a governance officer appointment.
void	updateGovernanceOfficer(String userId, String governanceOfficerGUID, GovernanceDomain governanceDomain, String appointmentId, String appointmentContext, String title, Map<String,String> additionalProperties, List<ExternalReference> externalReferences) Update selected fields for the governance officer.

Method Detail

createGovernanceOfficer

String createGovernanceOfficer(String userId,
                               GovernanceDomain governanceDomain,
                               String appointmentId,
                               String appointmentContext,
                               String title,
                               Map<String,String> additionalProperties,
                               List<ExternalReference> externalReferences)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Create the governance officer appointment.

Parameters:

userId - the name of the calling user.

governanceDomain - the governance domain for the governance officer.

appointmentId - the unique identifier of the governance officer.

appointmentContext - the context in which the governance officer is appointed. This may be an organizational scope, location, or scope of assets.

title - job title for the governance officer.

additionalProperties - additional properties for the governance officer.

externalReferences - links to addition information. This could be, for example, the home page for the governance officer, or details of the role.

Returns:

Unique identifier (guid) of the governance officer.

Throws:

InvalidParameterException - the governance domain, title or appointment id is null.

PropertyServerException - the server is not available.

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

updateGovernanceOfficer

void updateGovernanceOfficer(String userId,
                             String governanceOfficerGUID,
                             GovernanceDomain governanceDomain,
                             String appointmentId,
                             String appointmentContext,
                             String title,
                             Map<String,String> additionalProperties,
                             List<ExternalReference> externalReferences)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Update selected fields for the governance officer.

Parameters:

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

governanceDomain - the governance domain for the governance officer.

appointmentId - the unique identifier of the governance officer.

appointmentContext - the context in which the governance officer is appointed. This may be an organizational scope, location, or scope of assets.

title - job title for the governance officer.

additionalProperties - additional properties for the governance officer.

externalReferences - links to addition information. This could be, for example, the home page for the governance officer, or details of the role.

Throws:

InvalidParameterException - the title is null or the governanceDomain/appointmentId does not match the the existing values associated with the governanceOfficerGUID.

PropertyServerException - the server is not available.

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

deleteGovernanceOfficer

void deleteGovernanceOfficer(String userId,
                             String governanceOfficerGUID,
                             String appointmentId,
                             GovernanceDomain governanceDomain)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Remove the requested governance officer.

Parameters:

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

appointmentId - the unique identifier of the governance officer.

governanceDomain - the governance domain for the governance officer.

Throws:

InvalidParameterException - the appointmentId or governance domain is either null or invalid.

PropertyServerException - the server is not available.

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

getGovernanceOfficerByGUID

GovernanceOfficerProperties getGovernanceOfficerByGUID(String userId,
                                                       String governanceOfficerGUID)
                                                throws InvalidParameterException,
                                                       PropertyServerException,
                                                       UserNotAuthorizedException

Retrieve a governance officer description by unique guid.

Parameters:

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

Returns:

governance officer object

Throws:

InvalidParameterException - the unique identifier of the governance officer is either null or invalid.

PropertyServerException - the server is not available.

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

getGovernanceOfficerByAppointmentId

GovernanceOfficerProperties getGovernanceOfficerByAppointmentId(String userId,
                                                                String appointmentId)
                                                         throws InvalidParameterException,
                                                                AppointmentIdNotUniqueException,
                                                                PropertyServerException,
                                                                UserNotAuthorizedException

Retrieve a governance officer by unique appointment id.

Parameters:

userId - the name of the calling user.

appointmentId - the unique appointment identifier of the governance officer.

Returns:

governance officer object

Throws:

InvalidParameterException - the appointmentId or governance domain is either null or invalid.

AppointmentIdNotUniqueException - more than one governance officer entity was retrieved for this appointmentId

PropertyServerException - the server is not available.

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

getGovernanceOfficers

List<GovernanceOfficerProperties> getGovernanceOfficers(String userId)
                                                 throws InvalidParameterException,
                                                        PropertyServerException,
                                                        UserNotAuthorizedException

Return all of the defined governance officers.

Parameters:

userId - the name of the calling user.

Returns:

list of governance officer objects

Throws:

InvalidParameterException - the userId is either null or invalid.

PropertyServerException - the server is not available.

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

getActiveGovernanceOfficers

List<GovernanceOfficerProperties> getActiveGovernanceOfficers(String userId)
                                                       throws InvalidParameterException,
                                                              PropertyServerException,
                                                              UserNotAuthorizedException

Return all of the currently appointed governance officers.

Parameters:

userId - the name of the calling user.

Returns:

list of governance officer objects

Throws:

InvalidParameterException - the userId is either null or invalid.

PropertyServerException - the server is not available.

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

getGovernanceOfficersByDomain

List<GovernanceOfficerProperties> getGovernanceOfficersByDomain(String userId,
                                                                GovernanceDomain governanceDomain)
                                                         throws InvalidParameterException,
                                                                PropertyServerException,
                                                                UserNotAuthorizedException

Return all of the defined governance officers for a specific governance domain. In a small organization there is typically only one governance officer. However a large organization may have multiple governance officers, each with a different scope. The governance officer with a null scope is the overall leader.

Parameters:

userId - the name of the calling user.

governanceDomain - domain of interest

Returns:

list of governance officer objects

Throws:

InvalidParameterException - the governance domain is either null or invalid.

PropertyServerException - the server is not available.

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

appointGovernanceOfficer

void appointGovernanceOfficer(String userId,
                              String governanceOfficerGUID,
                              String profileGUID,
                              Date startDate)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Link a person to a governance officer. Only one person may be appointed at any one time.

Parameters:

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

profileGUID - unique identifier for the profile.

startDate - the official start date of the appointment - null means effective immediately.

Throws:

InvalidParameterException - the unique identifier of the governance officer or profile is either null or invalid.

PropertyServerException - the server is not available.

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

relieveGovernanceOfficer

void relieveGovernanceOfficer(String userId,
                              String governanceOfficerGUID,
                              String profileGUID,
                              Date endDate)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Unlink a person from a governance officer appointment.

Parameters:

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

profileGUID - unique identifier for the profile.

endDate - the official end of the appointment - null means effective immediately.

Throws:

InvalidParameterException - the profile is not linked to this governance officer.

PropertyServerException - the server is not available.

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