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 serverName, String userId, String governanceOfficerGUID, AppointmentRequestBody requestBody) Link a person to a governance officer.
GUIDResponse	createGovernanceOfficer(String serverName, String userId, GovernanceOfficerDetailsRequestBody requestBody) Create the governance officer appointment.
VoidResponse	deleteGovernanceOfficer(String serverName, String userId, String governanceOfficerGUID, GovernanceOfficerValidatorRequestBody requestBody) Remove the requested governance officer.
GovernanceOfficerListResponse	getActiveGovernanceOfficers(String serverName, String userId) Return all of the defined governance officers.
GovernanceOfficerResponse	getGovernanceOfficerByAppointmentId(String serverName, String userId, String appointmentId) Retrieve a governance officer by unique appointment id.
GovernanceOfficerResponse	getGovernanceOfficerByGUID(String serverName, String userId, String governanceOfficerGUID) Retrieve a governance officer description by unique guid.
GovernanceOfficerListResponse	getGovernanceOfficers(String serverName, String userId) Return all of the defined governance officers.
GovernanceOfficerListResponse	getGovernanceOfficersByDomain(String serverName, String userId, GovernanceDomainRequestBody requestBody) Return all of the defined governance officers for a specific governance domain.
VoidResponse	relieveGovernanceOfficer(String serverName, String userId, String governanceOfficerGUID, AppointmentRequestBody requestBody) Unlink a person from a governance officer appointment.
VoidResponse	updateGovernanceOfficer(String serverName, String userId, String governanceOfficerGUID, GovernanceOfficerDetailsRequestBody requestBody) Update selected fields for the governance officer.

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

createGovernanceOfficer

public GUIDResponse createGovernanceOfficer(String serverName,
                                            String userId,
                                            GovernanceOfficerDetailsRequestBody requestBody)

Create the governance officer appointment.

Parameters:

serverName - name of server instance to call

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 serverName,
                                            String userId,
                                            String governanceOfficerGUID,
                                            GovernanceOfficerDetailsRequestBody requestBody)

Update selected fields for the governance officer.

Parameters:

serverName - name of server instance to call

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 serverName,
                                            String userId,
                                            String governanceOfficerGUID,
                                            GovernanceOfficerValidatorRequestBody requestBody)

Remove the requested governance officer.

Parameters:

serverName - name of server instance to call

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 serverName,
                                                            String userId,
                                                            String governanceOfficerGUID)

Retrieve a governance officer description by unique guid.

Parameters:

serverName - name of server instance to call

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 serverName,
                                                                     String userId,
                                                                     String appointmentId)

Retrieve a governance officer by unique appointment id.

Parameters:

serverName - name of server instance to call

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 serverName,
                                                           String userId)

Return all of the defined governance officers.

Parameters:

serverName - name of server instance to call

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 serverName,
                                                                 String userId)

Return all of the defined governance officers.

Parameters:

serverName - name of server instance to call

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 serverName,
                                                                   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:

serverName - name of server instance to call

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 serverName,
                                             String userId,
                                             String governanceOfficerGUID,
                                             AppointmentRequestBody requestBody)

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

Parameters:

serverName - name of server instance to call

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 serverName,
                                             String userId,
                                             String governanceOfficerGUID,
                                             AppointmentRequestBody requestBody)

Unlink a person from a governance officer appointment.

Parameters:

serverName - name of server instance to call

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.