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 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 the governance roles for a particular governance domain.
List<GovernanceRoleElement>	getGovernanceRolesByTitle(String userId, String title, int startFrom, int pageSize)	Retrieve all the governance roles for a particular title.
void	relieveGovernanceRole(String userId, String roleGUID, String profileGUID, String appointmentGUID, Date endDate)	Unlink a person from a governance role appointment.
void	updateGovernanceRole(String userId, String roleGUID, boolean isMergeUpdate, GovernanceRoleProperties properties)

Method Details

createGovernanceRole

String createGovernanceRole(String userId,
 GovernanceRoleProperties properties)
                     throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Create a definition of a new governance role.

Parameters:

userId - calling user

properties - role properties

Returns:

unique identifier of new role

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

updateGovernanceRole

void updateGovernanceRole(String userId,
 String roleGUID,
 boolean isMergeUpdate,
 GovernanceRoleProperties properties)
                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

deleteGovernanceRole

void deleteGovernanceRole(String userId,
 String governanceRoleGUID)
                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Delete the properties of the governance role.

Parameters:

userId - calling user

governanceRoleGUID - identifier of the governance role to delete

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getGovernanceRoleByGUID

GovernanceRoleElement getGovernanceRoleByGUID(String userId,
 String governanceRoleGUID)
                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getGovernanceRoleHistoryByGUID

GovernanceRoleHistory getGovernanceRoleHistoryByGUID(String userId,
 String governanceRoleGUID)
                                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid or userId is null

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.

getGovernanceRoleByRoleId

List<GovernanceRoleElement> getGovernanceRoleByRoleId(String userId,
 String roleId)
                                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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 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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - name or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getGovernanceRolesByDomainId

List<GovernanceRoleElement> getGovernanceRolesByDomainId(String userId,
 int domainIdentifier,
 int startFrom,
 int pageSize)
                                                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve all 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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - domain identifier is undefined or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getGovernanceRolesByTitle

List<GovernanceRoleElement> getGovernanceRolesByTitle(String userId,
 String title,
 int startFrom,
 int pageSize)
                                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve all 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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - title or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getCurrentGovernanceRoleAppointments

List<GovernanceRoleAppointee> getCurrentGovernanceRoleAppointments(String userId,
 int domainIdentifier,
 int startFrom,
 int pageSize)
                                                            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

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.

appointGovernanceRole

String appointGovernanceRole(String userId,
 String roleGUID,
 String profileGUID,
 Date startDate)
                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier of the governance role or profile 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.

relieveGovernanceRole

void relieveGovernanceRole(String userId,
 String roleGUID,
 String profileGUID,
 String appointmentGUID,
 Date endDate)
                    throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the profile is not linked to this governance role

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.