Package org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest

Class ReferenceableRequestBody

java.lang.Object
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest.OCFOMASAPIRequestBody
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest.ReferenceableRequestBody
public class ReferenceableRequestBody extends OCFOMASAPIRequestBody
ReferenceableRequestBody provides a structure for passing a referenceables' properties as a request body over a REST API.

  • Constructor Details

    • ReferenceableRequestBody

      public ReferenceableRequestBody()
      Default constructor

    • ReferenceableRequestBody

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

  • Method Details

    • 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

    • getClassifications

      public List<org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementClassification> getClassifications()
      Return the classifications associated with this referenceable.
      Returns:
      list of classifications with their properties

    • setClassifications

      public void setClassifications(List<org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementClassification> classifications)
      Set up the list of classifications associated with this referenceable.
      Parameters:
      classifications - list of classifications with their properties

    • 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

    • setQualifiedName

      public void setQualifiedName(String qualifiedName)
      Set up the fully qualified name.
      Parameters:
      qualifiedName - 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

    • getMeanings

      public List<org.odpi.openmetadata.frameworks.connectors.properties.beans.Meaning> getMeanings()
      Return the assigned meanings for this metadata entity.
      Returns:
      list of meanings

    • setMeanings

      public void setMeanings(List<org.odpi.openmetadata.frameworks.connectors.properties.beans.Meaning> meanings)
      Set up the assigned meanings for this metadata entity.
      Parameters:
      meanings - list of meanings

    • 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

    • toString

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

    • equals

      public boolean equals(Object objectToCompare)
      Equals method that returns true if containing properties are the same.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class Object
      Returns:
      int hash code