Package org.odpi.openmetadata.frameworkservices.omf.rest

Class FindRelationshipRequestBody

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions
org.odpi.openmetadata.frameworks.openmetadata.search.GetOptions
org.odpi.openmetadata.frameworks.openmetadata.search.PagingOptions
org.odpi.openmetadata.frameworks.openmetadata.search.QueryOptions
org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody
org.odpi.openmetadata.frameworkservices.omf.rest.FindRelationshipRequestBody
All Implemented Interfaces:
RequestIdService
public class FindRelationshipRequestBody extends ResultsRequestBody
FindRelationshipRequestBody provides a structure for passing the properties for the find relationships request.

  • Constructor Details

    • FindRelationshipRequestBody

      public FindRelationshipRequestBody()
      Default constructor

    • FindRelationshipRequestBody

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

    • FindRelationshipRequestBody

      public FindRelationshipRequestBody(QueryOptions 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

    • getRelationshipSubtypeNames

      public List<String> getRelationshipSubtypeNames()
      Return the subtype names to limit the results of the find request.
      Returns:
      List<String> open metadata type names

    • setRelationshipSubtypeNames

      public void setRelationshipSubtypeNames(List<String> relationshipSubtypeNames)
      Set up the subtype names to limit the results of the find request.
      Parameters:
      relationshipSubtypeNames - List<String> open metadata type names

    • getSearchProperties

      public 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(SearchProperties searchProperties)
      Set up the details of the property values that must be true for the returned metadata elements.
      Parameters:
      searchProperties - property specification

    • getEnd1EntityGUIDs

      public List<String> getEnd1EntityGUIDs()
      Return the list of entity guids used to match end 1 of the relationships.
      Returns:
      list of guids

    • setEnd1EntityGUIDs

      public void setEnd1EntityGUIDs(List<String> end1EntityGUIDs)
      Set up the list of entity guids used to match end 1 of the relationships.
      Parameters:
      end1EntityGUIDs - list of guids

    • getEnd1EntityTypeName

      public String getEnd1EntityTypeName()
      Return the name of the type that the entity at end 1 of the relationship must belong to. Subtypes of the named type match too. This is optional, and independent of the end 1 guids: naming the type on its own, with no guids, asks for the relationships that start at any entity of that type.
      Returns:
      type name

    • setEnd1EntityTypeName

      public void setEnd1EntityTypeName(String end1EntityTypeName)
      Set up the name of the type that the entity at end 1 of the relationship must belong to.
      Parameters:
      end1EntityTypeName - type name

    • getEnd2EntityGUIDs

      public List<String> getEnd2EntityGUIDs()
      Return the list of entity guids used to match end 2 of the relationships.
      Returns:
      list of guids

    • setEnd2EntityGUIDs

      public void setEnd2EntityGUIDs(List<String> end2EntityGUIDs)
      Set up the list of entity guids used to match end 2 of the relationships.
      Parameters:
      end2EntityGUIDs - list of guids

    • getEnd2EntityTypeName

      public String getEnd2EntityTypeName()
      Return the name of the type that the entity at end 2 of the relationship must belong to. Subtypes of the named type match too. This is optional, and independent of the end 2 guids: naming the type on its own, with no guids, asks for the relationships that end at any entity of that type.
      Returns:
      type name

    • setEnd2EntityTypeName

      public void setEnd2EntityTypeName(String end2EntityTypeName)
      Set up the name of the type that the entity at end 2 of the relationship must belong to.
      Parameters:
      end2EntityTypeName - type name

    • getEndMatchCriteria

      public EndMatchCriteria getEndMatchCriteria()
      Return the end matching search criteria.
      Returns:
      SearchClassifications

    • setEndMatchCriteria

      public void setEndMatchCriteria(EndMatchCriteria endMatchCriteria)
      Set the end matching search criteria.
      Parameters:
      endMatchCriteria - to set as search criteria

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class 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 QueryOptions
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

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