com.kuangkie.fg.ImproveFGResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of carbon-derive-api Show documentation
carbon-derive-api
The newest version!
package com.kuangkie.fg;

import java.util.Collection;
import java.util.List;
import java.util.Map;

import com.kuangkie.common.FuseMessage;
import com.kuangkie.common.Message;
import com.kuangkie.context.RemoveRecordInfo;
import com.kuangkie.ops.RecordOps;
import com.kuangkie.ops.RecordRelationOps;
import com.kuangkie.rrc.record.FGRootRecord;


/**
 * 
 * @version: V1.0
 * 
 * @author: wangnq
 * 
 * @className: ImproveFGResult
 * 
 * @packageName: cho.carbon.fuse.fg
 * 
 * @description: 业务完善项的集合。在业务组件包的接口实现过程中，需要把更新的属性、建立或删除的关系、创建或删除的记录信息放入到类的对象中，
 *               控制器会从返回的对象中获取上述内容，并汇并到当前融合的记录容器中，供后续过程调用
 * 
 * @data: 2020年8月12日
 * 
 *
 */
public interface ImproveFGResult extends FetchFGResult {

	


	/**
	 * 
	 * @methodsName: setRelatedRecords
	 *
	 * @description: 设置一个记录集合，集合里的记录会被融合控制器添加到融合记录集中，并纳入到本次融合队列。
	 *               本方法为set族方法，调用后之前添加或设置的数据会被移除。
	 *
	 * @param relatedRecords
	 *
	 */
	public void setRelatedRecords(Collection relatedRecords) ;

	public Collection getRelatedRecords() ;

	/**
	 * 
	 * @methodsName: addRelatedRecord
	 *
	 * @description: 添加一条记录到关联记录集合，集合里的记录会被融合控制器添加到融合记录集中，并纳入到本次融合队列。
	 *
	 * @param generatedRecord
	 *
	 */
	public void addRelatedRecord(FGRootRecord generatedRecord);

	public RecordRelationOps getRelationOps();

	/**
	 * 
	 * @methodsName: setRelationOps
	 *
	 * @description: 设置一个关系操作对象。控制器会根据此关系操作对象，更新融合记录对象集合中的内容。
	 *               此处设置的关系操作对象只应包含对当前记录的操作。
	 *               修改非当前记录的关系，请调用putRelatedRecordRelationOps方法。
	 *               本方法为set族方法，调用后之前添加或设置的数据会被移除。
	 *
	 * @param recordRelationOps
	 *
	 */
	public void setRelationOps(RecordRelationOps recordRelationOps);

	public FuseMessage getFuseMessage() ;

	/**
	 * 
	 * @methodsName: setMessages
	 *
	 * @description: 设置一个消息集合。消息不仅可以用于记录业务过程也可以用于中断融合流程。
	 *               控制器会根据消息的类型，判断是否停止当前融合流程。返回的消息会更具配置返回给用户或持久化到数据库。
	 *               当有返回消息的级别大于REFUSE时，控制器会停止当前融合流程，并把消息内容反馈给用户。
	 *               本方法为set族方法，调用后之前添加或设置的数据会被移除。
	 * 
	 * @param messages
	 *
	 */
	public void setMessages(List messages);
	public boolean isSuccess();

	/**
	 * 
	 * @methodsName: removeRecord
	 *
	 * @description: 增加一个需要删除的记录信息。控制器会根据此删除信息，移除相关记录。
	 *
	 * @param removedRecordInfo
	 *
	 */
	public void putRemoveRecord(RemoveRecordInfo removedRecordInfo) ;
	public Map getRemoveRecordMap();


	/**
	 * 
	 * @methodsName: putRelatedRelationOps
	 *
	 * @description: 设置一个非当前记录的关系操作对象。修改当前记录关系请调用setRecordRelationOps方法。
	 *               调用此方法后，会覆盖之前设置的相同code的记录关系更新操作。
	 *
	 * @param relatedRelationOps
	 *
	 */
	public void putRelatedRelationOps(RecordRelationOps relatedRelationOps) ;

	public RecordRelationOps getRelatedRelationOps(String code);



	public Collection getRelatedRecordOps() ;

	public RecordOps getRelatedRecordOps(String code) ;

	/**
	 * 
	 * @methodsName: putRelatedRecordOps
	 *
	 * @description: 设置一个记录操作对象，控制器会根据对象属性信息更新并融合此对象的同一记录。修改更新当前记录请调用setHostRecord方法。
	 *               调用此方法后，会覆盖之前设置的相同code的记录更新信息。
	 *
	 * @param rootRecordOps
	 *
	 */
	public void putRelatedRecordOps(RecordOps rootRecordOps) ;
	
	public boolean equals(ImproveFGResult improveFGResult);

}