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, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceStatusIdentifierProperties properties)
    Create a new metadata element to represent a governance status level identifier.
    String
    createGovernanceStatusIdentifierSet(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.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
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceStatusIdentifierElement
    getGovernanceStatusIdentifier(String userId, int statusIdentifier)
    Retrieve the governance status level identifier metadata element for the requested level within a specific governance status.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceStatusIdentifierSetElement
    getGovernanceStatusIdentifierSetByGUID(String userId, String setGUID)
    Retrieve the Governance Level Identifier Set metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.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, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceStatusIdentifierProperties properties)
    Update the metadata element representing a governance status level identifier.
    void
    updateGovernanceStatusIdentifierSet(String userId, String setGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceStatusIdentifierSetProperties properties)
    Update the metadata element representing a Governance Status Level Identifier Sets.

  • Method Details

    • createStandardGovernanceStatusLevels

      String createStandardGovernanceStatusLevels(String userId) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createGovernanceStatusIdentifierSet

      String createGovernanceStatusIdentifierSet(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceStatusIdentifierSetProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateGovernanceStatusIdentifierSet

      void updateGovernanceStatusIdentifierSet(String userId, String setGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceStatusIdentifierSetProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeGovernanceStatusIdentifierSet

      void removeGovernanceStatusIdentifierSet(String userId, String setGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGovernanceStatusIdentifierSets

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceStatusIdentifierSetElement> getGovernanceStatusIdentifierSets(String userId) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the list of Governance Status Level Identifier Sets.
      Parameters:
      userId - calling user
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGovernanceStatusIdentifierSetByGUID

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceStatusIdentifierSetElement getGovernanceStatusIdentifierSetByGUID(String userId, String setGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createGovernanceStatusIdentifier

      String createGovernanceStatusIdentifier(String userId, String setGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceStatusIdentifierProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateGovernanceStatusIdentifier

      void updateGovernanceStatusIdentifier(String userId, String identifierGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceStatusIdentifierProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeGovernanceStatusIdentifier

      void removeGovernanceStatusIdentifier(String userId, String identifierGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGovernanceStatusIdentifier

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceStatusIdentifierElement getGovernanceStatusIdentifier(String userId, int statusIdentifier) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)