java.lang.Object
org.odpi.openmetadata.accessservices.securitymanager.properties.ReferenceableProperties
Direct Known Subclasses:
ActorProfileProperties, SecurityManagerProperties, UserIdentityProperties

public class ReferenceableProperties extends Object
Many open metadata entities are referenceable. It means that they have a qualified name and additional properties.
  • Constructor Details

    • ReferenceableProperties

      public ReferenceableProperties()
      Default constructor
    • ReferenceableProperties

      public ReferenceableProperties(ReferenceableProperties template)
      Copy/clone constructor. Retrieves values from the supplied template
      Parameters:
      template - element to copy
  • Method Details

    • 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
    • getEffectiveFrom

      public Date getEffectiveFrom()
      Return the date/time that this element is effective from (null means effective from the epoch).
      Returns:
      date object
    • setEffectiveFrom

      public void setEffectiveFrom(Date effectiveFrom)
      Set up the date/time that this element is effective from (null means effective from the epoch).
      Parameters:
      effectiveFrom - date object
    • getEffectiveTo

      public Date getEffectiveTo()
      Return the date/time that element is effective to (null means that it is effective indefinitely into the future).
      Returns:
      date object
    • setEffectiveTo

      public void setEffectiveTo(Date effectiveTo)
      Set the date/time that element is effective to (null means that it is effective indefinitely into the future).
      Parameters:
      effectiveTo - date object
    • getVendorProperties

      public Map<String,String> getVendorProperties()
      Return specific properties for the data manager vendor.
      Returns:
      name value pairs
    • setVendorProperties

      public void setVendorProperties(Map<String,String> vendorProperties)
      Set up specific properties for the data manager vendor.
      Parameters:
      vendorProperties - name value pairs
    • getTypeName

      public String getTypeName()
      Return the name of the open metadata type for this metadata element.
      Returns:
      string name
    • setTypeName

      public void setTypeName(String typeName)
      Set up the name of the open metadata type for this element.
      Parameters:
      typeName - string name
    • 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
    • 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 hash code based on properties.
      Overrides:
      hashCode in class Object
      Returns:
      int