GovernanceZonesInterface (Governance Program OMAS API 2.11 API)

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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`	`linkZoneToGovernanceDefinition(String userId, String zoneGUID, String definitionGUID)` Link a governance zone to a governance definition that controls how the assets in the zone should be governed.
`void`	`unlinkZoneFromGovernanceDefinition(String userId, String zoneGUID, String definitionGUID)` Remove the link between a zone and a governance definition.
`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 Detail

createGovernanceZone
```
String createGovernanceZone(String userId,
                            GovernanceZoneProperties properties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            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

Throws:

InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateGovernanceZone

void updateGovernanceZone(String userId,
                          String zoneGUID,
                          boolean isMergeUpdate,
                          GovernanceZoneProperties properties)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          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:: InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

deleteGovernanceZone

void deleteGovernanceZone(String userId,
                          String zoneGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Remove the definition of a zone.

Parameters:: userId - calling user; zoneGUID - unique identifier of zone
Throws:: InvalidParameterException - guid or userId is null; guid is not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

linkZonesInHierarchy
```
void linkZonesInHierarchy(String userId,
                          String parentZoneGUID,
                          String childZoneGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          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:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkZonesInHierarchy

void unlinkZonesInHierarchy(String userId,
                            String parentZoneGUID,
                            String childZoneGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            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:: InvalidParameterException - one of the guids is null or not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

linkZoneToGovernanceDefinition

void linkZoneToGovernanceDefinition(String userId,
                                    String zoneGUID,
                                    String definitionGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Link a governance zone to a governance definition that controls how the assets in the zone should be governed.

Parameters:: userId - calling user; zoneGUID - unique identifier of the zone; definitionGUID - unique identifier of the governance definition
Throws:: InvalidParameterException - one of the guids is null or not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

unlinkZoneFromGovernanceDefinition

void unlinkZoneFromGovernanceDefinition(String userId,
                                        String zoneGUID,
                                        String definitionGUID)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Remove the link between a zone and a governance definition.

Parameters:: userId - calling user; zoneGUID - unique identifier of the zone; definitionGUID - unique identifier of the governance definition
Throws:: InvalidParameterException - one of the guids is null or not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getGovernanceZoneByGUID

GovernanceZoneElement getGovernanceZoneByGUID(String userId,
                                              String zoneGUID)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              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:: InvalidParameterException - zoneGUID or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getGovernanceZoneByName

GovernanceZoneElement getGovernanceZoneByName(String userId,
                                              String qualifiedName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              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:: InvalidParameterException - qualifiedName or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getGovernanceZonesForDomain

List<GovernanceZoneElement> getGovernanceZonesForDomain(String userId,
                                                        int domainIdentifier,
                                                        int startFrom,
                                                        int pageSize)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        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:: InvalidParameterException - qualifiedName or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getGovernanceZoneDefinitionByGUID

GovernanceZoneDefinition getGovernanceZoneDefinitionByGUID(String userId,
                                                           String zoneGUID)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException