Package org.odpi.openmetadata.frameworks.governanceaction.properties

Class GovernanceServiceProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceServiceProperties
Direct Known Subclasses:
RegisteredGovernanceService
public class GovernanceServiceProperties extends org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
GovernanceServiceProperties contains the definition of a governance service. This definition can be associated with multiple governance engines.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GovernanceServiceProperties()
    Default constructor
    GovernanceServiceProperties(GovernanceServiceProperties template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Compare the values of the supplied object with those stored in the current object.
    org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection
    getConnection()
    Return the connection used to create a instance of this governance service.
    String
    getDescription()
    Returns the stored description property for the asset.
    String
    getDisplayName()
    Returns the stored display name property for the asset.
    String
    getOriginBusinessCapabilityGUID()
    Return the unique identifier of the business capability that originated this governance service.
    String
    getOriginOrganizationGUID()
    Return the unique identifier for the organization that originated this governance service.
    Map<String,String>
    getOtherOriginValues()
    Return the properties that characterize where this governance service is from.
    String
    getOwner()
    Returns the name of the owner for this asset.
    String
    getOwnerPropertyName()
    Return the property name used to identifier the owner.
    String
    getOwnerTypeName()
    Return the type of owner stored in the owner property.
    List<String>
    getZoneMembership()
    Return the names of the zones that this governance service is a member of.
    int
    hashCode()
    Create a hash code for this element type.
    void
    setConnection(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Set up the connection used to create a instance of this governance service.
    void
    setDescription(String description)
    Set up the stored description property associated with the asset.
    void
    setDisplayName(String displayName)
    Set up the stored display name property for the asset.
    void
    setOriginBusinessCapabilityGUID(String originBusinessCapabilityGUID)
    Set up the unique identifier of the business capability that originated this governance service.
    void
    setOriginOrganizationGUID(String originOrganizationGUID)
    Set up the unique identifier for the organization that originated this governance service.
    void
    setOtherOriginValues(Map<String,String> otherOriginValues)
    Set up the properties that characterize where this governance service is from.
    void
    setOwner(String owner)
    Set up the name of the owner for this asset.
    void
    setOwnerPropertyName(String ownerPropertyName)
    Set up the property name used to identifier the owner.
    void
    setOwnerTypeName(String ownerTypeName)
    Set up the type of owner stored in the owner property.
    void
    setZoneMembership(List<String> zoneMembership)
    Set up the names of the zones that this governance service is a member of.
    String
    toString()
    Standard toString method.

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties

    getAdditionalProperties, getQualifiedName, getVendorProperties, setAdditionalProperties, setQualifiedName, setVendorProperties

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties

    getEffectiveFrom, getEffectiveTo, getExtendedProperties, getTypeName, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setTypeName

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • GovernanceServiceProperties

      public GovernanceServiceProperties()
      Default constructor

    • GovernanceServiceProperties

      public GovernanceServiceProperties(GovernanceServiceProperties template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getDisplayName

      public String getDisplayName()
      Returns the stored display name property for the asset. If no display name is available then null is returned.
      Returns:
      String name

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the stored display name property for the asset.
      Parameters:
      displayName - String name

    • getDescription

      public String getDescription()
      Returns the stored description property for the asset. If no description is provided then null is returned.
      Returns:
      description String text

    • setDescription

      public void setDescription(String description)
      Set up the stored description property associated with the asset.
      Parameters:
      description - String text

    • getOwner

      public String getOwner()
      Returns the name of the owner for this asset.
      Returns:
      owner String

    • setOwner

      public void setOwner(String owner)
      Set up the name of the owner for this asset.
      Parameters:
      owner - String name

    • getOwnerTypeName

      public String getOwnerTypeName()
      Return the type of owner stored in the owner property.
      Returns:
      String name

    • setOwnerTypeName

      public void setOwnerTypeName(String ownerTypeName)
      Set up the type of owner stored in the owner property.
      Parameters:
      ownerTypeName - String name

    • getOwnerPropertyName

      public String getOwnerPropertyName()
      Return the property name used to identifier the owner.
      Returns:
      String name

    • setOwnerPropertyName

      public void setOwnerPropertyName(String ownerPropertyName)
      Set up the property name used to identifier the owner.
      Parameters:
      ownerPropertyName - String name

    • getZoneMembership

      public List<String> getZoneMembership()
      Return the names of the zones that this governance service is a member of.
      Returns:
      list of zone names

    • setZoneMembership

      public void setZoneMembership(List<String> zoneMembership)
      Set up the names of the zones that this governance service is a member of.
      Parameters:
      zoneMembership - list of zone names

    • getOriginOrganizationGUID

      public String getOriginOrganizationGUID()
      Return the unique identifier for the organization that originated this governance service.
      Returns:
      string guid

    • setOriginOrganizationGUID

      public void setOriginOrganizationGUID(String originOrganizationGUID)
      Set up the unique identifier for the organization that originated this governance service.
      Parameters:
      originOrganizationGUID - string guid

    • getOriginBusinessCapabilityGUID

      public String getOriginBusinessCapabilityGUID()
      Return the unique identifier of the business capability that originated this governance service.
      Returns:
      string guid

    • setOriginBusinessCapabilityGUID

      public void setOriginBusinessCapabilityGUID(String originBusinessCapabilityGUID)
      Set up the unique identifier of the business capability that originated this governance service.
      Parameters:
      originBusinessCapabilityGUID - string guid

    • getOtherOriginValues

      public Map<String,String> getOtherOriginValues()
      Return the properties that characterize where this governance service is from.
      Returns:
      map of name value pairs, all strings

    • setOtherOriginValues

      public void setOtherOriginValues(Map<String,String> otherOriginValues)
      Set up the properties that characterize where this governance service is from.
      Parameters:
      otherOriginValues - map of name value pairs, all strings

    • getConnection

      public org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection getConnection()
      Return the connection used to create a instance of this governance service.
      Returns:
      Connection object

    • setConnection

      public void setConnection(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
      Set up the connection used to create a instance of this governance service.
      Parameters:
      connection - connection object

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
      Returns:
      int hash code