docs: add note

smsb-customer-manager-client/src/main/java/com/inspur/customer/client/inform/CommonInformService.java

@@ -10,7 +10,7 @@ import com.inspur.customer.object.inform.CommonInformCO;
 public interface CommonInformService {
 
     /**
-     * common inform
+     * common inform for some level like that:
      * @see com.inspur.customer.context.inform.InformLevelEnum#HINT
      * @see com.inspur.customer.context.inform.InformLevelEnum#INTERMEDIATE
      * @see com.inspur.customer.context.inform.InformLevelEnum#URGENT
@@ -33,7 +33,7 @@ public interface CommonInformService {
     void departmentLevelInform(CommonInformCO informCo);
 
     /**
-     * single inform method
+     * single inform method for some level like that:
      * @see com.inspur.customer.context.inform.InformLevelEnum#SINGLE_EMAIL
      * @see com.inspur.customer.context.inform.InformLevelEnum#SINGLE_NOTE
      * @param informCo informCo

smsb-customer-manager-client/src/main/java/com/inspur/customer/client/inform/InformMessageContentRecordService.java

@@ -4,6 +4,7 @@ import com.fasterxml.jackson.core.JsonProcessingException;
 import com.inspur.customer.object.inform.InformMessageContentRecordDto;
 
 /**
+ * message content record service
  * @author linwenhua
  * @date 2022-06-29 16:31
  **/
@@ -12,6 +13,7 @@ public interface InformMessageContentRecordService {
     /**
      * save content
      * @param informMessageContentRecordDto content record
+     * @throws JsonProcessingException json parse exception
      * @return content id
      */
     Long saveContentRecord(InformMessageContentRecordDto informMessageContentRecordDto) throws JsonProcessingException;

smsb-customer-manager-client/src/main/java/com/inspur/customer/client/inform/InformMessageRecordService.java

@@ -8,6 +8,7 @@ import com.inspur.customer.object.tenant.ExceptionInformStrategyCmd;
 import java.util.List;
 
 /**
+ * message send record service
  * @author linwenhua
  * @date 2022-06-29 16:31
  **/
@@ -18,9 +19,15 @@ public interface InformMessageRecordService {
      * @param users users
      * @param informStrategyCmd inform strategy
      * @param informMessageRecordDto message record
+     * @throws JsonProcessingException json parse exception
      * @return content id
      */
     Long saveRecord(List<KeycloakUserCO> users, ExceptionInformStrategyCmd informStrategyCmd, InformMessageRecordDto informMessageRecordDto) throws JsonProcessingException;
 
-    void updateRecord(Long contentId, Integer infromStatus);
+    /**
+     * update record
+     * @param contentId contentId
+     * @param informStatus status
+     */
+    void updateRecord(Long contentId, Integer informStatus);
 }

smsb-customer-manager-client/src/main/java/com/inspur/customer/object/inform/InformMessageRecordDto.java

@@ -6,6 +6,7 @@ import java.io.Serializable;
 import java.util.Map;
 
 /**
+ * message send record
  * @author linwenhua
  * @date 2022-06-29 16:35
  **/