org.odpi.openmetadata.accessservices.governanceprogram.server

Class GovernanceProgramRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.server.GovernanceProgramRESTServices

public class GovernanceProgramRESTServices
extends Object

The GovernanceProgramRESTServices provides the server-side implementation of the GovernanceProgram Open Metadata Assess Service (OMAS). This interface provides connections to assets and APIs for adding feedback on the asset.

Constructor Summary

Constructors

Constructor and Description
GovernanceProgramRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	appointGovernanceOfficer(String userId, String governanceOfficerGUID, AppointmentRequestBody requestBody) Link a person to a governance officer.
GUIDResponse	createGovernanceOfficer(String userId, GovernanceOfficerDetailsRequestBody requestBody) Create the governance officer appointment.
GUIDResponse	createPersonalProfile(String userId, PersonalDetailsRequestBody requestBody) Create a personal profile for an individual who is to be appointed to a governance role but does not have a profile in open metadata.
VoidResponse	deleteGovernanceOfficer(String userId, String governanceOfficerGUID, GovernanceOfficerValidatorRequestBody requestBody) Remove the requested governance officer.
VoidResponse	deletePersonalProfile(String userId, String profileGUID, PersonalProfileValidatorRequestBody requestBody) Delete the personal profile.
GovernanceOfficerListResponse	getActiveGovernanceOfficers(String userId) Return all of the defined governance officers.
GovernanceOfficerResponse	getGovernanceOfficerByAppointmentId(String userId, String appointmentId) Retrieve a governance officer by unique appointment id.
GovernanceOfficerResponse	getGovernanceOfficerByGUID(String userId, String governanceOfficerGUID) Retrieve a governance officer description by unique guid.
GovernanceOfficerListResponse	getGovernanceOfficers(String userId) Return all of the defined governance officers.
GovernanceOfficerListResponse	getGovernanceOfficersByDomain(String userId, GovernanceDomainRequestBody requestBody) Return all of the defined governance officers for a specific governance domain.
PersonalProfileResponse	getPersonalProfileByEmployeeNumber(String userId, String employeeNumber) Retrieve a personal profile by personnel/serial/unique employee number of the individual.
PersonalProfileResponse	getPersonalProfileByGUID(String userId, String profileGUID) Retrieve a personal profile by guid.
PersonalProfileListResponse	getPersonalProfilesByName(String userId, String name) Return a list of candidate personal profiles for an individual.
VoidResponse	relieveGovernanceOfficer(String userId, String governanceOfficerGUID, AppointmentRequestBody requestBody) Unlink a person from a governance officer appointment.
static void	setRepositoryConnector(String accessServiceName, OMRSRepositoryConnector repositoryConnector) Provide a connector to the REST Services.
VoidResponse	updateGovernanceOfficer(String userId, String governanceOfficerGUID, GovernanceOfficerDetailsRequestBody requestBody) Update selected fields for the governance officer.
VoidResponse	updatePersonalProfile(String userId, String profileGUID, PersonalDetailsRequestBody requestBody) Update properties for the personal properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceProgramRESTServices

public GovernanceProgramRESTServices()

Default constructor

Method Detail

setRepositoryConnector

public static void setRepositoryConnector(String accessServiceName,
                                          OMRSRepositoryConnector repositoryConnector)

Provide a connector to the REST Services.

Parameters:

accessServiceName - name of this access service

repositoryConnector - OMRS Repository Connector to the property server.

createPersonalProfile

public GUIDResponse createPersonalProfile(String userId,
                                          PersonalDetailsRequestBody requestBody)

Create a personal profile for an individual who is to be appointed to a governance role but does not have a profile in open metadata.

Parameters:

userId - the name of the calling user.

requestBody - properties about the individual.

Returns:

Unique identifier for the personal profile or InvalidParameterException the employee number or full name is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

updatePersonalProfile

public VoidResponse updatePersonalProfile(String userId,
                                          String profileGUID,
                                          PersonalDetailsRequestBody requestBody)

Update properties for the personal properties. Null values result in empty fields in the profile.

Parameters:

userId - the name of the calling user.

profileGUID - unique identifier for the profile.

requestBody - properties about the individual.

Returns:

void response or UnrecognizedGUIDException the unique identifier of the personal profile is either null or invalid or InvalidParameterException the full name is null or the employeeNumber does not match the profileGUID or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

deletePersonalProfile

public VoidResponse deletePersonalProfile(String userId,
                                          String profileGUID,
                                          PersonalProfileValidatorRequestBody requestBody)

Delete the personal profile.

Parameters:

userId - the name of the calling user.

profileGUID - unique identifier for the profile.

requestBody - personnel/serial/unique employee number of the individual.

Returns:

void response or UnrecognizedGUIDException the unique identifier of the personal profile is either null or invalid or InvalidParameterException the employee number or full name is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getPersonalProfileByGUID

