```
public interface GovernanceProgramReviewInterface
```
The GovernanceProgramReviewInterface supports the periodic review of the governance program. This includes looking at the metrics and the governance zones.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`List<GovernanceDefinitionElement>`	`findGovernanceDefinitions(String userId, String typeName, String searchString, int startFrom, int pageSize)`	Return the list of governance definitions that match the search string - this can be a regular expression.
`GovernanceDefinitionElement`	`getGovernanceDefinitionByGUID(String userId, String definitionGUID)`	Retrieve the governance definition by the unique identifier assigned by this service when it was created.
`GovernanceDefinitionGraph`	`getGovernanceDefinitionInContext(String userId, String governanceDefinitionGUID)`	Return the governance definition associated with a unique identifier and the other governance definitions linked to it.
`List<GovernanceMetricImplementation>`	`getGovernanceDefinitionMetrics(String userId, String governanceDefinitionGUID, int startFrom, int pageSize)`	Return details of the metrics for a governance definition along with details of where the
`List<GovernanceDefinitionElement>`	`getGovernanceDefinitionsForDocId(String userId, String typeName, String docId, int startFrom, int pageSize)`	Return the list of governance definitions associated with a unique docId.
`List<GovernanceDefinitionElement>`	`getGovernanceDefinitionsForDomain(String userId, String typeName, int domainIdentifier, int startFrom, int pageSize)`	Return the list of governance definitions associated with a particular governance domain.
`List<ElementStub>`	`getGovernanceZoneMembers(String userId, String zoneName, String subTypeName, int startFrom, int pageSize)`	Return the list of assets that are members of a particular zone.

Method Detail

getGovernanceDefinitionByGUID

GovernanceDefinitionElement getGovernanceDefinitionByGUID(String userId,
                                                          String definitionGUID)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Retrieve the governance definition by the unique identifier assigned by this service when it was created.

Parameters:: userId - calling user; definitionGUID - identifier of the governance definition to retrieve
Returns:: properties of the governance definition
Throws:: InvalidParameterException - guid or userId is null; guid is not recognized; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getGovernanceDefinitionsForDomain

List<GovernanceDefinitionElement> getGovernanceDefinitionsForDomain(String userId,
                                                                    String typeName,
                                                                    int domainIdentifier,
                                                                    int startFrom,
                                                                    int pageSize)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    PropertyServerException

Return the list of governance definitions associated with a particular governance domain.

Parameters:: userId - calling user; typeName - option type name to restrict retrieval to a specific type; domainIdentifier - identifier of the governance domain - 0 = all domains; startFrom - where to start from in the list of definitions; pageSize - max number of results to return in one call
Returns:: list of governance definitions
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the caller is not authorized to issue the request; PropertyServerException - the metadata service has problems

getGovernanceDefinitionsForDocId

List<GovernanceDefinitionElement> getGovernanceDefinitionsForDocId(String userId,
                                                                   String typeName,
                                                                   String docId,
                                                                   int startFrom,
                                                                   int pageSize)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   PropertyServerException

Return the list of governance definitions associated with a unique docId. In an ideal world, there should be only one.

Parameters:: userId - calling user; typeName - option type name to restrict retrieval to a specific type; docId - unique name of the governance definition; startFrom - where to start from in the list of definitions; pageSize - max number of results to return in one call
Returns:: list of governance definitions
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the caller is not authorized to issue the request; PropertyServerException - the metadata service has problems

getGovernanceDefinitionInContext

GovernanceDefinitionGraph getGovernanceDefinitionInContext(String userId,
                                                           String governanceDefinitionGUID)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Return the governance definition associated with a unique identifier and the other governance definitions linked to it.

Parameters:: userId - calling user; governanceDefinitionGUID - unique identifier of the governance definition
Returns:: governance definition and its linked elements
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the caller is not authorized to issue the request; PropertyServerException - the metadata service has problems

findGovernanceDefinitions

List<GovernanceDefinitionElement> findGovernanceDefinitions(String userId,
                                                            String typeName,
                                                            String searchString,
                                                            int startFrom,
                                                            int pageSize)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Return the list of governance definitions that match the search string - this can be a regular expression.

Parameters:: userId - calling user; typeName - option type name to restrict retrieval to a specific type; searchString - value to search for; startFrom - where to start from in the list of definition results; pageSize - max number of results to return in one call
Returns:: list of governance definitions
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the caller is not authorized to issue the request; PropertyServerException - the metadata service has problems

getGovernanceDefinitionMetrics

List<GovernanceMetricImplementation> getGovernanceDefinitionMetrics(String userId,
                                                                    String governanceDefinitionGUID,
                                                                    int startFrom,
                                                                    int pageSize)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    PropertyServerException

Return details of the metrics for a governance definition along with details of where the

Parameters:: userId - calling user; governanceDefinitionGUID - unique name of the governance definition; startFrom - where to start from in the list of definitions; pageSize - max number of results to return in one call
Returns:: list of associated metrics and links for retrieving the captured measurements
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the caller is not authorized to issue the request; PropertyServerException - the metadata service has problems

getGovernanceZoneMembers

List<ElementStub> getGovernanceZoneMembers(String userId,
                                           String zoneName,
                                           String subTypeName,
                                           int startFrom,
                                           int pageSize)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Return the list of assets that are members of a particular zone.

Parameters:: userId - calling user; zoneName - unique name of the zone to search for; subTypeName - optional asset subtypeName to limit the results; startFrom - where to start from in the list of assets; pageSize - max number of results to return in one call
Returns:: list of headers for assets in the requested zone
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the caller is not authorized to issue the request; PropertyServerException - the metadata service has problems

Interface GovernanceProgramReviewInterface