Package org.odpi.openmetadata.frameworkservices.gaf.rest

Class FindRelationshipRequestBody

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody
org.odpi.openmetadata.frameworkservices.gaf.rest.FindRelationshipRequestBody
public class FindRelationshipRequestBody extends org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody
FindRelationshipRequestBody provides a structure for passing the properties for the find relationships request.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FindRelationshipRequestBody()
    Default constructor
    FindRelationshipRequestBody(FindRelationshipRequestBody template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Equals method that returns true if containing properties are the same.
    String
    getRelationshipTypeName()
    Return the type of relationship that the caller is searching for.
    org.odpi.openmetadata.frameworks.governanceaction.search.SearchProperties
    getSearchProperties()
    Return the details of the property values that must be true for the returned metadata elements.
    int
    hashCode()
    Return hash code for this object
    void
    setRelationshipTypeName(String relationshipTypeName)
    Set up the type of relationship that the caller is searching for.
    void
    setSearchProperties(org.odpi.openmetadata.frameworks.governanceaction.search.SearchProperties searchProperties)
    Set up the details of the property values that must be true for the returned metadata elements.
    String
    toString()
    JSON-style toString.

    Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody

    getAsOfTime, getEffectiveTime, getLimitResultsByStatus, getSequencingOrder, getSequencingProperty, setAsOfTime, setEffectiveTime, setLimitResultsByStatus, setSequencingOrder, setSequencingProperty

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • FindRelationshipRequestBody

      public FindRelationshipRequestBody()
      Default constructor

    • FindRelationshipRequestBody

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

  • Method Details

    • getRelationshipTypeName

      public String getRelationshipTypeName()
      Return the type of relationship that the caller is searching for.
      Returns:
      open metadata type name

    • setRelationshipTypeName

      public void setRelationshipTypeName(String relationshipTypeName)
      Set up the type of relationship that the caller is searching for.
      Parameters:
      relationshipTypeName - open metadata type name

    • getSearchProperties

      public org.odpi.openmetadata.frameworks.governanceaction.search.SearchProperties getSearchProperties()
      Return the details of the property values that must be true for the returned metadata elements.
      Returns:
      property specification

    • setSearchProperties

      public void setSearchProperties(org.odpi.openmetadata.frameworks.governanceaction.search.SearchProperties searchProperties)
      Set up the details of the property values that must be true for the returned metadata elements.
      Parameters:
      searchProperties - property specification

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody
      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 org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody
      Returns:
      int hash code