/*
 * QQQ - Low-code Application Framework for Engineers.
 * Copyright (C) 2021-2025.  Kingsrook, LLC
 * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
 * contact@kingsrook.com
 * https://github.com/Kingsrook/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.kingsrook.qbits.dataanalysis.result;


import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;


/*******************************************************************************
 ** Typed DistinctValuesRequest contract; independent of any presentation framework.
 *******************************************************************************/
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY)
public class DistinctValuesRequest implements AnalysisRequest
{
   private String tableName;
   private QQueryFilter filter;
   private Boolean exact = false;
   private String fieldName;
   private Integer page = 0;
   private Integer pageSize = 100;
   private String search;



   /*******************************************************************************
    ** Getter for tableName.
    *******************************************************************************/
   public String getTableName()
   {
      return (tableName);
   }



   /*******************************************************************************
    ** Fluent setter for tableName.
    *******************************************************************************/
   public DistinctValuesRequest withTableName(String tableName)
   {
      this.tableName = tableName;
      return (this);
   }



   /*******************************************************************************
    ** Getter for filter.
    *******************************************************************************/
   public QQueryFilter getFilter()
   {
      return (filter);
   }



   /*******************************************************************************
    ** Fluent setter for filter.
    *******************************************************************************/
   public DistinctValuesRequest withFilter(QQueryFilter filter)
   {
      this.filter = filter;
      return (this);
   }



   /*******************************************************************************
    ** Getter for exact.
    *******************************************************************************/
   public Boolean getExact()
   {
      return (exact);
   }



   /*******************************************************************************
    ** Fluent setter for exact.
    *******************************************************************************/
   public DistinctValuesRequest withExact(Boolean exact)
   {
      this.exact = exact;
      return (this);
   }



   /*******************************************************************************
    ** Getter for fieldName.
    *******************************************************************************/
   public String getFieldName()
   {
      return (fieldName);
   }



   /*******************************************************************************
    ** Fluent setter for fieldName.
    *******************************************************************************/
   public DistinctValuesRequest withFieldName(String fieldName)
   {
      this.fieldName = fieldName;
      return (this);
   }



   /*******************************************************************************
    ** Getter for page.
    *******************************************************************************/
   public Integer getPage()
   {
      return (page);
   }



   /*******************************************************************************
    ** Fluent setter for page.
    *******************************************************************************/
   public DistinctValuesRequest withPage(Integer page)
   {
      this.page = page;
      return (this);
   }



   /*******************************************************************************
    ** Getter for pageSize.
    *******************************************************************************/
   public Integer getPageSize()
   {
      return (pageSize);
   }



   /*******************************************************************************
    ** Fluent setter for pageSize.
    *******************************************************************************/
   public DistinctValuesRequest withPageSize(Integer pageSize)
   {
      this.pageSize = pageSize;
      return (this);
   }



   /*******************************************************************************
    ** Getter for search.
    *******************************************************************************/
   public String getSearch()
   {
      return (search);
   }



   /*******************************************************************************
    ** Fluent setter for search.
    *******************************************************************************/
   public DistinctValuesRequest withSearch(String search)
   {
      this.search = search;
      return (this);
   }
}