update(REQ-2516) - 完善供业务方实现的接口的注释
This commit is contained in:
parent
07679910d3
commit
ec52b1ac68
@ -14,57 +14,57 @@ public interface MessageNotificationEventHandler extends Ordered {
|
||||
/**
|
||||
* 站内信推送
|
||||
*
|
||||
* @param messagePushDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void pushNotice(MessagePushDTO messagePushDTO) {
|
||||
default void pushNotice(MessagePushDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 待办推送
|
||||
*
|
||||
* @param messagePushDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void pushPending(MessagePushDTO messagePushDTO) {
|
||||
default void pushPending(MessagePushDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 完成待办
|
||||
*
|
||||
* @param messagePushDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void completePending(MessagePushDTO messagePushDTO) {
|
||||
default void completePending(MessagePushDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 审批失败，恢复待办
|
||||
*
|
||||
* @param messagePushDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void rollbackPending(MessagePushDTO messagePushDTO) {
|
||||
default void rollbackPending(MessagePushDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 抄送流程
|
||||
*
|
||||
* @param messagePushDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void carbonCopy(MessagePushDTO messagePushDTO) {
|
||||
default void carbonCopy(MessagePushDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 完成抄送
|
||||
*
|
||||
* @param messagePushDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void carbonCopyComplete(MessagePushDTO messagePushDTO) {
|
||||
default void carbonCopyComplete(MessagePushDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 短信推送
|
||||
*
|
||||
* @param messagePushDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void pushSms(MessagePushDTO messagePushDTO) {
|
||||
default void pushSms(MessagePushDTO dto) {
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ -19,32 +19,32 @@ public interface ProcessActivityEventHandler extends Ordered {
|
||||
/**
|
||||
* 节点已启动
|
||||
*
|
||||
* @param activityDTO 入参
|
||||
* @param dto 入参
|
||||
*/
|
||||
default void onStart(ProcessActivityDTO activityDTO) {
|
||||
default void onStart(ProcessActivityDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 节点等待业务指定审批人
|
||||
*
|
||||
* @param activityDTO 入参
|
||||
* @param dto 入参
|
||||
*/
|
||||
default void onWaitAssignee(ProcessActivityDTO activityDTO) {
|
||||
default void onWaitAssignee(ProcessActivityDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 节点已完成
|
||||
*
|
||||
* @param activityDTO 入参
|
||||
* @param dto 入参
|
||||
*/
|
||||
default void onTake(ProcessActivityDTO activityDTO) {
|
||||
default void onTake(ProcessActivityDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 节点已取消
|
||||
*
|
||||
* @param activityDTO 入参
|
||||
* @param dto 入参
|
||||
*/
|
||||
default void onEnd(ProcessActivityDTO activityDTO) {
|
||||
default void onEnd(ProcessActivityDTO dto) {
|
||||
}
|
||||
}
|
||||
|
||||
@ -16,17 +16,17 @@ public interface ProcessInstanceEventHandler extends Ordered {
|
||||
/**
|
||||
* 流程实例创建成功后回调
|
||||
*
|
||||
* @param processInstanceDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void onCreated(ProcessInstanceDTO instanceDTO) {
|
||||
default void onCreated(ProcessInstanceDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 流程实例开始运行后回调
|
||||
*
|
||||
* @param processInstanceDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void onStarted(ProcessInstanceDTO instanceDTO) {
|
||||
default void onStarted(ProcessInstanceDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
@ -34,9 +34,9 @@ public interface ProcessInstanceEventHandler extends Ordered {
|
||||
* <p>
|
||||
* 注意: 该接口表明流程已经走完正向逻辑，正向逻辑比如：通过、同意等
|
||||
*
|
||||
* @param instanceDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void onCompleted(ProcessInstanceDTO instanceDTO) {
|
||||
default void onCompleted(ProcessInstanceDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
@ -44,9 +44,9 @@ public interface ProcessInstanceEventHandler extends Ordered {
|
||||
* <p>
|
||||
* 撤回只有发起人能触发
|
||||
*
|
||||
* @param instanceDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void onCancelled(ProcessInstanceDTO instanceDTO) {
|
||||
default void onCancelled(ProcessInstanceDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
@ -54,9 +54,9 @@ public interface ProcessInstanceEventHandler extends Ordered {
|
||||
* <p>
|
||||
* 审批过程中，有一个审批人或者有节点配置的是“自动驳回”，都能触发该事件。
|
||||
*
|
||||
* @param instanceDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void onRejected(ProcessInstanceDTO instanceDTO) {
|
||||
default void onRejected(ProcessInstanceDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
@ -64,8 +64,8 @@ public interface ProcessInstanceEventHandler extends Ordered {
|
||||
* <p>
|
||||
* 一般由接入方主动触发，比如调用了 {@link ProcessInstanceApi#abortProcessInstance(BpmnProcessInstanceAbortDTO)} 方法等
|
||||
*
|
||||
* @param instanceDTO
|
||||
* @param dto
|
||||
*/
|
||||
default void onAborted(ProcessInstanceDTO instanceDTO) {
|
||||
default void onAborted(ProcessInstanceDTO dto) {
|
||||
}
|
||||
}
|
||||
|
||||
@ -16,13 +16,13 @@ public interface ProcessTaskEventHandler extends Ordered {
|
||||
/**
|
||||
* 用户任务已指派审核人
|
||||
*/
|
||||
default void onAssigned(ProcessTaskDTO taskDTO) {
|
||||
default void onAssigned(ProcessTaskDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 用户任务已创建,未指派审核人
|
||||
*/
|
||||
default void onCreated(ProcessTaskDTO taskDTO) {
|
||||
default void onCreated(ProcessTaskDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
@ -30,7 +30,7 @@ public interface ProcessTaskEventHandler extends Ordered {
|
||||
* <p>
|
||||
* 仅审核通过一个用户任务时触发, 如果任务是驳回了, 则直接走实例撤回事件
|
||||
*/
|
||||
default void onCompleted(ProcessTaskDTO taskDTO) {
|
||||
default void onCompleted(ProcessTaskDTO dto) {
|
||||
}
|
||||
|
||||
/**
|
||||
@ -38,6 +38,6 @@ public interface ProcessTaskEventHandler extends Ordered {
|
||||
* <p>
|
||||
* 删除不代表驳回或拒绝,因为通过也会走该事件
|
||||
*/
|
||||
default void onDeleted(ProcessTaskDTO taskDTO) {
|
||||
default void onDeleted(ProcessTaskDTO dto) {
|
||||
}
|
||||
}
|
||||
|
||||
@ -16,7 +16,7 @@ public interface BroadcastMessageQueueFilter extends Ordered {
|
||||
/**
|
||||
* @param message MQ 消息元数据
|
||||
* @param jsonData MQ 消息中的 payload，是 JSON 格式的字符串
|
||||
* @return
|
||||
* @return 返回 true 时，将<strong color=orange>跳过</strong>该 {@link MessageExt} 消息，不进行消费
|
||||
*/
|
||||
boolean doFilter(MessageExt message, String jsonData);
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
package cn.axzo.workflow.starter.mq.broadcast.filter;
|
||||
|
||||
import cn.axzo.framework.rocketmq.Event;
|
||||
import cn.axzo.framework.rocketmq.EventConsumer;
|
||||
import org.apache.rocketmq.common.message.MessageExt;
|
||||
import org.springframework.core.Ordered;
|
||||
|
||||
/**
|
||||
@ -15,10 +17,12 @@ public interface BasicMessageQueueFilter<T> extends Ordered {
|
||||
* 基于具体的 {@link Event.EventCode#module} 下的自定义的 MQ 过滤器
|
||||
*
|
||||
* @param event 事件原对象
|
||||
* @param context event 上下文对象，包含 msgId，headers 等信息，其中 headers 有 MQ 消息归属哪个应用，
|
||||
* 使用 {@code MQ_OWNERSHIP_APPLICATION} 获取值
|
||||
* @param data payload 被转换后的目标对象
|
||||
* @return
|
||||
* @return 返回 true 时，将<strong color=orange>跳过</strong>该 {@link Event} 消息，不进行消费
|
||||
*/
|
||||
default boolean doFilter(Event event, T data) {
|
||||
default boolean doFilter(Event event, EventConsumer.Context context, T data) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user