Package org.odpi.openmetadata.accessservices.communityprofile.properties

Class GovernanceDefinitionProperties

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    SecurityGroupProperties
    public class GovernanceDefinitionProperties
extends Object
implements Serializable
    GovernanceDefinitionProperties provides the base class for many of the definitions that define the data strategy and governance program. It includes many of the common fields:
    • Document Id
    • Title
    • Summary
    • Description
    • Scope
    • Domain Identifier
    • Status
    • Priority
    • Implications
    • Outcomes
    • Results
    • AdditionalProperties
    See Also:
    Serialized Form

    • Constructor Detail

      • GovernanceDefinitionProperties

        public GovernanceDefinitionProperties()
        Default Constructor

      • GovernanceDefinitionProperties

        public GovernanceDefinitionProperties​(GovernanceDefinitionProperties template)
        Copy/clone Constructor
        Parameters:
        template - object being copied

    • Method Detail

      • getTypeName

        public String getTypeName()
        Return the open metadata type name of this object - this is used to create a subtype of the referenceable. Any properties associated with this subtype are passed as extended properties.
        Returns:
        string type name

      • setTypeName

        public void setTypeName​(String typeName)
        Set up the open metadata type name of this object - this is used to create a subtype of the referenceable. Any properties associated with this subtype are passed as extended properties.
        Parameters:
        typeName - string type name

      • getDocumentIdentifier

        public String getDocumentIdentifier()
        Returns the stored qualified name property for the metadata entity. If no qualified name is available then the empty string is returned.
        Returns:
        documentIdentifier

      • setDocumentIdentifier

        public void setDocumentIdentifier​(String documentIdentifier)
        Set up the fully qualified name.
        Parameters:
        documentIdentifier - String name

      • getAdditionalProperties

        public Map<String,​String> getAdditionalProperties()
        Return a copy of the additional properties. Null means no additional properties are available.
        Returns:
        AdditionalProperties

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​String> additionalProperties)
        Set up additional properties.
        Parameters:
        additionalProperties - Additional properties object

      • getExtendedProperties

        public Map<String,​Object> getExtendedProperties()
        Return the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.
        Returns:
        map of properties

      • setExtendedProperties

        public void setExtendedProperties​(Map<String,​Object> extendedProperties)
        Set up the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.
        Parameters:
        extendedProperties - map of properties

      • getTitle

        public String getTitle()
        Return the title associated with this governance definition.
        Returns:
        String title

      • setTitle

        public void setTitle​(String title)
        Set up the title associated with this governance definition.
        Parameters:
        title - String title

      • getSummary

        public String getSummary()
        Return the summary for this governance definition. This should cover its essence. Think of it as the executive summary.
        Returns:
        String short description

      • setSummary

        public void setSummary​(String summary)
        Set up the summary of the governance definition. This should cover its essence. Think of it as the executive summary.
        Parameters:
        summary - String description

      • getDescription

        public String getDescription()
        Return the full description of the governance definition.
        Returns:
        String description

      • setDescription

        public void setDescription​(String description)
        Set up the full description of the governance definition.
        Parameters:
        description - String description

      • getScope

        public String getScope()
        Return the organizational scope that this governance definition applies to.
        Returns:
        String organization, department or team name

      • setScope

        public void setScope​(String scope)
        Set up the organizational scope that this governance definition applies to.
        Parameters:
        scope - String organization, department or team name

      • getDomainIdentifier

        public int getDomainIdentifier()
        Return the identifier of the governance domain that this definition belongs to (0=all).
        Returns:
        int

      • setDomainIdentifier

        public void setDomainIdentifier​(int domainIdentifier)
        Set up the identifier of the governance domain that this definition belongs to (0=all).
        Parameters:
        domainIdentifier - int

      • getStatus

        public GovernanceDefinitionStatus getStatus()
        Return the status of this governance definition. The meaning of the different values are defined in the GovernanceDefinitionStatus enumeration.
        Returns:
        GovernanceDefinitionStatus enumeration

      • setStatus

        public void setStatus​(GovernanceDefinitionStatus status)
        Set up the status of this governance definition. The meaning of the different values are defined in the GovernanceDefinitionStatus enumeration.
        Parameters:
        status - GovernanceDefinitionStatus enumeration

      • getPriority

        public String getPriority()
        Return the priority of the governance definition. This may be something like high, medium or low, or maybe a time frame or more detailed explanation.
        Returns:
        String priority

      • setPriority

        public void setPriority​(String priority)
        Set up the priority of this governance definition. This may be something like high, medium or low, or maybe a time frame or more detailed explanation.
        Parameters:
        priority - String priority

      • getImplications

        public List<String> getImplications()
        Return the list of implications for the organization that this governance definition brings. This is often the first enumeration of the changes that that need to be implemented to bring the governance definition into effect.
        Returns:
        list of descriptions

      • setImplications

        public void setImplications​(List<String> implications)
        Set up the list of implications for the organization that this governance definition brings. This is often the first enumeration of the changes that that need to be implemented to bring the governance definition into effect.
        Parameters:
        implications - list of descriptions

      • getOutcomes

        public List<String> getOutcomes()
        Return the list of expected outcomes from implementing this governance definition.
        Returns:
        list of outcome descriptions

      • setOutcomes

        public void setOutcomes​(List<String> outcomes)
        Set up the list of expected outcomes from implementing this governance definition.
        Parameters:
        outcomes - list of descriptions of outcomes

      • getResults

        public List<String> getResults()
        Return the list of actual results from implementing this governance definition.
        Returns:
        list of result descriptions

      • setResults

        public void setResults​(List<String> results)
        Set up the list of actual results from implementing this governance definition.
        Parameters:
        results - list of description of results

      • toString

        public String toString()
        JSON-style toString.
        Overrides:
        toString in class Object
        Returns:
        list of properties and their values.

      • equals

        public boolean equals​(Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class Object
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison

      • hashCode

        public int hashCode()
        Return has code based on properties.
        Overrides:
        hashCode in class Object
        Returns:
        int