Package org.odpi.openmetadata.accessservices.assetowner.rest

Class ValidValuesRequestBody

java.lang.Object
org.odpi.openmetadata.accessservices.assetowner.rest.AssetOwnerOMASAPIRequestBody
org.odpi.openmetadata.accessservices.assetowner.rest.ValidValuesRequestBody
public class ValidValuesRequestBody extends AssetOwnerOMASAPIRequestBody
ValidValuesRequestBody carries the parameters for created a new valid values element.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ValidValuesRequestBody()
    Default constructor
    ValidValuesRequestBody(ValidValuesRequestBody 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.
    Map<String,String>
    getAdditionalProperties()
    Return a copy of the additional properties.
    List<org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementClassification>
    getClassifications()
    Return the classifications associated with this referenceable.
    String
    getDescription()
    Returns the stored description property for the valid value.
    String
    getDisplayName()
    Returns the stored display name property for the valid value.
    Map<String,Object>
    getExtendedProperties()
    Return the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.
    boolean
    getIsDeprecated()
    Is the valid value deprecated?
    String
    getPreferredValue()
    Return the preferred values to use in implementations (normally used with definitions)
    String
    getQualifiedName()
    Returns the stored qualified name property for the metadata entity.
    String
    getScope()
    Return the scope of values that this valid value covers (normally used with sets)
    String
    getTypeName()
    Return the open metadata type name of this object - this is used to create a subtype of the referenceable.
    String
    getUsage()
    Return the description of how this valid value should be used.
    int
    hashCode()
    Return hash code based on properties.
    void
    setAdditionalProperties(Map<String,String> additionalProperties)
    Set up additional properties.
    void
    setClassifications(List<org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementClassification> classifications)
    Set up the list of classifications associated with this referenceable.
    void
    setDescription(String description)
    Set up the stored description property associated with the valid value.
    void
    setDisplayName(String displayName)
    Set up the stored display name property for the valid value.
    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.
    void
    setIsDeprecated(boolean deprecated)
    Set whether the valid value is deprecated or not.
    void
    setPreferredValue(String preferredValue)
    Set up the preferred values to use in implementations (normally used with definitions)
    void
    setQualifiedName(String qualifiedName)
    Set up the fully qualified name.
    void
    setScope(String scope)
    Set up the scope of values that this valid value covers (normally used with sets)
    void
    setTypeName(String typeName)
    Set up the open metadata type name of this object - this is used to create a subtype of the referenceable.
    void
    setUsage(String usage)
    Set up the description of how this valid value should be used.
    String
    toString()
    Generate a string containing the properties.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ValidValuesRequestBody

      public ValidValuesRequestBody()
      Default constructor

    • ValidValuesRequestBody

      public ValidValuesRequestBody(ValidValuesRequestBody 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

    • 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

    • getDisplayName

      public String getDisplayName()
      Returns the stored display name property for the valid value. 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 valid value.
      Parameters:
      displayName - String name

    • getDescription

      public String getDescription()
      Returns the stored description property for the valid value. 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 valid value.
      Parameters:
      description - String text

    • getUsage

      public String getUsage()
      Return the description of how this valid value should be used.
      Returns:
      String text

    • setUsage

      public void setUsage(String usage)
      Set up the description of how this valid value should be used.
      Parameters:
      usage - String text

    • getScope

      public String getScope()
      Return the scope of values that this valid value covers (normally used with sets)
      Returns:
      String text

    • setScope

      public void setScope(String scope)
      Set up the scope of values that this valid value covers (normally used with sets)
      Parameters:
      scope - String text

    • getPreferredValue

      public String getPreferredValue()
      Return the preferred values to use in implementations (normally used with definitions)
      Returns:
      String value

    • setPreferredValue

      public void setPreferredValue(String preferredValue)
      Set up the preferred values to use in implementations (normally used with definitions)
      Parameters:
      preferredValue - String value

    • getIsDeprecated

      public boolean getIsDeprecated()
      Is the valid value deprecated?
      Returns:
      boolean flag

    • setIsDeprecated

      public void setIsDeprecated(boolean deprecated)
      Set whether the valid value is deprecated or not. Default is false.
      Parameters:
      deprecated - boolean flag

    • toString

      public String toString()
      Generate a string containing the properties.
      Overrides:
      toString in class AssetOwnerOMASAPIRequestBody
      Returns:
      string value

    • 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