Class SchemaTypeChoiceRequestBody

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaElementProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeChoiceProperties
org.odpi.openmetadata.commonservices.ffdc.rest.SchemaTypeChoiceRequestBody

public class SchemaTypeChoiceRequestBody extends org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeChoiceProperties
SchemaTypeChoiceRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability and the list of guids for the schema types that represent the choices.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Default constructor
    Copy/clone constructor.
    SchemaTypeChoiceRequestBody(org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeChoiceProperties template)
    Copy/clone constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Return comparison result based on the content of the properties.
    Return the unique identifier of the software server capability entity that represented the external source - null for local.
    Return the unique name of the software server capability entity that represented the external source.
    Return the list of schema types that describe the options.
    int
    Return hash code for this object
    void
    setExternalSourceGUID(String externalSourceGUID)
    Set up the unique identifier of the software server capability entity that represented the external source - null for local.
    void
    setExternalSourceName(String externalSourceName)
    Set up the unique name of the software server capability entity that represented the external source.
    void
    setSchemaTypeOptionGUIDs(List<String> schemaTypeOptionGUIDs)
    Set up the list of schema types that describe the options.
    JSON-style toString

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties

    getAuthor, getEncodingStandard, getFormula, getFormulaType, getNamespace, getQueries, getUsage, getVersionNumber, setAuthor, setEncodingStandard, setFormula, setFormulaType, setNamespace, setQueries, setUsage, setVersionNumber

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaElementProperties

    getDescription, getDisplayName, getIsDeprecated, setDescription, setDisplayName, setIsDeprecated

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties

    getAdditionalProperties, getQualifiedName, getVendorProperties, setAdditionalProperties, setQualifiedName, setVendorProperties

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties

    getEffectiveFrom, getEffectiveTo, getExtendedProperties, getTypeName, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setTypeName

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • SchemaTypeChoiceRequestBody

      public SchemaTypeChoiceRequestBody()
      Default constructor
    • SchemaTypeChoiceRequestBody

      public SchemaTypeChoiceRequestBody(SchemaTypeChoiceRequestBody template)
      Copy/clone constructor.
      Parameters:
      template - object to copy
    • SchemaTypeChoiceRequestBody

      public SchemaTypeChoiceRequestBody(org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeChoiceProperties template)
      Copy/clone constructor.
      Parameters:
      template - object to copy
  • Method Details

    • getExternalSourceGUID

      public String getExternalSourceGUID()
      Return the unique identifier of the software server capability entity that represented the external source - null for local.
      Returns:
      string guid
    • setExternalSourceGUID

      public void setExternalSourceGUID(String externalSourceGUID)
      Set up the unique identifier of the software server capability entity that represented the external source - null for local.
      Parameters:
      externalSourceGUID - string guid
    • getExternalSourceName

      public String getExternalSourceName()
      Return the unique name of the software server capability entity that represented the external source.
      Returns:
      string name
    • setExternalSourceName

      public void setExternalSourceName(String externalSourceName)
      Set up the unique name of the software server capability entity that represented the external source.
      Parameters:
      externalSourceName - string name
    • getSchemaTypeOptionGUIDs

      public List<String> getSchemaTypeOptionGUIDs()
      Return the list of schema types that describe the options.
      Returns:
      list of guids
    • setSchemaTypeOptionGUIDs

      public void setSchemaTypeOptionGUIDs(List<String> schemaTypeOptionGUIDs)
      Set up the list of schema types that describe the options.
      Parameters:
      schemaTypeOptionGUIDs - list of guids
    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeChoiceProperties
      Returns:
      return string containing the property names and values
    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison
    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties
      Returns:
      int hash code