Package org.craftercms.studio.model.search

Class SearchParams

java.lang.Object
org.craftercms.studio.model.search.SearchParams
public class SearchParams extends Object
Holds the data needed to perform a search operation
Author:
joseross

  • Field Details

    • keywords

      protected String keywords
      Keywords to search in the files.

    • query

      protected String query
      Lucene query to execute.

    • path

      protected String path
      Regular expression to filter the paths

    • offset

      @PositiveOrZero protected @jakarta.validation.constraints.PositiveOrZero int offset
      The offset to paginate the results

    • limit

      @PositiveOrZero protected @jakarta.validation.constraints.PositiveOrZero int limit
      The limit to paginate the results

    • sortBy

      protected String sortBy
      The field to sort the results

    • sortOrder

      protected String sortOrder
      The order to sort the results

    • filters

      protected Map<String,Object> filters
      The filters to search the files

    • orOperator

      protected boolean orOperator
      Indicates if OR should be used instead of AND

    • additionalFields

      protected List<String> additionalFields
      List of additional fields to include for each item

  • Constructor Details

    • SearchParams

      public SearchParams()

  • Method Details

    • getKeywords

      public String getKeywords()

    • setKeywords

      public void setKeywords(String keywords)

    • getQuery

      public String getQuery()

    • setQuery

      public void setQuery(String query)

    • getPath

      public String getPath()

    • setPath

      public void setPath(String path)

    • getOffset

      public int getOffset()

    • setOffset

      public void setOffset(int offset)

    • getLimit

      public int getLimit()

    • setLimit

      public void setLimit(int limit)

    • getSortBy

      public String getSortBy()

    • setSortBy

      public void setSortBy(String sortBy)

    • getSortOrder

      public String getSortOrder()

    • setSortOrder

      public void setSortOrder(String sortOrder)

    • getFilters

      public Map<String,Object> getFilters()

    • setFilters

      public void setFilters(Map<String,Object> filters)

    • isOrOperator

      public boolean isOrOperator()

    • setOrOperator

      public void setOrOperator(boolean orOperator)

    • getAdditionalFields

      public List<String> getAdditionalFields()

    • setAdditionalFields

      public void setAdditionalFields(List<String> additionalFields)