Package org.odpi.openmetadata.accessservices.assetmanager.rest

Class ControlledGlossaryTermRequestBody

java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.rest.ControlledGlossaryTermRequestBody
public class ControlledGlossaryTermRequestBody extends Object
ControlledGlossaryTermRequestBody describes the request body used to create/update controlled glossary term properties.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ControlledGlossaryTermRequestBody()
    Default constructor
    ControlledGlossaryTermRequestBody(ControlledGlossaryTermRequestBody 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.
    Date
    getEffectiveTime()
    Return the date/time to use for the query.
    org.odpi.openmetadata.frameworks.openmetadata.properties.glossaries.GlossaryTermProperties
    getElementProperties()
    Return the properties for the element.
    org.odpi.openmetadata.frameworks.openmetadata.enums.GlossaryTermStatus
    getInitialStatus()
    Return the initial status for the controlled glossary term.
    org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationProperties
    getMetadataCorrelationProperties()
    Return the properties used to correlate the external metadata element with the open metadata element.
    String
    getUpdateDescription()
    Return the string that describes details of the update.
    int
    hashCode()
    Return hash code for this object
    void
    setEffectiveTime(Date effectiveTime)
    Set up the date/time to use for the query.
    void
    setElementProperties(org.odpi.openmetadata.frameworks.openmetadata.properties.glossaries.GlossaryTermProperties elementProperties)
    Set up the properties for the element.
    void
    setInitialStatus(org.odpi.openmetadata.frameworks.openmetadata.enums.GlossaryTermStatus initialStatus)
    Set up the initial status for the controlled glossary term.
    void
    setMetadataCorrelationProperties(org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationProperties metadataCorrelationProperties)
    Set up the properties used to correlate the external metadata element with the open metadata element.
    void
    setUpdateDescription(String updateDescription)
    Set up the string that describes details of the update.
    String
    toString()
    JSON-style toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ControlledGlossaryTermRequestBody

      public ControlledGlossaryTermRequestBody()
      Default constructor

    • ControlledGlossaryTermRequestBody

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

  • Method Details

    • getMetadataCorrelationProperties

      public org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationProperties getMetadataCorrelationProperties()
      Return the properties used to correlate the external metadata element with the open metadata element.
      Returns:
      properties object

    • setMetadataCorrelationProperties

      public void setMetadataCorrelationProperties(org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationProperties metadataCorrelationProperties)
      Set up the properties used to correlate the external metadata element with the open metadata element.
      Parameters:
      metadataCorrelationProperties - properties object

    • getElementProperties

      public org.odpi.openmetadata.frameworks.openmetadata.properties.glossaries.GlossaryTermProperties getElementProperties()
      Return the properties for the element.
      Returns:
      properties object

    • setElementProperties

      public void setElementProperties(org.odpi.openmetadata.frameworks.openmetadata.properties.glossaries.GlossaryTermProperties elementProperties)
      Set up the properties for the element.
      Parameters:
      elementProperties - properties object

    • getInitialStatus

      public org.odpi.openmetadata.frameworks.openmetadata.enums.GlossaryTermStatus getInitialStatus()
      Return the initial status for the controlled glossary term. By default it is "DRAFT".
      Returns:
      glossary term status enum

    • setInitialStatus

      public void setInitialStatus(org.odpi.openmetadata.frameworks.openmetadata.enums.GlossaryTermStatus initialStatus)
      Set up the initial status for the controlled glossary term. By default it is "DRAFT".
      Parameters:
      initialStatus - glossary term status enum

    • getEffectiveTime

      public Date getEffectiveTime()
      Return the date/time to use for the query.
      Returns:
      date object

    • setEffectiveTime

      public void setEffectiveTime(Date effectiveTime)
      Set up the date/time to use for the query.
      Parameters:
      effectiveTime - date object

    • getUpdateDescription

      public String getUpdateDescription()
      Return the string that describes details of the update.
      Returns:
      description

    • setUpdateDescription

      public void setUpdateDescription(String updateDescription)
      Set up the string that describes details of the update.
      Parameters:
      updateDescription - description

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Object
      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 Object
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

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