Package org.odpi.openmetadata.accessservices.governanceprogram.api

Interface GovernanceRolesInterface

public interface GovernanceRolesInterface

GovernanceRolesInterface covers the definition of governance roles and their appointments.

Method Summary

Modifier and Type	Method	Description
String	appointGovernanceRole(String userId, String roleGUID, String profileGUID, Date startDate)	Link a person to a governance role.
String	createGovernanceRole(String userId, GovernanceRoleProperties properties)	Create a definition of a new governance role.
void	deleteGovernanceRole(String userId, String governanceRoleGUID)	Delete the properties of the governance role.
List<GovernanceRoleAppointee>	getCurrentGovernanceRoleAppointments(String userId, int domainIdentifier, int startFrom, int pageSize)	Return all of the governance roles and their incumbents (if any).
GovernanceRoleElement	getGovernanceRoleByGUID(String userId, String governanceRoleGUID)	Retrieve the properties of a governance role using its unique identifier.
List<GovernanceRoleElement>	getGovernanceRoleByRoleId(String userId, String roleId)	Retrieve the properties of a governance role using its unique name.
GovernanceRoleHistory	getGovernanceRoleHistoryByGUID(String userId, String governanceRoleGUID)	Retrieve the appointment history for a governance role by unique guid.
List<GovernanceRoleElement>	getGovernanceRolesByDomainId(String userId, int domainIdentifier, int startFrom, int pageSize)	Retrieve all of the governance roles for a particular governance domain.
List<GovernanceRoleElement>	getGovernanceRolesByTitle(String userId, String title, int startFrom, int pageSize)	Retrieve all of the governance roles for a particular title.
void	linkRoleToResource(String userId, String governanceRoleGUID, String resourceGUID)	Link a governance role to the description of a resource that the role is responsible for.
void	linkRoleToResponsibility(String userId, String governanceRoleGUID, String responsibilityGUID)	Link a governance role to a governance control that defines a governance responsibility that a person fulfils.
void	relieveGovernanceRole(String userId, String roleGUID, String profileGUID, String appointmentGUID, Date endDate)	Unlink a person from a governance role appointment.
void	unlinkRoleFromResource(String userId, String governanceRoleGUID, String resourceGUID)	Remove the link between a governance role and a resource.
void	unlinkRoleFromResponsibility(String userId, String governanceRoleGUID, String responsibilityGUID)	Remove the link between a governance role and a governance responsibility.
void	updateGovernanceRole(String userId, String roleGUID, boolean isMergeUpdate, GovernanceRoleProperties properties)

Method Detail

createGovernanceRole

String createGovernanceRole(String userId,
                            GovernanceRoleProperties properties)
                     throws UserNotAuthorizedException,
                            InvalidParameterException,
                            PropertyServerException

Create a definition of a new governance role.

Parameters:

userId - calling user

properties - role properties

Returns:

unique identifier of new role

Throws:

InvalidParameterException - one of the parameters is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateGovernanceRole

void updateGovernanceRole(String userId,
                          String roleGUID,
                          boolean isMergeUpdate,
                          GovernanceRoleProperties properties)
                   throws UserNotAuthorizedException,
                          InvalidParameterException,
                          PropertyServerException

Parameters:

userId - calling user

roleGUID - identifier of the governance role to update

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

properties - properties to change

Throws:

InvalidParameterException - one of the parameters is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

linkRoleToResponsibility