public PersonalProfileResponse getPersonalProfileByGUID(String userId,
                                                        String profileGUID)

Retrieve a personal profile by guid.

Parameters:

userId - the name of the calling user.

profileGUID - unique identifier for the profile.

Returns:

personal profile object or UnrecognizedGUIDException the unique identifier of the personal profile is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getPersonalProfileByEmployeeNumber

public PersonalProfileResponse getPersonalProfileByEmployeeNumber(String userId,
                                                                  String employeeNumber)

Retrieve a personal profile by personnel/serial/unique employee number of the individual.

Parameters:

userId - the name of the calling user.

employeeNumber - personnel/serial/unique employee number of the individual.

Returns:

personal profile object or InvalidParameterException the employee number or full name is null or EmployeeNumberNotUniqueException more than one personal profile was found or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getPersonalProfilesByName

public PersonalProfileListResponse getPersonalProfilesByName(String userId,
                                                             String name)

Return a list of candidate personal profiles for an individual. It matches on full name and known name. The name may include wild card parameters.

Parameters:

userId - the name of the calling user.

name - name of individual.

Returns:

list of personal profile objects or InvalidParameterException the name is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

createGovernanceOfficer

public GUIDResponse createGovernanceOfficer(String userId,
                                            GovernanceOfficerDetailsRequestBody requestBody)

Create the governance officer appointment.

Parameters:

userId - the name of the calling user.

requestBody - properties of the governance officer.

Returns:

Unique identifier (guid) of the governance officer or InvalidParameterException the governance domain or appointment id is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

updateGovernanceOfficer

public VoidResponse updateGovernanceOfficer(String userId,
                                            String governanceOfficerGUID,
                                            GovernanceOfficerDetailsRequestBody requestBody)

Update selected fields for the governance officer.

Parameters:

userId - the name of the calling user.

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

requestBody - properties of the governance officer

Returns:

void response or UnrecognizedGUIDException the unique identifier of the governance officer is either null or invalid or InvalidParameterException the title is null or the governanceDomain/appointmentId does not match the the existing values associated with the governanceOfficerGUID or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

deleteGovernanceOfficer

public VoidResponse deleteGovernanceOfficer(String userId,
                                            String governanceOfficerGUID,
                                            GovernanceOfficerValidatorRequestBody requestBody)

Remove the requested governance officer.

Parameters:

userId - the name of the calling user.

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

requestBody - properties to verify this is the right governance officer

Returns:

void response or UnrecognizedGUIDException the unique identifier of the governance officer is either null or invalid or InvalidParameterException the appointmentId or governance domain is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getGovernanceOfficerByGUID

public GovernanceOfficerResponse getGovernanceOfficerByGUID(String userId,
                                                            String governanceOfficerGUID)

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 or UnrecognizedGUIDException the unique identifier of the governance officer is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getGovernanceOfficerByAppointmentId

public GovernanceOfficerResponse getGovernanceOfficerByAppointmentId(String userId,
                                                                     String appointmentId)

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 or InvalidParameterException the appointmentId or governance domain is either null or invalid or AppointmentIdNotUniqueException more than one governance officer entity was retrieved for this appointmentId PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getGovernanceOfficers

public GovernanceOfficerListResponse getGovernanceOfficers(String userId)

Return all of the defined governance officers.

Parameters:

userId - the name of the calling user.

Returns:

list of governance officer objects or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getActiveGovernanceOfficers

public GovernanceOfficerListResponse getActiveGovernanceOfficers(String userId)

Return all of the defined governance officers.

Parameters:

userId - the name of the calling user.

Returns:

list of governance officer objects or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getGovernanceOfficersByDomain

public GovernanceOfficerListResponse getGovernanceOfficersByDomain(String userId,
                                                                   GovernanceDomainRequestBody requestBody)

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.

requestBody - domain of interest.

Returns:

list of governance officer objects or InvalidParameterException the governance domain is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

appointGovernanceOfficer

public VoidResponse appointGovernanceOfficer(String userId,
                                             String governanceOfficerGUID,
                                             AppointmentRequestBody requestBody)

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.

requestBody - unique identifier for the profile

Returns:

void response or UnrecognizedGUIDException the unique identifier of the governance officer or profile is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

relieveGovernanceOfficer

public VoidResponse relieveGovernanceOfficer(String userId,
                                             String governanceOfficerGUID,
                                             AppointmentRequestBody requestBody)

Unlink a person from a governance officer appointment.

Parameters:

userId - the name of the calling user.

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

requestBody - unique identifier for the profile.

Returns:

void response or UnrecognizedGUIDException the unique identifier of the governance officer or profile is either null or invalid or InvalidParameterException the profile is not linked to this governance officer or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.