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

Class FindRequestBody

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.rest.FindRequestBody
public class FindRequestBody extends Object
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.
    Date
    getAsOfTime()
    Return the time used for a historical query - null mean current repository contents.
    List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus>
    getLimitResultsByStatus()
    Return the status values that the resulting metadata elements must match.
    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.
    org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder
    getSequencingOrder()
    Return the order that the results should be returned in.
    String
    getSequencingProperty()
    Return the name of the property whose value will be used to sequence the results.
    int
    hashCode()
    Return hash code for this object
    void
    setAsOfTime(Date asOfTime)
    Set up the time used for a historical query - null mean current repository contents.
    void
    setLimitResultsByStatus(List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus)
    Set up the status values that the resulting metadata elements must match.
    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.
    void
    setSequencingOrder(org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder)
    Set up the order that the results should be returned in.
    void
    setSequencingProperty(String sequencingProperty)
    Set up the name of the property whose value will be used to sequence the results.
    String
    toString()
    JSON-style toString.

    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

    • getLimitResultsByStatus

      public List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> getLimitResultsByStatus()
      Return the status values that the resulting metadata elements must match. By default, relationships in all non-DELETED statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values except DELETED.
      Returns:
      status values

    • setLimitResultsByStatus

      public void setLimitResultsByStatus(List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus)
      Set up the status values that the resulting metadata elements must match.
      Parameters:
      limitResultsByStatus - By default, relationships in all non-DELETED statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values except DELETED.

    • 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

    • getAsOfTime

      public Date getAsOfTime()
      Return the time used for a historical query - null mean current repository contents.
      Returns:
      date/time object

    • setAsOfTime

      public void setAsOfTime(Date asOfTime)
      Set up the time used for a historical query - null mean current repository contents.
      Parameters:
      asOfTime - date/time object

    • getSequencingProperty

      public String getSequencingProperty()
      Return the name of the property whose value will be used to sequence the results.
      Returns:
      property name

    • setSequencingProperty

      public void setSequencingProperty(String sequencingProperty)
      Set up the name of the property whose value will be used to sequence the results.
      Parameters:
      sequencingProperty - property name

    • getSequencingOrder

      public org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder getSequencingOrder()
      Return the order that the results should be returned in.
      Returns:
      enum for the sequencing order

    • setSequencingOrder

      public void setSequencingOrder(org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder)
      Set up the order that the results should be returned in.
      Parameters:
      sequencingOrder - enum for the sequencing order

    • toString

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

    • hashCode

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