import { IPSModelObject } from '../../ipsmodel-object';
import { IPSAppDEMethodInput } from './ipsapp-demethod-input';
import { IPSAppDEMethodReturn } from './ipsapp-demethod-return';
import { IPSAppDataEntityObject } from './ipsapp-data-entity-object';
import { IPSDEServiceAPIMethod } from '../../dataentity/service/ipsdeservice-apimethod';
import { IPSSysPFPlugin } from '../../res/ipssys-pfplugin';

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

  /**
   * 代码名称2
   * @type {string}
   */
  codeName2: string;

  /**
   * 方法类型
   * @description 值模式 [实体服务接口成员类型（应用实体方法类型）] {DEACTION：实体行为、 FETCH：实体数据集合、 SELECT：实体数据查询（SELECT）、 FETCHTEMP：实体数据集合（临时）、 SELECTTEMP：实体数据查询（SELECT）（临时）、 WFACTION：流程行为、 FILTERACTION：过滤器行为、 USER：用户自定义、 USER2：用户自定义2、 USER3：用户自定义3、 USER4：用户自定义4 }
   * @type {( string | 'DEACTION' | 'FETCH' | 'SELECT' | 'FETCHTEMP' | 'SELECTTEMP' | 'WFACTION' | 'FILTERACTION' | 'USER' | 'USER2' | 'USER3' | 'USER4')}
   */
  methodType: string | 'DEACTION' | 'FETCH' | 'SELECT' | 'FETCHTEMP' | 'SELECTTEMP' | 'WFACTION' | 'FILTERACTION' | 'USER' | 'USER2' | 'USER3' | 'USER4';

  /**
   * 方法输入对象
   *
   * @type {IPSAppDEMethodInput}
   */
  getPSAppDEMethodInput(): IPSAppDEMethodInput | null;

  /**
   * 方法输入对象
   *
   * @type {IPSAppDEMethodInput}
   */
  get psAppDEMethodInput(): IPSAppDEMethodInput | null;

  /**
   * 方法输入对象（必须存在）
   *
   * @type {IPSAppDEMethodInput}
   */
  getPSAppDEMethodInputMust(): IPSAppDEMethodInput;

  /**
   * 方法返回对象
   *
   * @type {IPSAppDEMethodReturn}
   */
  getPSAppDEMethodReturn(): IPSAppDEMethodReturn | null;

  /**
   * 方法返回对象
   *
   * @type {IPSAppDEMethodReturn}
   */
  get psAppDEMethodReturn(): IPSAppDEMethodReturn | null;

  /**
   * 方法返回对象（必须存在）
   *
   * @type {IPSAppDEMethodReturn}
   */
  getPSAppDEMethodReturnMust(): IPSAppDEMethodReturn;

  /**
   * 服务接口方法
   *
   * @type {IPSDEServiceAPIMethod}
   */
  getPSDEServiceAPIMethod(): IPSDEServiceAPIMethod | null;

  /**
   * 服务接口方法
   *
   * @type {IPSDEServiceAPIMethod}
   */
  get psDEServiceAPIMethod(): IPSDEServiceAPIMethod | null;

  /**
   * 服务接口方法（必须存在）
   *
   * @type {IPSDEServiceAPIMethod}
   */
  getPSDEServiceAPIMethodMust(): IPSDEServiceAPIMethod;

  /**
   * 前端扩展插件
   *
   * @type {IPSSysPFPlugin}
   */
  getPSSysPFPlugin(): IPSSysPFPlugin | null;

  /**
   * 前端扩展插件
   *
   * @type {IPSSysPFPlugin}
   */
  get psSysPFPlugin(): IPSSysPFPlugin | null;

  /**
   * 前端扩展插件（必须存在）
   *
   * @type {IPSSysPFPlugin}
   */
  getPSSysPFPluginMust(): IPSSysPFPlugin;

  /**
   * 请求属性
   * @type {string}
   */
  requestField: string;

  getRequestFullPaths(): string[] | null;

  get requestFullPaths(): string[] | null;

  /**
   * 请求方式
   * @description 值模式 [REST请求方式] {GET：GET、 HEAD：HEAD、 POST：POST、 PUT：PUT、 PATCH：PATCH、 DELETE：DELETE、 OPTIONS：OPTIONS、 TRACE：TRACE }
   * @type {( string | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'TRACE')}
   */
  requestMethod: string | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'TRACE';

  /**
   * 参数类型
   * @description 值模式 [服务请求参数类型] {NONE：无参数、 FIELD：指定属性、 FIELDS：指定属性数组、 ENTITY：数据对象、 ENTITIES：数据对象数组、 OBJECT：其它对象、 OBJECTS：其它对象数组 }
   * @type {( string | 'NONE' | 'FIELD' | 'FIELDS' | 'ENTITY' | 'ENTITIES' | 'OBJECT' | 'OBJECTS')}
   */
  requestParamType: string | 'NONE' | 'FIELD' | 'FIELDS' | 'ENTITY' | 'ENTITIES' | 'OBJECT' | 'OBJECTS';

  /**
   * 请求路径
   * @type {string}
   */
  requestPath: string;

  /**
   * 临时数据模式
   * @description 值模式 [平台部件处理器临时数据模式] {0：无临时数据模式、 1：主数据模式、 2：从数据模式 }
   * @type {( number | 0 | 1 | 2)}
   * @default 0
   */
  tempDataMode: number | 0 | 1 | 2;

  /**
   * 预置方法
   * @type {boolean}
   */
  builtinMethod: boolean;

  /**
   * 需要提供资源键值
   * @type {boolean}
   * @default false
   */
  needResourceKey: boolean;

  /**
   * 无服务代码标识
   * @type {boolean}
   * @default false
   */
  noServiceCodeName: boolean;
}