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

Class GlossaryTermRelationshipRequestBody

java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.rest.AssetManagerIdentifiersRequestBody
org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody
org.odpi.openmetadata.accessservices.assetmanager.rest.GlossaryTermRelationshipRequestBody
public class GlossaryTermRelationshipRequestBody extends EffectiveTimeQueryRequestBody
GlossaryTermRelationshipRequestBody is the request body structure used on Glossary REST API calls that request the retrieval of glossary term relationships. These relationships have a status field that can be used to filter the request.

  • Constructor Details

    • GlossaryTermRelationshipRequestBody

      public GlossaryTermRelationshipRequestBody()
      Default constructor

    • GlossaryTermRelationshipRequestBody

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

  • Method Details

    • getGlossaryGUID

      public String getGlossaryGUID()
      Return the unique identifier of the glossary scope.
      Returns:
      string guid

    • setGlossaryGUID

      public void setGlossaryGUID(String glossaryGUID)
      Set up the unique identifier of the glossary scope.
      Parameters:
      glossaryGUID - string

    • getRelationshipTypeName

      public String getRelationshipTypeName()
      Return the optional relationship name for this request. This value limits the types of relationships returned.
      Returns:
      string name

    • setRelationshipTypeName

      public void setRelationshipTypeName(String relationshipTypeName)
      Set up the optional relationship name for this request. This value limits the types of relationships returned.
      Parameters:
      relationshipTypeName - string name

    • getLimitResultsByStatus

      public List<GlossaryTermRelationshipStatus> getLimitResultsByStatus()
      Return the list of statuses to return (null for all).
      Returns:
      list of statuses (terms only)

    • setLimitResultsByStatus

      public void setLimitResultsByStatus(List<GlossaryTermRelationshipStatus> limitResultsByStatus)
      Set up the list of statuses to return (null for all).
      Parameters:
      limitResultsByStatus - list of statuses (terms only)

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class EffectiveTimeQueryRequestBody
      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 EffectiveTimeQueryRequestBody
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class EffectiveTimeQueryRequestBody
      Returns:
      int hash code