金蝶云苍穹单据转换插件样例初使用

前置条件

必须有两张单据，例我做了两张单据采购申请单和采购订单
测试编码

package kd.bos.billzh.plugin;

import kd.bos.entity.BillEntityType;
import kd.bos.entity.botp.ConvertOpType;
import kd.bos.entity.botp.ConvertRuleElement;
import kd.bos.entity.botp.plugin.AbstractConvertPlugIn;
import kd.bos.entity.botp.plugin.args.AfterBuildQueryParemeterEventArgs;
import kd.bos.entity.botp.plugin.args.AfterConvertEventArgs;
import kd.bos.entity.botp.plugin.args.AfterCreateLinkEventArgs;
import kd.bos.entity.botp.plugin.args.AfterCreateTargetEventArgs;
import kd.bos.entity.botp.plugin.args.AfterFieldMappingEventArgs;
import kd.bos.entity.botp.plugin.args.AfterGetSourceDataEventArgs;
import kd.bos.entity.botp.plugin.args.BeforeBuildGroupModeEventArgs;
import kd.bos.entity.botp.plugin.args.BeforeBuildRowConditionEventArgs;
import kd.bos.entity.botp.plugin.args.BeforeCreateLinkEventArgs;
import kd.bos.entity.botp.plugin.args.BeforeCreateTargetEventArgs;
import kd.bos.entity.botp.plugin.args.BeforeGetSourceDataEventArgs;
import kd.bos.entity.botp.plugin.args.InitVariableEventArgs;

/**
 * <p>Title: </p>
 * <p>
 *    Description:
 *    演示单据转换插件事件的触发时机
 *    试验成功
 * </p>
 * <p>Copyright: Copyright (c) 2020</p>
 * @author xx
 * @date 2020年3月18日
 * @version 1.0
 */
public class BillConvertEventSample extends AbstractConvertPlugIn {
    /**
     * void</br>
     * 
     * <p>Title: </p>
     * <p>
     *    Description:
     * 演示如何获取上下文信息
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @return the bare_field_name
     * see_to_overridden
     * @version 1.0
     */
    private void getContext(){
        // 源单主实体
        BillEntityType srcMainType = this.getSrcMainType();
        // 目标单主实体
        BillEntityType tgtMainType = this.getTgtMainType();
        // 转换规则
        ConvertRuleElement rule = this.getRule();
        // 转换方式：下推、选单
        ConvertOpType opType = this.getOpType();
    }
    
    /**
     * <p>Title: </p>
     * <p>
     *    Description:
     * 初始化变量事件
     * 获取上下文信息，构建一些必须的变量
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.botp.plugin.IConvertPlugIn#initVariable(kd.bos.entity.botp.plugin.args.InitVariableEventArgs)
     * @version 1.0
     */
    @Override
    public void initVariable(InitVariableEventArgs e) {
        this.printEventInfo("initVariable", "");
    }
    
    /**
     * <p>Title: </p>
     * <p>
     *    Description:
     * 构建取数参数后事件
     * 添加额外的字段、过滤条件
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.botp.plugin.IConvertPlugIn#afterBuildQueryParemeter(kd.bos.entity.botp.plugin.args.AfterBuildQueryParemeterEventArgs)
     * @version 1.0
     */
    @Override
    public void afterBuildQueryParemeter(AfterBuildQueryParemeterEventArgs e) {
        this.printEventInfo("afterBuildQueryParemeter", "");
    }

    /**
     * <p>Title: </p>
     * <p>
     *    Description:
     * 编译数据筛选条件前事件
     * 设置忽略规则原生的条件，改用插件定制条件，或者在规则条件基础上，追加定制条件
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.botp.plugin.IConvertPlugIn#beforeBuildRowCondition(kd.bos.entity.botp.plugin.args.BeforeBuildRowConditionEventArgs)
     * @version 1.0
     */
    @Override
    public void beforeBuildRowCondition(BeforeBuildRowConditionEventArgs e) {
        this.printEventInfo("beforeBuildRowCondition", "");
    }

    /**
     * <p>Title: </p>
     * <p>
     *    Description:
     * 取源单数据前事件
     * 修改取数语句、取数条件
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.botp.plugin.IConvertPlugIn#beforeGetSourceData(kd.bos.entity.botp.plugin.args.BeforeGetSourceDataEventArgs)
     * @version 1.0
     */
    @Override
    public void beforeGetSourceData(BeforeGetSourceDataEventArgs e) {
        this.printEventInfo("beforeGetSourceData", "");
    }

