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

Interface GovernanceZonesInterface

public interface GovernanceZonesInterface

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

Method Summary

Modifier and Type	Method	Description
String	createGovernanceZone(String userId, GovernanceZoneProperties properties)	Create a definition of a governance zone.
void	deleteGovernanceZone(String userId, String zoneGUID)	Remove the definition of a zone.
GovernanceZoneElement	getGovernanceZoneByGUID(String userId, String zoneGUID)	Return information about a specific governance zone.
GovernanceZoneElement	getGovernanceZoneByName(String userId, String qualifiedName)	Return information about a specific governance zone and its linked governance definitions.
GovernanceZoneDefinition	getGovernanceZoneDefinitionByGUID(String userId, String zoneGUID)	Return information about a specific governance zone and its linked governance definitions.
List<GovernanceZoneElement>	getGovernanceZonesForDomain(String userId, int domainIdentifier, int startFrom, int pageSize)	Return information about the defined governance zones.
void	linkZonesInHierarchy(String userId, String parentZoneGUID, String childZoneGUID)	Link two related governance zones together as part of a hierarchy.
void	unlinkZonesInHierarchy(String userId, String parentZoneGUID, String childZoneGUID)	Remove the link between two zones in the zone hierarchy.
void	updateGovernanceZone(String userId, String zoneGUID, boolean isMergeUpdate, GovernanceZoneProperties properties)	Update the definition of a zone.

Method Details

createGovernanceZone

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

Create a definition of a governance zone. The qualified name of these governance zones can be added to the supportedZones, publishedZones 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

properties - properties for a governance zone

Returns:

unique identifier of the governance zone

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique

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

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

updateGovernanceZone

void updateGovernanceZone(String userId,
 String zoneGUID,
 boolean isMergeUpdate,
 GovernanceZoneProperties properties)
                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update the definition of a zone.

Parameters:

userId - calling user

zoneGUID - unique identifier of zone

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

properties - properties to change

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known

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

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

deleteGovernanceZone

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

Remove the definition of a zone.

Parameters:

userId - calling user

zoneGUID - unique identifier of zone

Throws:

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

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

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

linkZonesInHierarchy

void linkZonesInHierarchy(String userId,
 String parentZoneGUID,
 String childZoneGUID)
                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Link two related governance zones together as part of a hierarchy. A zone can only have one parent but many child zones.

Parameters:

userId - calling user

parentZoneGUID - unique identifier of the parent zone

childZoneGUID - unique identifier of the child zone

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known

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

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

unlinkZonesInHierarchy

void unlinkZonesInHierarchy(String userId,
 String parentZoneGUID,
 String childZoneGUID)
                     throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Remove the link between two zones in the zone hierarchy.

Parameters:

userId - calling user

parentZoneGUID - unique identifier of the parent zone

childZoneGUID - unique identifier of the child zone

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known

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

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

getGovernanceZoneByGUID

GovernanceZoneElement getGovernanceZoneByGUID(String userId,
 String zoneGUID)
                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return information about a specific governance zone.

Parameters:

userId - calling user

zoneGUID - unique identifier for the zone

Returns:

properties of the governance zone

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - zoneGUID 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

getGovernanceZoneByName

GovernanceZoneElement getGovernanceZoneByName(String userId,
 String qualifiedName)
                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return information about a specific governance zone and its linked governance definitions.

Parameters:

userId - calling user

qualifiedName - unique name for the zone

Returns:

properties of the governance zone

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName 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

getGovernanceZonesForDomain

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

Return information about the defined governance zones.

Parameters:

userId - calling user

domainIdentifier - identifier for the desired governance domain

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

properties of the governance zone

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName 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

getGovernanceZoneDefinitionByGUID

GovernanceZoneDefinition getGovernanceZoneDefinitionByGUID(String userId,
 String zoneGUID)
                                                    throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return information about a specific governance zone and its linked governance definitions.

Parameters:

userId - calling user

zoneGUID - unique identifier for the zone

Returns:

properties of the governance zone linked to the associated governance definitions

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - zoneGUID 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