Interface GovernanceClassificationLevelInterface
-
- All Known Implementing Classes:
GovernanceClassificationLevelManager
public interface GovernanceClassificationLevelInterface
GovernanceClassificationLevelInterface defines the levels of the standard governance classifications of Impact, Criticality, Retention, Confidence and Confidentiality.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
createGovernanceLevelIdentifier(java.lang.String userId, java.lang.String setGUID, GovernanceLevelIdentifierProperties properties)
Create a new metadata element to represent a governance classification level identifier.java.lang.String
createGovernanceLevelIdentifierSet(java.lang.String userId, GovernanceLevelIdentifierSetProperties properties)
Create a new metadata element to represent the root of a Governance Classification Level Identifier Sets.java.lang.String
createStandardGovernanceClassificationLevels(java.lang.String userId, java.lang.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(java.lang.String userId, java.lang.String classificationName, int levelIdentifier)
Retrieve the governance classification level identifier metadata element for the requested level within a specific governance classification.GovernanceLevelIdentifierSetElement
getGovernanceLevelIdentifierSet(java.lang.String userId, java.lang.String classificationName)
Retrieve the Governance Level Identifier Set for a requested governance classification.GovernanceLevelIdentifierSetElement
getGovernanceLevelIdentifierSetByGUID(java.lang.String userId, java.lang.String setGUID)
Retrieve the Governance Level Identifier Set metadata element with the supplied unique identifier.java.util.List<GovernanceLevelIdentifierSetElement>
getGovernanceLevelIdentifierSets(java.lang.String userId)
Retrieve the list of Governance Classification Level Identifier Sets.void
removeGovernanceLevelIdentifier(java.lang.String userId, java.lang.String identifierGUID)
Remove the metadata element representing a governance classification level identifier.void
removeGovernanceLevelIdentifierSet(java.lang.String userId, java.lang.String setGUID)
Remove the metadata element representing a Governance Classification Level Identifier Sets and all linked level identifiers.void
updateGovernanceLevelIdentifier(java.lang.String userId, java.lang.String identifierGUID, GovernanceLevelIdentifierProperties properties)
Update the metadata element representing a governance classification level identifier.void
updateGovernanceLevelIdentifierSet(java.lang.String userId, java.lang.String setGUID, GovernanceLevelIdentifierSetProperties properties)
Update the metadata element representing a Governance Classification Level Identifier Sets.
-
-
-
Method Detail
-
createStandardGovernanceClassificationLevels
java.lang.String createStandardGovernanceClassificationLevels(java.lang.String userId, java.lang.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 userclassificationName
- name of the classification level to set up- Returns:
- unique identifier of the governance level identifier set
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createGovernanceLevelIdentifierSet
java.lang.String createGovernanceLevelIdentifierSet(java.lang.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 userproperties
- properties to store- Returns:
- unique identifier of the new metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateGovernanceLevelIdentifierSet
void updateGovernanceLevelIdentifierSet(java.lang.String userId, java.lang.String setGUID, GovernanceLevelIdentifierSetProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update the metadata element representing a Governance Classification Level Identifier Sets.- Parameters:
userId
- calling usersetGUID
- unique identifier of the metadata element to removeproperties
- new properties for this element- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
removeGovernanceLevelIdentifierSet
void removeGovernanceLevelIdentifierSet(java.lang.String userId, java.lang.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 usersetGUID
- unique identifier of the metadata element to remove- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getGovernanceLevelIdentifierSets
java.util.List<GovernanceLevelIdentifierSetElement> getGovernanceLevelIdentifierSets(java.lang.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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getGovernanceLevelIdentifierSet
GovernanceLevelIdentifierSetElement getGovernanceLevelIdentifierSet(java.lang.String userId, java.lang.String classificationName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the Governance Level Identifier Set for a requested governance classification.- Parameters:
userId
- calling userclassificationName
- classificationName to search for- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getGovernanceLevelIdentifierSetByGUID
GovernanceLevelIdentifierSetElement getGovernanceLevelIdentifierSetByGUID(java.lang.String userId, java.lang.String setGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the Governance Level Identifier Set metadata element with the supplied unique identifier.- Parameters:
userId
- calling usersetGUID
- unique identifier of the requested metadata element- Returns:
- matching metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createGovernanceLevelIdentifier
java.lang.String createGovernanceLevelIdentifier(java.lang.String userId, java.lang.String setGUID, GovernanceLevelIdentifierProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Create a new metadata element to represent a governance classification level identifier.- Parameters:
userId
- calling userproperties
- properties about the Governance LevelIdentifier to storesetGUID
- unique identifier of the set that this identifier belongs- Returns:
- unique identifier of the new Governance LevelIdentifier
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateGovernanceLevelIdentifier
void updateGovernanceLevelIdentifier(java.lang.String userId, java.lang.String identifierGUID, GovernanceLevelIdentifierProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update the metadata element representing a governance classification level identifier.- Parameters:
userId
- calling useridentifierGUID
- unique identifier of the metadata element to updateproperties
- new properties for the metadata element- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
removeGovernanceLevelIdentifier
void removeGovernanceLevelIdentifier(java.lang.String userId, java.lang.String identifierGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Remove the metadata element representing a governance classification level identifier.- Parameters:
userId
- calling useridentifierGUID
- unique identifier of the metadata element to remove- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getGovernanceLevelIdentifier
GovernanceLevelIdentifierElement getGovernanceLevelIdentifier(java.lang.String userId, java.lang.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 userclassificationName
- string to find in the propertieslevelIdentifier
- level value to retrieve- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
-