org.odpi.openmetadata.accessservices.governanceprogram.api

Interface GovernanceZoneManagerInterface

public interface GovernanceZoneManagerInterface

The GovernanceZoneManagerInterface is used by the governance team to define the zones where the assets can be located.

Method Summary

Modifier and Type	Method and Description
void	createGovernanceZone(String userId, String qualifiedName, String displayName, String description, String criteria, Map<String,String> additionalProperties) Create a definition of a governance zone.
GovernanceZone	getGovernanceZone(String userId, String qualifiedName) Return information about a specific governance zone.
List<GovernanceZone>	getGovernanceZones(String userId, int startingFrom, int maximumResults) Return information about the defined governance zones.

Method Detail

createGovernanceZone

void createGovernanceZone(String userId,
                          String qualifiedName,
                          String displayName,
                          String description,
                          String criteria,
                          Map<String,String> additionalProperties)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Create a definition of a governance zone. The qualified name of these governance zones can be added to the supportedZones and defaultZones properties of an OMAS to control which assets are processed and how they are set up. In addition the qualified names of zones can be added to Asset definitions to indicate which zone(s) they belong to.

Parameters:

userId - calling user

qualifiedName - unique name for the zone - used in other configuration

displayName - short display name for the zone

description - description of the governance zone

criteria - the criteria for inclusion in a governance zone

additionalProperties - additional properties for a governance zone

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceZone

GovernanceZone getGovernanceZone(String userId,
                                 String qualifiedName)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Return information about a specific governance zone.

Parameters:

userId - calling user

qualifiedName - unique name for the zone

Returns:

properties of the governance zone

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceZones

List<GovernanceZone> getGovernanceZones(String userId,
                                        int startingFrom,
                                        int maximumResults)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Return information about the defined governance zones.

Parameters:

userId - calling user

startingFrom - position in the list (used when there are so many reports that paging is needed

maximumResults - maximum number of elements to return an this call

Returns:

properties of the governance zone

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem