Package org.odpi.openmetadata.repositoryservices.rest.properties

Class RelationshipFindRequest

java.lang.Object
org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIRequest
org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIFindRequest
org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIPagedFindRequest
org.odpi.openmetadata.repositoryservices.rest.properties.TypeLimitedFindRequest
org.odpi.openmetadata.repositoryservices.rest.properties.SubtypeLimitedFindRequest
org.odpi.openmetadata.repositoryservices.rest.properties.InstanceFindRequest
org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipFindRequest
All Implemented Interfaces:
RequestIdService
Direct Known Subclasses:
RelationshipHistoricalFindRequest
public class RelationshipFindRequest extends InstanceFindRequest
RelationshipFindRequest restricts a find request to relationships linked with specific entities.

  • Constructor Details

    • RelationshipFindRequest

      public RelationshipFindRequest()
      Default constructor

    • RelationshipFindRequest

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

  • Method Details

    • 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

    • getEnd1EntityTypeGUID

      public String getEnd1EntityTypeGUID()
      Return the unique identifier of the type that the entity at end 1 of the relationship must belong to. This is an optional request - a null means that any type of entity is acceptable at end 1. It may be used on its own, without any end 1 entity guids, to match all relationships that have an entity of this type (or one of its subtypes) at end 1.
      Returns:
      type guid

    • setEnd1EntityTypeGUID

      public void setEnd1EntityTypeGUID(String end1EntityTypeGUID)
      Set up the unique identifier of the type that the entity at end 1 of the relationship must belong to.
      Parameters:
      end1EntityTypeGUID - type guid

    • 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

    • getEnd2EntityTypeGUID

      public String getEnd2EntityTypeGUID()
      Return the unique identifier of the type that the entity at end 2 of the relationship must belong to. This is an optional request - a null means that any type of entity is acceptable at end 2. It may be used on its own, without any end 2 entity guids, to match all relationships that have an entity of this type (or one of its subtypes) at end 2.
      Returns:
      type guid

    • setEnd2EntityTypeGUID

      public void setEnd2EntityTypeGUID(String end2EntityTypeGUID)
      Set up the unique identifier of the type that the entity at end 2 of the relationship must belong to.
      Parameters:
      end2EntityTypeGUID - type guid

    • 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()
      Standard toString method.
      Overrides:
      toString in class InstanceFindRequest
      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 InstanceFindRequest
      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 InstanceFindRequest
      Returns:
      int hash code