import { IPSAppDEField } from '../../app/dataentity/ipsapp-defield';
import { IPSSearchBarObject } from './ipssearch-bar-object';
import { IPSLanguageRes } from '../../res/ipslanguage-res';
import { IPSSysCss } from '../../res/ipssys-css';
import { IPSSysImage } from '../../res/ipssys-image';

/**
 *
 * @export
 * @interface IPSSearchBarItem
 */
export interface IPSSearchBarItem extends IPSSearchBarObject {
  /**
   * 标题多语言资源对象
   *
   * @type {IPSLanguageRes}
   */
  getCapPSLanguageRes(): IPSLanguageRes | null;

  /**
   * 标题多语言资源对象
   *
   * @type {IPSLanguageRes}
   */
  get capPSLanguageRes(): IPSLanguageRes | null;

  /**
   * 标题多语言资源对象（必须存在）
   *
   * @type {IPSLanguageRes}
   */
  getCapPSLanguageResMust(): IPSLanguageRes;

  /**
   * 标题
   * @type {string}
   */
  caption: string;

  /**
   * 项数据
   * @type {string}
   */
  data: string;

  /**
   * 动态样式表
   * @type {string}
   */
  dynaClass: string;

  /**
   * 项类型
   * @description 值模式 [搜索栏项类型] {FILTER：过滤项、 GROUP：分组项、 QUICKSEARCH：快速搜索项 }
   * @type {( string | 'FILTER' | 'GROUP' | 'QUICKSEARCH')}
   */
  itemType: string | 'FILTER' | 'GROUP' | 'QUICKSEARCH';

  /**
   * 标签直接样式
   * @type {string}
   */
  labelCssStyle: string;

  /**
   * 标签动态样式表
   * @type {string}
   */
  labelDynaClass: string;

  /**
   * 项样式表对象
   *
   * @type {IPSSysCss}
   */
  getLabelPSSysCss(): IPSSysCss | null;

  /**
   * 项样式表对象
   *
   * @type {IPSSysCss}
   */
  get labelPSSysCss(): IPSSysCss | null;

  /**
   * 项样式表对象（必须存在）
   *
   * @type {IPSSysCss}
   */
  getLabelPSSysCssMust(): IPSSysCss;

  /**
   * 应用实体属性
   *
   * @type {IPSAppDEField}
   */
  getPSAppDEField(): IPSAppDEField | null;

  /**
   * 应用实体属性
   *
   * @type {IPSAppDEField}
   */
  get psAppDEField(): IPSAppDEField | null;

  /**
   * 应用实体属性（必须存在）
   *
   * @type {IPSAppDEField}
   */
  getPSAppDEFieldMust(): IPSAppDEField;

  /**
   * 过滤项界面样式表
   *
   * @type {IPSSysCss}
   */
  getPSSysCss(): IPSSysCss | null;

  /**
   * 过滤项界面样式表
   *
   * @type {IPSSysCss}
   */
  get psSysCss(): IPSSysCss | null;

  /**
   * 过滤项界面样式表（必须存在）
   *
   * @type {IPSSysCss}
   */
  getPSSysCssMust(): IPSSysCss;

  /**
   * 项图片对象
   *
   * @type {IPSSysImage}
   */
  getPSSysImage(): IPSSysImage | null;

  /**
   * 项图片对象
   *
   * @type {IPSSysImage}
   */
  get psSysImage(): IPSSysImage | null;

  /**
   * 项图片对象（必须存在）
   *
   * @type {IPSSysImage}
   */
  getPSSysImageMust(): IPSSysImage;
}