org.odpi.openmetadata.accessservices.governanceprogram.api

Interface GovernanceClassificationLevelInterface

public interface GovernanceClassificationLevelInterface

GovernanceClassificationLevelInterface defines the levels of the standard governance classifications of Impact, Criticality, Retention, Confidence and Confidentiality.

Method Summary

Modifier and Type	Method and Description
String	createGovernanceLevelIdentifier(String userId, String setGUID, GovernanceLevelIdentifierProperties properties) Create a new metadata element to represent a governance classification level identifier.
String	createGovernanceLevelIdentifierSet(String userId, GovernanceLevelIdentifierSetProperties properties) Create a new metadata element to represent the root of a Governance Classification Level Identifier Sets.
String	createStandardGovernanceClassificationLevels(String userId, String classificationName) Create a governance level identifier set for a specific governance classification: Impact - classification used to document the impact of an issue or situation. Criticality - classification used to document how critical an asset or activity is. Retention - classification used to identify the basis that an asset should be retained. Confidence - classification use to document an assessment of the quality of an asset or element with an asset. Confidentiality - classification use to define how much access to an asset should be restricted.
GovernanceLevelIdentifierElement	getGovernanceLevelIdentifier(String userId, String classificationName, int levelIdentifier) Retrieve the governance classification level identifier metadata element for the requested level within a specific governance classification.
GovernanceLevelIdentifierSetElement	getGovernanceLevelIdentifierSet(String userId, String classificationName) Retrieve the Governance Level Identifier Set for a requested governance classification.
GovernanceLevelIdentifierSetElement	getGovernanceLevelIdentifierSetByGUID(String userId, String setGUID) Retrieve the Governance Level Identifier Set metadata element with the supplied unique identifier.
List<GovernanceLevelIdentifierSetElement>	getGovernanceLevelIdentifierSets(String userId) Retrieve the list of Governance Classification Level Identifier Sets.
void	removeGovernanceLevelIdentifier(String userId, String identifierGUID) Remove the metadata element representing a governance classification level identifier.
void	removeGovernanceLevelIdentifierSet(String userId, String setGUID) Remove the metadata element representing a Governance Classification Level Identifier Sets and all linked level identifiers.
void	updateGovernanceLevelIdentifier(String userId, String identifierGUID, GovernanceLevelIdentifierProperties properties) Update the metadata element representing a governance classification level identifier.
void	updateGovernanceLevelIdentifierSet(String userId, String setGUID, GovernanceLevelIdentifierSetProperties properties) Update the metadata element representing a Governance Classification Level Identifier Sets.

Method Detail

createStandardGovernanceClassificationLevels

String createStandardGovernanceClassificationLevels(String userId,
                                                    String classificationName)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Create a governance level identifier set for a specific governance classification:

• Impact - classification used to document the impact of an issue or situation.
• Criticality - classification used to document how critical an asset or activity is.
• Retention - classification used to identify the basis that an asset should be retained.
• Confidence - classification use to document an assessment of the quality of an asset or element with an asset.
• Confidentiality - classification use to define how much access to an asset should be restricted.

Parameters:

userId - calling user

classificationName - name of the classification level to set up

Returns:

unique identifier of the governance level identifier set

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createGovernanceLevelIdentifierSet

String createGovernanceLevelIdentifierSet(String userId,
                                          GovernanceLevelIdentifierSetProperties properties)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Create a new metadata element to represent the root of a Governance Classification Level Identifier Sets.

Parameters:

userId - calling user

properties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateGovernanceLevelIdentifierSet

void updateGovernanceLevelIdentifierSet(String userId,
                                        String setGUID,
                                        GovernanceLevelIdentifierSetProperties properties)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Update the metadata element representing a Governance Classification Level Identifier Sets.

Parameters:

userId - calling user

setGUID - unique identifier of the metadata element to remove

properties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeGovernanceLevelIdentifierSet

void removeGovernanceLevelIdentifierSet(String userId,
                                        String setGUID)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Remove the metadata element representing a Governance Classification Level Identifier Sets and all linked level identifiers.

Parameters:

userId - calling user

setGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceLevelIdentifierSets

List<GovernanceLevelIdentifierSetElement> getGovernanceLevelIdentifierSets(String userId)
                                                                    throws InvalidParameterException,
                                                                           UserNotAuthorizedException,
                                                                           PropertyServerException

Retrieve the list of Governance Classification Level Identifier Sets.

Parameters:

userId - calling user

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceLevelIdentifierSet

GovernanceLevelIdentifierSetElement getGovernanceLevelIdentifierSet(String userId,
                                                                    String classificationName)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    PropertyServerException

Retrieve the Governance Level Identifier Set for a requested governance classification.

Parameters:

userId - calling user

classificationName - classificationName to search for

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceLevelIdentifierSetByGUID

GovernanceLevelIdentifierSetElement getGovernanceLevelIdentifierSetByGUID(String userId,
                                                                          String setGUID)
                                                                   throws InvalidParameterException,
                                                                          UserNotAuthorizedException,
                                                                          PropertyServerException

Retrieve the Governance Level Identifier Set metadata element with the supplied unique identifier.

Parameters:

userId - calling user

setGUID - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createGovernanceLevelIdentifier

String createGovernanceLevelIdentifier(String userId,
                                       String setGUID,
                                       GovernanceLevelIdentifierProperties properties)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Create a new metadata element to represent a governance classification level identifier.

Parameters:

userId - calling user

properties - properties about the Governance LevelIdentifier to store

setGUID - unique identifier of the set that this identifier belongs

Returns:

unique identifier of the new Governance LevelIdentifier

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateGovernanceLevelIdentifier

void updateGovernanceLevelIdentifier(String userId,
                                     String identifierGUID,
                                     GovernanceLevelIdentifierProperties properties)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Update the metadata element representing a governance classification level identifier.

Parameters:

userId - calling user

identifierGUID - unique identifier of the metadata element to update

properties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeGovernanceLevelIdentifier

void removeGovernanceLevelIdentifier(String userId,
                                     String identifierGUID)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Remove the metadata element representing a governance classification level identifier.

Parameters:

userId - calling user

identifierGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceLevelIdentifier

GovernanceLevelIdentifierElement getGovernanceLevelIdentifier(String userId,
                                                              String classificationName,
                                                              int levelIdentifier)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Retrieve the governance classification level identifier metadata element for the requested level within a specific governance classification.

Parameters:

userId - calling user

classificationName - string to find in the properties

levelIdentifier - level value to retrieve

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)