    /**
     * <p>Title: </p>
     * <p>
     *    Description:
     * 取源单数据后事件
     * 根据源单数据，获取其他定制的引用数据；也可以替换系统自动获取到的数据
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.botp.plugin.IConvertPlugIn#afterGetSourceData(kd.bos.entity.botp.plugin.args.AfterGetSourceDataEventArgs)
     * @version 1.0
     */
    @Override
    public void afterGetSourceData(AfterGetSourceDataEventArgs e) {
        this.printEventInfo("afterGetSourceData", "");
    }

    /**
     * <p>Title: </p>
     * <p>
     *    Description:
     * 构建分单、行合并模式之前事件
     * 调整分单、合并策略及依赖的字段
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.botp.plugin.IConvertPlugIn#beforeBuildGroupMode(kd.bos.entity.botp.plugin.args.BeforeBuildGroupModeEventArgs)
     * @version 1.0
     */
    @Override
    public void beforeBuildGroupMode(BeforeBuildGroupModeEventArgs e) {
        this.printEventInfo("beforeBuildGroupMode", "");
    }
    
    /**
     * <p>Title: </p>
     * <p>
     *    Description:
     * 初始化创建目标单据数据包前事件
     * 这个事件，只在选单时触发：
     * 选单时，需要基于现有的目标单数据包，进行追加处理；
     * 插件可以在此事件，获取到现有的目标单数据包，提前进行定制处理
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.botp.plugin.IConvertPlugIn#beforeCreateTarget(kd.bos.entity.botp.plugin.args.BeforeCreateTargetEventArgs)
     * @version 1.0
     */
    @Override
    public void beforeCreateTarget(BeforeCreateTargetEventArgs e) {
        this.printEventInfo("beforeCreateTarget", "");
    }

    /**
     * <p>Title: </p>
     * <p>
     *    Description:
     * 创建目标单据数据包后事件
     * 这个事件，只在下推时触发，把根据分单规则创建好的目标单，传递给插件
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.botp.plugin.IConvertPlugIn#afterCreateTarget(kd.bos.entity.botp.plugin.args.AfterCreateTargetEventArgs)
     * @version 1.0
     */
    @Override
    public void afterCreateTarget(AfterCreateTargetEventArgs e) {
        this.printEventInfo("afterCreateTarget", "");
    }

    /**
     * <p>Title: </p>
     * <p>
     *    Description:
     * 目标字段赋值完毕后事件
     * 插件可以在此基础上，继续填写目标字段值
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.botp.plugin.IConvertPlugIn#afterFieldMapping(kd.bos.entity.botp.plugin.args.AfterFieldMappingEventArgs)
     * @version 1.0
     */
    @Override
    public void afterFieldMapping(AfterFieldMappingEventArgs e) {
        this.printEventInfo("afterFieldMapping", "");
    }

    /**
     * <p>Title: </p>
     * <p>
     *    Description:
     * 记录关联关系前事件
     * 取消记录关联关系
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.botp.plugin.IConvertPlugIn#beforeCreateLink(kd.bos.entity.botp.plugin.args.BeforeCreateLinkEventArgs)
     * @version 1.0
     */
    @Override
    public void beforeCreateLink(BeforeCreateLinkEventArgs e) {
        this.printEventInfo("beforeCreateLink", "");
    }

    /**
     * <p>Title: </p>
     * <p>
     *    Description:
     * 记录关联关系后事件
     * 根据系统自动记录的关联关系，进行相关数据的同步携带，如携带其他子单据体数据
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.botp.plugin.IConvertPlugIn#afterCreateLink(kd.bos.entity.botp.plugin.args.AfterCreateLinkEventArgs)
     * @version 1.0
     */
    @Override
    public void afterCreateLink(AfterCreateLinkEventArgs e) {
        this.printEventInfo("afterCreateLink", "");
    }

    /**
     * <p>Title: </p>
     * <p>
     *    Description:
     * 单据转换后事件，最后执行 
     * 插件可以在这个事件中，对生成的目标单数据，进行最后的修改
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.botp.plugin.IConvertPlugIn#afterConvert(kd.bos.entity.botp.plugin.args.AfterConvertEventArgs)
     * @version 1.0
     */
    @Override
    public void afterConvert(AfterConvertEventArgs e) {
        this.printEventInfo("afterConvert", "");
    }

    /**
     * void</br>
     * 
     * <p>Title: </p>
     * <p>
     *    Description:
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月18日
     * @param param the bare_field_name
     * @return the bare_field_name
     * @param eventName
     * @param argString
     * see_to_overridden
     * @version 1.0
     */
    private void printEventInfo(String eventName, String argString){
        String msg = String.format("%s : %s", eventName, argString);
        System.out.println(msg);
    }
}