Package org.odpi.openmetadata.accessservices.assetcatalog.model.rest.body

Class SearchParameters

java.lang.Object
org.odpi.openmetadata.accessservices.assetcatalog.model.rest.body.SearchParameters
All Implemented Interfaces:
Serializable
public class SearchParameters extends Object implements Serializable
SearchParameters provides a structure to make the assets' search results more precise.
See Also:

  • Constructor Details

    • SearchParameters

      public SearchParameters()

  • Method Details

    • getPageSize

      public Integer getPageSize()
      Return the maximum page pageSize supported by this server.
      Returns:
      max number of elements that can be returned on a request.

    • getFrom

      public Integer getFrom()
      Return the start from of the result set
      Returns:
      the start from of result

    • getLevel

      public Integer getLevel()
      Return the number of the relationships out from the starting entity that the query will traverse to gather results.
      Returns:
      number of the relationship

    • getSequencingProperty

      public String getSequencingProperty()
      Return the name of the property that is to be used to sequence the results
      Returns:
      the name of the property that is to be used to sequence the results

    • getSequencingOrder

      public SequencingOrder getSequencingOrder()
      Return the enum defining how the results should be ordered
      Returns:
      the enum defining how the results should be ordered

    • getLimitResultsByClassification

      public List<String> getLimitResultsByClassification()
      Returns the list of classifications that must be present on all returned entities.
      Returns:
      list of classifications that must be present on all returned entities.

    • getEntityTypes

      public List<String> getEntityTypes()
      Return the list of entity types name to search for. Null means any types.
      Returns:
      the list of entity types to search for

    • getRelationshipTypeGUIDs

      public List<String> getRelationshipTypeGUIDs()
      Return the list of relationship types to include in the query results. Null means include all relationships found, irrespective of their type.
      Returns:
      list of relationship types to include in the query results

    • getCaseInsensitive

      public boolean getCaseInsensitive()
      Returns whether the search should be performed as a case-insensitive regular expression (true) or as a case-sensitive regular expression (false)
      Returns:
      false if it is performed a case-insensitive search and true otherwise

    • getExactMatch

      public boolean getExactMatch()
      Returns whether the search should be performed taking into account and exact match criteria (true).
      Returns:
      false if it is performed an inexact match search and true otherwise

    • setPageSize

      public void setPageSize(Integer pageSize)
      Set up the pageSize the result set to only include the specified number of entries
      Parameters:
      pageSize - max number of elements that can be returned on a request.

    • setFrom

      public void setFrom(Integer from)
      Set up the start from of the result set for pagination
      Parameters:
      from - start from of the result set

    • setLevel

      public void setLevel(Integer level)
      Set up the number of the relationships out from the starting entity that the query will traverse to gather results.
      Parameters:
      level - the number of the relationships out from the starting entity

    • setSequencingProperty

      public void setSequencingProperty(String sequencingProperty)
      Set up the name of the property that is to be used to sequence the results
      Parameters:
      sequencingProperty - the name of the property that is to be used to sequence the results

    • setSequencingOrder

      public void setSequencingOrder(SequencingOrder sequencingOrder)
      Set up the enum defining how the results should be ordered
      Parameters:
      sequencingOrder - the enum defining how the results should be ordered

    • setLimitResultsByClassification

      public void setLimitResultsByClassification(List<String> limitResultsByClassification)
      Set up the list of classifications that must be present on all returned entities.
      Parameters:
      limitResultsByClassification - list of classifications that must be present on all returned entities.

    • setEntityTypes

      public void setEntityTypes(List<String> entityTypes)
      Set up the list of entity types name to search for. Null means any types.
      Parameters:
      entityTypes - the list of entity types to search for

    • setRelationshipTypeGUIDs

      public void setRelationshipTypeGUIDs(List<String> relationshipTypeGUIDs)
      Set up the list of relationship types to include in the query results. Null means include all relationships found, irrespective of their type.
      Parameters:
      relationshipTypeGUIDs - List of relationship types to include in the query results

    • setCaseInsensitive

      public void setCaseInsensitive(boolean caseInsensitive)
      Indicates whether the search should be performed as a case-insensitive regular expression (true) or as a case-sensitive regular expression (false)
      Parameters:
      caseInsensitive - boolean to set the case sensitivity for the search criteria

    • setExactMatch

      public void setExactMatch(boolean exactMatch)
      Indicates whether the search should be performed taking into account and exact match criteria (true)
      Parameters:
      exactMatch - boolean to set the exact match parameter for the search criteria

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object