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

Interface GovernanceStatusLevelInterface

public interface GovernanceStatusLevelInterface

GovernanceStatusLevelInterface defines the status levels of status for governance elements.

Method Summary

Modifier and Type	Method	Description
String	createGovernanceStatusIdentifier(String userId, String setGUID, GovernanceStatusIdentifierProperties properties)	Create a new metadata element to represent a governance status level identifier.
String	createGovernanceStatusIdentifierSet(String userId, GovernanceStatusIdentifierSetProperties properties)	Create a new metadata element to represent the root of a Governance Status Level Identifier Sets.
String	createStandardGovernanceStatusLevels(String userId)	Create a governance status identifier set using the standard values defined in GovernanceStatus enum
GovernanceStatusIdentifierElement	getGovernanceStatusIdentifier(String userId, int statusIdentifier)	Retrieve the governance status level identifier metadata element for the requested level within a specific governance status.
GovernanceStatusIdentifierSetElement	getGovernanceStatusIdentifierSet(String userId, String classificationName)	Retrieve the Governance Level Identifier Set for a requested governance status.
GovernanceStatusIdentifierSetElement	getGovernanceStatusIdentifierSetByGUID(String userId, String setGUID)	Retrieve the Governance Level Identifier Set metadata element with the supplied unique identifier.
List<GovernanceStatusIdentifierSetElement>	getGovernanceStatusIdentifierSets(String userId)	Retrieve the list of Governance Status Level Identifier Sets.
void	removeGovernanceStatusIdentifier(String userId, String identifierGUID)	Remove the metadata element representing a governance status level identifier.
void	removeGovernanceStatusIdentifierSet(String userId, String setGUID)	Remove the metadata element representing a Governance Status Level Identifier Sets and all linked level identifiers.
void	updateGovernanceStatusIdentifier(String userId, String identifierGUID, GovernanceStatusIdentifierProperties properties)	Update the metadata element representing a governance status level identifier.
void	updateGovernanceStatusIdentifierSet(String userId, String setGUID, GovernanceStatusIdentifierSetProperties properties)	Update the metadata element representing a Governance Status Level Identifier Sets.

Method Detail

createStandardGovernanceStatusLevels

String createStandardGovernanceStatusLevels(String userId)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Create a governance status identifier set using the standard values defined in GovernanceStatus enum

Parameters:

userId - calling user

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)

createGovernanceStatusIdentifierSet

String createGovernanceStatusIdentifierSet(String userId,
                                           GovernanceStatusIdentifierSetProperties properties)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Create a new metadata element to represent the root of a Governance Status 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)

updateGovernanceStatusIdentifierSet

void updateGovernanceStatusIdentifierSet(String userId,
                                         String setGUID,
                                         GovernanceStatusIdentifierSetProperties properties)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Update the metadata element representing a Governance Status 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)

removeGovernanceStatusIdentifierSet

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

Remove the metadata element representing a Governance Status 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)

getGovernanceStatusIdentifierSets

List<GovernanceStatusIdentifierSetElement> getGovernanceStatusIdentifierSets(String userId)
                                                                      throws InvalidParameterException,
                                                                             UserNotAuthorizedException,
                                                                             PropertyServerException

Retrieve the list of Governance Status 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)

getGovernanceStatusIdentifierSet

GovernanceStatusIdentifierSetElement getGovernanceStatusIdentifierSet(String userId,
                                                                      String classificationName)
                                                               throws InvalidParameterException,
                                                                      UserNotAuthorizedException,
                                                                      PropertyServerException

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

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)

getGovernanceStatusIdentifierSetByGUID

GovernanceStatusIdentifierSetElement getGovernanceStatusIdentifierSetByGUID(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)

createGovernanceStatusIdentifier

String createGovernanceStatusIdentifier(String userId,
                                        String setGUID,
                                        GovernanceStatusIdentifierProperties properties)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Create a new metadata element to represent a governance status 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)

updateGovernanceStatusIdentifier

void updateGovernanceStatusIdentifier(String userId,
                                      String identifierGUID,
                                      GovernanceStatusIdentifierProperties properties)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Update the metadata element representing a governance status 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)

removeGovernanceStatusIdentifier

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

Remove the metadata element representing a governance status 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)

getGovernanceStatusIdentifier

GovernanceStatusIdentifierElement getGovernanceStatusIdentifier(String userId,
                                                                int statusIdentifier)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException

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

Parameters:

userId - calling user

statusIdentifier - 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)