import { IPSDataEntity } from '../dataentity/ipsdata-entity';
import { IPSDEField } from '../dataentity/defield/ipsdefield';
import { IPSSysSFPlugin } from './ipssys-sfplugin';
import { IPSSystemModule } from '../system/ipssystem-module';
import { IPSModelObject } from '../ipsmodel-object';

/**
 *
 * 子接口类型识别属性[]
 * @export
 * @interface IPSSysTranslator
 */
export interface IPSSysTranslator extends IPSModelObject {
  /**
   * 代码标识
   * @type {string}
   */
  codeName: string;

  /**
   * 标识存储属性
   *
   * @type {IPSDEField}
   */
  getKeyPSDEField(): IPSDEField | null;

  /**
   * 标识存储属性
   *
   * @type {IPSDEField}
   */
  get keyPSDEField(): IPSDEField | null;

  /**
   * 标识存储属性（必须存在）
   *
   * @type {IPSDEField}
   */
  getKeyPSDEFieldMust(): IPSDEField;

  /**
   * 实体对象
   *
   * @type {IPSDataEntity}
   */
  getPSDataEntity(): IPSDataEntity | null;

  /**
   * 实体对象
   *
   * @type {IPSDataEntity}
   */
  get psDataEntity(): IPSDataEntity | null;

  /**
   * 实体对象（必须存在）
   *
   * @type {IPSDataEntity}
   */
  getPSDataEntityMust(): IPSDataEntity;

  /**
   * 后端模板插件对象
   *
   * @type {IPSSysSFPlugin}
   */
  getPSSysSFPlugin(): IPSSysSFPlugin | null;

  /**
   * 后端模板插件对象
   *
   * @type {IPSSysSFPlugin}
   */
  get psSysSFPlugin(): IPSSysSFPlugin | null;

  /**
   * 后端模板插件对象（必须存在）
   *
   * @type {IPSSysSFPlugin}
   */
  getPSSysSFPluginMust(): IPSSysSFPlugin;

  /**
   * 系统模块
   *
   * @type {IPSSystemModule}
   */
  getPSSystemModule(): IPSSystemModule | null;

  /**
   * 系统模块
   *
   * @type {IPSSystemModule}
   */
  get psSystemModule(): IPSSystemModule | null;

  /**
   * 系统模块（必须存在）
   *
   * @type {IPSSystemModule}
   */
  getPSSystemModuleMust(): IPSSystemModule;

  /**
   * 值转换器标记
   * @type {string}
   */
  translatorTag: string;

  /**
   * 值转换器标记2
   * @type {string}
   */
  translatorTag2: string;

  /**
   * 值转换器类型
   * @description 值模式 [系统值转换类型] {DIGEST：密码（不可逆）、 ENCRYPT：加密（可逆）、 DESTORAGE：实体扩展存储、 USER：用户自定义、 USER2：用户自定义2、 USER3：用户自定义3、 USER4：用户自定义4 }
   * @type {( string | 'DIGEST' | 'ENCRYPT' | 'DESTORAGE' | 'USER' | 'USER2' | 'USER3' | 'USER4')}
   */
  translatorType: string | 'DIGEST' | 'ENCRYPT' | 'DESTORAGE' | 'USER' | 'USER2' | 'USER3' | 'USER4';

  /**
   * 值存储属性
   *
   * @type {IPSDEField}
   */
  getValuePSDEField(): IPSDEField | null;

  /**
   * 值存储属性
   *
   * @type {IPSDEField}
   */
  get valuePSDEField(): IPSDEField | null;

  /**
   * 值存储属性（必须存在）
   *
   * @type {IPSDEField}
   */
  getValuePSDEFieldMust(): IPSDEField;
}