void linkRoleToResponsibility(String userId,
                              String governanceRoleGUID,
                              String responsibilityGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Link a governance role to a governance control that defines a governance responsibility that a person fulfils.

Parameters:

userId - calling user

governanceRoleGUID - unique identifier of the governance role

responsibilityGUID - unique identifier of the governance responsibility control

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkRoleFromResponsibility

void unlinkRoleFromResponsibility(String userId,
                                  String governanceRoleGUID,
                                  String responsibilityGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Remove the link between a governance role and a governance responsibility.

Parameters:

userId - calling user

governanceRoleGUID - unique identifier of the governance role

responsibilityGUID - unique identifier of the governance responsibility control

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

linkRoleToResource

void linkRoleToResource(String userId,
                        String governanceRoleGUID,
                        String resourceGUID)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Link a governance role to the description of a resource that the role is responsible for.

Parameters:

userId - calling user

governanceRoleGUID - unique identifier of the governance role

resourceGUID - unique identifier of the resource description

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkRoleFromResource

void unlinkRoleFromResource(String userId,
                            String governanceRoleGUID,
                            String resourceGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Remove the link between a governance role and a resource.

Parameters:

userId - calling user

governanceRoleGUID - unique identifier of the governance role

resourceGUID - unique identifier of the resource description

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteGovernanceRole

void deleteGovernanceRole(String userId,
                          String governanceRoleGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Delete the properties of the governance role.

Parameters:

userId - calling user

governanceRoleGUID - identifier of the governance role to delete

Throws:

InvalidParameterException - guid or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceRoleByGUID

GovernanceRoleElement getGovernanceRoleByGUID(String userId,
                                              String governanceRoleGUID)
                                       throws UserNotAuthorizedException,
                                              InvalidParameterException,
                                              PropertyServerException

Retrieve the properties of a governance role using its unique identifier.

Parameters:

userId - calling user

governanceRoleGUID - unique identifier

Returns:

properties of the role and any current appointees

Throws:

InvalidParameterException - guid or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceRoleHistoryByGUID

GovernanceRoleHistory getGovernanceRoleHistoryByGUID(String userId,
                                                     String governanceRoleGUID)
                                              throws InvalidParameterException,
                                                     PropertyServerException,
                                                     UserNotAuthorizedException

Retrieve the appointment history for a governance role by unique guid.

Parameters:

userId - the name of the calling user.

governanceRoleGUID - unique identifier (guid) of the governance role.

Returns:

governance role object

Throws:

InvalidParameterException - guid or userId is null

PropertyServerException - the server is not available.

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

getGovernanceRoleByRoleId

List<GovernanceRoleElement> getGovernanceRoleByRoleId(String userId,
                                                      String roleId)
                                               throws UserNotAuthorizedException,
                                                      InvalidParameterException,
                                                      PropertyServerException

Retrieve the properties of a governance role using its unique name. The results are returned as a list since it is possible that two roles have the same identifier due to the distributed nature of the open metadata ecosystem. By returning all of the search results here it is possible to manage the duplicates through this interface.

Parameters:

userId - calling user

roleId - unique name

Returns:

list of roles retrieved

Throws:

InvalidParameterException - name or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceRolesByDomainId

List<GovernanceRoleElement> getGovernanceRolesByDomainId(String userId,
                                                         int domainIdentifier,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         PropertyServerException

Retrieve all of the governance roles for a particular governance domain.

Parameters:

userId - 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

Returns:

list of matching roles

Throws:

InvalidParameterException - domain identifier is undefined or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceRolesByTitle

List<GovernanceRoleElement> getGovernanceRolesByTitle(String userId,
                                                      String title,
                                                      int startFrom,
                                                      int pageSize)
                                               throws UserNotAuthorizedException,
                                                      InvalidParameterException,
                                                      PropertyServerException

Retrieve all of the governance roles for a particular title. The title can include regEx wildcards.

Parameters:

userId - calling user

title - identifier of role

startFrom - where to start from in the list of definitions

pageSize - max number of results to return in one call

Returns:

list of matching roles (null if no matching elements)

Throws:

InvalidParameterException - title or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCurrentGovernanceRoleAppointments

List<GovernanceRoleAppointee> getCurrentGovernanceRoleAppointments(String userId,
                                                                   int domainIdentifier,
                                                                   int startFrom,
                                                                   int pageSize)
                                                            throws InvalidParameterException,
                                                                   PropertyServerException,
                                                                   UserNotAuthorizedException

Return all of 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

Returns:

list of governance role 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.

appointGovernanceRole

String appointGovernanceRole(String userId,
                             String roleGUID,
                             String profileGUID,
                             Date startDate)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

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

Parameters:

userId - the name of the calling user

roleGUID - unique identifier (guid) of the governance role

profileGUID - unique identifier for the profile

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

Returns:

unique identifier (guid) of the appointment relationship

Throws:

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

PropertyServerException - the server is not available.

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

relieveGovernanceRole

void relieveGovernanceRole(String userId,
                           String roleGUID,
                           String profileGUID,
                           String appointmentGUID,
                           Date endDate)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Unlink a person from a governance role appointment.

Parameters:

userId - the name of the calling user

roleGUID - unique identifier (guid) of the governance role

profileGUID - unique identifier for the profile

appointmentGUID - unique identifier (guid) of the appointment relationship

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

Throws:

InvalidParameterException - the profile is not linked to this governance role

PropertyServerException - the server is not available.

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