Package org.odpi.openmetadata.frameworks.openmetadata.properties

Class FindProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.FindProperties
Direct Known Subclasses:
DataFieldQueryProperties, FindAssetOriginProperties, FindNameProperties, FindPropertyNamesProperties, LevelIdentifierProperties
public class FindProperties extends Object
FindProperties provides the base class for find by property requests.

  • Constructor Details

    • FindProperties

      public FindProperties()
      Default constructor

    • FindProperties

      public FindProperties(FindProperties template)
      Copy/clone constructor. Retrieve values from the supplied template
      Parameters:
      template - element to copy

  • Method Details

    • getOpenMetadataTypeName

      public String getOpenMetadataTypeName()
      Return the open metadata type name to filter by.
      Returns:
      string name

    • setOpenMetadataTypeName

      public void setOpenMetadataTypeName(String openMetadataTypeName)
      Set up the open metadata type name to filer by.
      Parameters:
      openMetadataTypeName - string name

    • getEffectiveTime

      public Date getEffectiveTime()
      Return the date/time to use for the query.
      Returns:
      date object

    • setEffectiveTime

      public void setEffectiveTime(Date effectiveTime)
      Set up the date/time to use for the query.
      Parameters:
      effectiveTime - date object

    • 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

    • getLimitResultsByStatus

      public List<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<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.

    • 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 SequencingOrder getSequencingOrder()
      Return the order that the results should be returned in.
      Returns:
      enum for the sequencing order

    • setSequencingOrder

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

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

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