Package org.odpi.openmetadata.metadatasecurity.properties

Class Referenceable

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    Asset, Connection
    public class Referenceable
extends Object
implements Serializable
    Referenceable is a set of properties that describes an open metadata referencable object. A referenceable is an open metadata type that has enough significance to be awarded a unique qualified name. This bean is designed to convey the important properties needed to make a security decision relating to this object
    See Also:
    Serialized Form

    • Constructor Detail

      • Referenceable

        public Referenceable()
        Default constructor

      • Referenceable

        public Referenceable​(Referenceable template)
        Copy/clone constructor. Retrieves values from the supplied template
        Parameters:
        template - element to copy

    • Method Detail

      • getTypeGUID

        public String getTypeGUID()
        Return the unique identifier for this object's type.
        Returns:
        string guid

      • setTypeGUID

        public void setTypeGUID​(String typeGUID)
        Set up the unique identifier for this object's type.
        Parameters:
        typeGUID - string guid

      • getTypeName

        public String getTypeName()
        Return the unique name of this object's type.
        Returns:
        string name

      • getStatus

        public ReferenceableStatus getStatus()
        Return the status for the bean.
        Returns:
        enum value

      • setStatus

        public void setStatus​(ReferenceableStatus status)
        Set up the status for the bean.
        Parameters:
        status - enum value

      • getGUID

        public String getGUID()
        Return the unique identifier for this object.
        Returns:
        string guid

      • setGUID

        public void setGUID​(String guid)
        Set up the unique identifier for this object.
        Parameters:
        guid - string guid

      • setTypeName

        public void setTypeName​(String typeName)
        Set up the unique name of this object's type.
        Parameters:
        typeName - string name

      • setQualifiedName

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

      • getQualifiedName

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

      • setAdditionalProperties

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

      • getAdditionalProperties

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

      • getExtendedProperties

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

      • setExtendedProperties

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

      • getSecurityLabels

        public List<String> getSecurityLabels()
        Return the list of security labels attached to the element.
        Returns:
        list of label strings

      • setSecurityLabels

        public void setSecurityLabels​(List<String> securityLabels)
        Set up the list of security labels for the element.
        Parameters:
        securityLabels - list of label strings

      • getSecurityProperties

        public Map<String,​Object> getSecurityProperties()
        Return the security properties associated with the element. These are name-value pairs.
        Returns:
        map of properties

      • setSecurityProperties

        public void setSecurityProperties​(Map<String,​Object> securityProperties)
        Set up the security properties associated with the element. These are name-value pairs.
        Parameters:
        securityProperties - map of properties

      • getConfidentiality

        public ConfidentialityGovernanceClassification getConfidentiality()
        Return the classification that defines how confidential the contents of this referenceable are.
        Returns:
        confidentiality classification properties

      • setConfidentiality

        public void setConfidentiality​(ConfidentialityGovernanceClassification confidentiality)
        Set up the classification that defines how confidential the contents of this referenceable are.
        Parameters:
        confidentiality - confidentiality classification properties

      • getConfidence

        public ConfidenceGovernanceClassification getConfidence()
        Return the classification that defines how confident a user should be in the quality of the contents of this referenceable are.
        Returns:
        confidence classification properties

      • setConfidence

        public void setConfidence​(ConfidenceGovernanceClassification confidence)
        Set up the classification that defines how confident a user should be in the quality of the contents of this referenceable are.
        Parameters:
        confidence - confidence classification properties

      • getCriticality

        public CriticalityGovernanceClassification getCriticality()
        Return the classification that defines how critical this referenceable is to the business.
        Returns:
        criticality classification properties

      • setCriticality

        public void setCriticality​(CriticalityGovernanceClassification criticality)
        Set up the classification that defines how critical this referenceable is to the business.
        Parameters:
        criticality - criticality classification properties

      • getImpact

        public ImpactGovernanceClassification getImpact()
        Return the classification that defines the impact of this referenceable to the business.
        Returns:
        criticality classification properties

      • setImpact

        public void setImpact​(ImpactGovernanceClassification impact)
        Set up the classification that defines the impact of this referenceable to the business.
        Parameters:
        impact - impact classification properties

      • getRetention

        public RetentionGovernanceClassification getRetention()
        Return the classification that defines when this referenceable will be archived and then permanently deleted.
        Returns:
        retention classification properties

      • setRetention

        public void setRetention​(RetentionGovernanceClassification retention)
        Set up the classification that defines when this referenceable will be archived and then permanently deleted.
        Parameters:
        retention - retention classification properties

      • toString

        public String toString()
        Standard toString method.
        Overrides:
        toString in class Object
        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 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