import { GlideQueryCondition } from "./GlideQueryCondition";
import {
  SafeTableField,
  SafeTableFieldKey,
} from "./_GlideRecordHelpers/SafeTableTypes";

/**
 * The scoped GlideAggregate class is an extension of GlideRecord and allows database aggregation (COUNT, SUM, MIN, MAX,
 * AVG) queries to be done. This can be helpful in creating customized reports or in calculations for calculated fields.
 * The GlideAggregate class works only on number fields. Since currency fields are strings, you can't use the
 * GlideAggregate class on currency fields
 */

export type GlideAggregate<T extends keyof Tables | string = string> = IGlideAggregate<T>;
export declare const GlideAggregate: IGlideAggregate;

interface IGlideAggregate<T extends keyof Tables | string = string> {
  // Construction and table setup
  new <T extends keyof Tables | string>(tableName: T): GlideAggregate<T>;

  // ScopedGlideAggregate
  _next(): boolean;
  _query<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
    field: F,
    value: V
  ): void;
  addNotNullQuery<F extends SafeTableFieldKey<T & string>>(
    fieldName: F
  ): GlideQueryCondition<T>;
  addNullQuery<F extends SafeTableFieldKey<T & string>>(fieldName: F): GlideQueryCondition<T>;
  addQuery<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
    name: F,
    operator: any,
    value: V
  ): GlideQueryCondition<T>;
  addSystemEncodedQuery(query: string): void;
  addSystemQuery<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
    name: F,
    operator: any,
    value: V
  ): GlideQueryCondition<T>;
  addUserEncodedQuery(query: string): void;
  addUserQuery<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
    name: F,
    operator: any,
    value: V
  ): GlideQueryCondition<T>;
  disableSecurityFeature(feature: string): void;
  enableSecurityFeature(feature: string): void;
  /**
   * Moves to the next record in the GlideAggregate
   */
  next(): boolean;
  hasNext(): boolean;
  query<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
    field: F,
    value: V
  ): void;
  query(): void;

  // GlideAggregate

  /**
   * Adds an aggregate
   */
  addAggregate(agg: string, name: string): void;
  addBizCalendarTrend<F extends SafeTableFieldKey<T & string>>(
    fieldName: F,
    bizCalendarSysId: string
  ): void;
  addBizCalendarTrendBase<F extends SafeTableFieldKey<T & string>>(
    fieldName: F,
    bizCalendarSysId: string
  ): void;
  addBizCalendarTrendIntersect(
    anotherCalendarSysId: string,
    overlapMode: string
  ): void;

  /**
   * Adds a query to the aggregate. Adds an encoded query to the other queries that may have been set for this aggregate
   */
  addEncodedQuery(query: string, enforceFieldACLs?: any): void;
  getEncodedQuery(): string;
  addHaving(arg1: string, arg2: string, arg3: string, arg4: string): void;
  addSystemOrderBy<F extends SafeTableFieldKey<T & string>>(name: F): void;

  /**
   * Sorts the aggregates into descending order based on the specified field
   */
  addSystemOrderByDesc<F extends SafeTableFieldKey<T & string>>(name: F): void;
  addTrend<F extends SafeTableFieldKey<T & string>>(
    fieldName: F,
    timeInterval: string,
    numUnits: number
  ): void;
  addUserOrderBy<F extends SafeTableFieldKey<T & string>>(name: F): void;

  /**
   * Sorts the aggregates into descending order based on the specified field
   */
  addUserOrderByDesc<F extends SafeTableFieldKey<T & string>>(name: F): void;
  /**
   * Gets the value of the specified aggregate
   */
  getAggregate(agg: string, name: string): string;

  /**
   * Gets the query necessary to return the current aggregate
   */
  getAggregateEncodedQuery(): string;
  getCount(): number;
  getQuery(): string;
  getTotal(agg: string, name: string): number;

  /**
   * Gets the value of a field
   */
  getValue<F extends SafeTableFieldKey<T & string>>(name: F): string;

  /**
   * Provides the name of a field to use in grouping the aggregates. May be called numerous times to set multiple
   * group fields
   */
  groupBy<F extends SafeTableFieldKey<T & string>>(name: F): void;
  isBizCalendarTrendFillGap(): boolean;

  /**
   * Orders the aggregates using the value of the specified field. The field will also be added to the group-by list
   */
  orderBy<F extends SafeTableFieldKey<T & string>>(name: F): void;

  /**
   * Sorts the aggregates based on the specified aggregate and field
   */
  orderByAggregate(agg: string, name: string): void;

  /**
   * Sorts the aggregates into descending order based on the specified field
   */
  orderByDesc<F extends SafeTableFieldKey<T & string>>(name: F): void;
  setAggregateWindow(firstRowWanted: number, lastRowWanted: number): void;
  setBizCalendarTrendFillGap(b: boolean): void;

  /**
   * Sets whether the results are to be grouped
   */
  setGroup(b: boolean): void;
  setGroupByFollowRef(b: boolean): void;
  setIntervalYearIncluded(b: boolean): void;
  setOrder(b: boolean): void;
  setOrderByFollowRef(b: boolean): void;

  /**
   * <p/>
   * Enables or disables session language join which allows GlideRecord and GlideAggregate
   * to work with translated fields before a query.
   * <p/>
   * <pre>
   * var ga = new GlideAggregate("cmn_department");
   * ga.enableSessionLanguageJoin();
   * ga.addQuery("name", "人力资源");
   * ga.addAggregate("count", null);
   * ga.query();
   * </pre>
   */
  enableSessionLanguageJoin(): void;

  // GlideRecord
  _get<F extends SafeTableFieldKey<T & string>, V extends SafeTableField<T & string, F & string>>(
    name: F,
    value?: V
  ): boolean;
  getTableName(): string;
  getRowCount(): number;
}