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

Class FindRequestBody

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    FindRequestBody()
    Default constructor
    FindRequestBody(FindRequestBody 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.
    org.odpi.openmetadata.frameworks.governanceaction.search.SearchClassifications
    getMatchClassifications()
    Return details about the classifications that need to be present/absent from the search request.
    List<String>
    getMetadataElementSubtypeNames()
    Return the list of valid subtypes that the returned metadata elements must belong to.
    String
    getMetadataElementTypeName()
    Return the type of metadata element 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
    setMatchClassifications(org.odpi.openmetadata.frameworks.governanceaction.search.SearchClassifications matchClassifications)
    Set up details about the classifications that need to be present/absent from the search request.
    void
    setMetadataElementSubtypeNames(List<String> metadataElementSubtypeNames)
    Set up the list of valid subtypes that the returned metadata elements must belong to.
    void
    setMetadataElementTypeName(String metadataElementTypeName)
    Set up the type of metadata element 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

    • FindRequestBody

      public FindRequestBody()
      Default constructor

    • FindRequestBody

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

  • Method Details

    • getMetadataElementTypeName

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

    • setMetadataElementTypeName

      public void setMetadataElementTypeName(String metadataElementTypeName)
      Set up the type of metadata element that the caller is searching for.
      Parameters:
      metadataElementTypeName - open metadata type name

    • getMetadataElementSubtypeNames

      public List<String> getMetadataElementSubtypeNames()
      Return the list of valid subtypes that the returned metadata elements must belong to.
      Returns:
      open metadata type names

    • setMetadataElementSubtypeNames

      public void setMetadataElementSubtypeNames(List<String> metadataElementSubtypeNames)
      Set up the list of valid subtypes that the returned metadata elements must belong to.
      Parameters:
      metadataElementSubtypeNames - open metadata type names

    • 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

    • getMatchClassifications

      public org.odpi.openmetadata.frameworks.governanceaction.search.SearchClassifications getMatchClassifications()
      Return details about the classifications that need to be present/absent from the search request.
      Returns:
      classification specification

    • setMatchClassifications

      public void setMatchClassifications(org.odpi.openmetadata.frameworks.governanceaction.search.SearchClassifications matchClassifications)
      Set up details about the classifications that need to be present/absent from the search request.
      Parameters:
      matchClassifications - classification 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