pmd规范

gic-data-cloud-api/src/main/java/com/gic/cloud/constants/FunctionEnum.java

@@ -7,14 +7,41 @@ package com.gic.cloud.constants;
  * @date 2020/7/7 4:15 PM

  */
 public enum FunctionEnum {
+    /**
+     * 排行榜
+     */
     RANK_LIST("FUC001", "排行榜"),
+    /**
+     * 会员概况
+     */
     MEMBER_PROFILE("FUC002", "会员概况"),
+    /**
+     * 招募分析
+     */
     RECRUITMENT_ANALYSIS("FUC003", "招募分析"),
+    /**
+     * 会员画像
+     */
     MEMBER_PORTRAIT("FUC004", "会员画像"),
+    /**
+     * 业绩概览
+     */
     PERFORMANCE_OVERVIEW("FUC005", "业绩概览"),
+    /**
+     * 消费构成
+     */
     CONSUME_COMPOSITION("FUC006", "消费构成"),
+    /**
+     * 单品排行
+     */
     ITEM_RANK("FUC007", "单品排行"),
+    /**
+     * 基础业绩
+     */
     BASIC_PERFORMANCE("FUC008", "基础业绩"),
+    /**
+     * 会员分布
+     */
     MEMBER_DISTRIBUTION("FUC009", "会员分布");
 
     private String code;

gic-data-cloud-api/src/main/java/com/gic/cloud/constants/IndexTypeEnum.java

 package com.gic.cloud.constants;
 
 /**
+ * 指标类型
  * @author zhiwj
  * @Description:
  * @date 2020-07-10 17:02
  */
 public enum IndexTypeEnum {
+    /**
+     * 指标
+     */
     INDEX(1, "指标"),
+    /**
+     * 唯独
+     */
     DIMENSION(2, "维度"),
+    /**
+     * 说明
+     */
     NOTE(3, "说明");
 
     private Integer code;

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/AccountGroupDTO.java

@@ -124,4 +124,9 @@ public class AccountGroupDTO implements Serializable{
         this.memberCount = memberCount;
         return this;
     }
+
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/AttentionStoreDTO.java

@@ -2,9 +2,12 @@ package com.gic.cloud.dto;
 
 import java.io.Serializable;
 import java.util.Date;
-
 /**
- * tab_attention_store
+ * 关注门店
+ * @ClassName: AttentionStoreDTO

+ * @Description: 

+ * @author guojuxing

+ * @date 2020/9/7 11:06 AM

  */
 public class AttentionStoreDTO implements Serializable {
     /**
@@ -97,4 +100,9 @@ public class AttentionStoreDTO implements Serializable {
     public void setUpdateTime(Date updateTime) {
         this.updateTime = updateTime;
     }
+
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }
\ No newline at end of file

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/DataAuthDTO.java

@@ -2,7 +2,13 @@ package com.gic.cloud.dto;
 
 import java.io.Serializable;
 import java.util.Date;
-
+/**
+ * 数据权限
+ * @ClassName: DataAuthDTO

+ * @Description: 

+ * @author guojuxing

+ * @date 2020/9/7 11:05 AM

+ */
 public class DataAuthDTO implements Serializable{
     private static final long serialVersionUID = -2015311334509633014L;
 
@@ -173,4 +179,9 @@ public class DataAuthDTO implements Serializable{
         this.noOwnerStore = noOwnerStore;
         return this;
     }
+
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/DataExplainDTO.java

@@ -145,4 +145,9 @@ public class DataExplainDTO implements Serializable {
     public void setOptUserName(String optUserName) {
         this.optUserName = optUserName;
     }
+
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/EnterprisePortraitRelDTO.java

@@ -2,7 +2,13 @@ package com.gic.cloud.dto;
 
 import java.io.Serializable;
 import java.util.Date;
-
+/**
+ * 会员画像
+ * @ClassName: EnterprisePortraitRelDTO

+ * @Description: 

+ * @author guojuxing

+ * @date 2020/9/7 11:06 AM

+ */
 public class EnterprisePortraitRelDTO implements Serializable{
     private static final long serialVersionUID = -2398088229114286442L;
 
@@ -128,4 +134,9 @@ public class EnterprisePortraitRelDTO implements Serializable{
         this.portraitName = portraitName;
         return this;
     }
+
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/FunctionDTO.java

@@ -124,4 +124,9 @@ public class FunctionDTO implements Serializable{
         this.memberCount = memberCount;
         return this;
     }
+
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/FunctionModuleDTO.java

@@ -149,4 +149,9 @@ public class FunctionModuleDTO implements Serializable{
         this.logo = logo;
         return this;
     }
+
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/IndexDTO.java

@@ -383,4 +383,9 @@ public class IndexDTO implements Serializable {
     public String getRelTopLevelName() {
         return relTopLevelName;
     }
+
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/IndexDescDTO.java

@@ -58,10 +58,6 @@ public class IndexDescDTO implements Serializable {
 
     private Integer updateTips;
 
-//    private Integer indexRemark;
-
-//    private Integer showStatus;
-
     private Integer indexDescEnterpriseId;
 
     private Integer updateTipsId;
@@ -69,7 +65,7 @@ public class IndexDescDTO implements Serializable {
     private Integer indexId;
 
     private String remark;
-    private int seq;
+    private Integer seq;
 
     public Integer getIndexDescId() {
         return indexDescId;
@@ -101,7 +97,8 @@ public class IndexDescDTO implements Serializable {
 
     public void setIndexCode(String indexCode) {
         this.indexCode = indexCode;
-        if("showSalesAmt".equals(this.indexCode)){
+        String amountField = "showSalesAmt";
+        if(amountField.equals(this.indexCode)){
             this.unit = "元";
         }
     }
@@ -209,4 +206,9 @@ public class IndexDescDTO implements Serializable {
     public void setIndexId(Integer indexId) {
         this.indexId = indexId;
     }
+
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/IndexGroupDTO.java

@@ -112,4 +112,9 @@ public class IndexGroupDTO implements Serializable {
     public void setChildList(List<IndexGroupDTO> childList) {
         this.childList = childList;
     }
+
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/IndexLogDTO.java

@@ -141,4 +141,8 @@ public class IndexLogDTO implements Serializable {
         this.type = type;
     }
 
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/TempStoreConditionDTO.java

@@ -95,4 +95,9 @@ public class TempStoreConditionDTO implements Serializable{
         this.updateTime = updateTime;
         return this;
     }
+
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/dto/UserDTO.java

@@ -177,4 +177,9 @@ public class UserDTO implements Serializable{
         this.memberCount = memberCount;
         return this;
     }
+
+    @Override
+    public String toString() {
+        return super.toString();
+    }
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/qo/DataExplainQO.java

@@ -7,7 +7,7 @@ import java.io.Serializable;
  * @Description:
  * @date 2020-07-08 10:13
  */
-public class DataExplainQO extends PageQO implements Serializable {
+public class DataExplainQo extends PageQo implements Serializable {
     private static final long serialVersionUID = 5687670215343610800L;
 
     private String search;

gic-data-cloud-api/src/main/java/com/gic/cloud/qo/IndexQO.java

@@ -8,7 +8,7 @@ import java.util.List;
  * @Description:
  * @date 2020-07-08 10:13
  */
-public class IndexQO extends PageQO implements Serializable {
+public class IndexQo extends PageQo implements Serializable {
     private static final long serialVersionUID = 5687670215343610800L;
 
     private Integer classifyType;

gic-data-cloud-api/src/main/java/com/gic/cloud/qo/PageQO.java

@@ -4,12 +4,12 @@ import java.io.Serializable;
 
 /**
  * 分页数据
- * @ClassName: PageQO

+ * @ClassName: PageQo
  * @Description: 

  * @author guojuxing

  * @date 2019/8/13 11:29 AM

  */
-public class PageQO implements Serializable {
+public class PageQo implements Serializable {
     private static final long serialVersionUID = 1L;
 
     /**

gic-data-cloud-api/src/main/java/com/gic/cloud/qo/UserQO.java

 package com.gic.cloud.qo;
 
 import java.io.Serializable;
-
-public class UserQO extends PageQO implements Serializable{
+/**
+ * 用户查询参数
+ * @ClassName: UserQo
+ * @Description: 

+ * @author guojuxing

+ * @date 2020/9/7 11:22 AM

+ */
+public class UserQo extends PageQo implements Serializable{
     private static final long serialVersionUID = -2145306520376748998L;
 
     /**
@@ -31,7 +37,7 @@ public class UserQO extends PageQO implements Serializable{
         return search;
     }
 
-    public UserQO setSearch(String search) {
+    public UserQo setSearch(String search) {
         this.search = search;
         return this;
     }
@@ -40,7 +46,7 @@ public class UserQO extends PageQO implements Serializable{
         return enterpriseId;
     }
 
-    public UserQO setEnterpriseId(Integer enterpriseId) {
+    public UserQo setEnterpriseId(Integer enterpriseId) {
         this.enterpriseId = enterpriseId;
         return this;
     }
@@ -49,7 +55,7 @@ public class UserQO extends PageQO implements Serializable{
         return accountGroupId;
     }
 
-    public UserQO setAccountGroupId(Integer accountGroupId) {
+    public UserQo setAccountGroupId(Integer accountGroupId) {
         this.accountGroupId = accountGroupId;
         return this;
     }
@@ -58,7 +64,7 @@ public class UserQO extends PageQO implements Serializable{
         return dataAuthId;
     }
 
-    public UserQO setDataAuthId(Integer dataAuthId) {
+    public UserQo setDataAuthId(Integer dataAuthId) {
         this.dataAuthId = dataAuthId;
         return this;
     }
@@ -67,7 +73,7 @@ public class UserQO extends PageQO implements Serializable{
         return functionAuthId;
     }
 
-    public UserQO setFunctionAuthId(Integer functionAuthId) {
+    public UserQo setFunctionAuthId(Integer functionAuthId) {
         this.functionAuthId = functionAuthId;
         return this;
     }

gic-data-cloud-api/src/main/java/com/gic/cloud/service/AccountGroupApiService.java

@@ -23,6 +23,14 @@ public interface AccountGroupApiService {
     
*/
     ServiceResponse<Integer> saveAccountGroup(AccountGroupDTO dto);
 
+    /**
+     * 编辑账号分组
+     * @Title: editAccountGroup

+     * @Description:
+    
* @author guojuxing
+     * @param dto

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Void>

+    
*/
     ServiceResponse<Void> editAccountGroup(AccountGroupDTO dto);
 
     /**
@@ -46,5 +54,13 @@ public interface AccountGroupApiService {
     
*/
     ServiceResponse<List<AccountGroupDTO>> listAccountGroupOfCountMember(Integer enterpriseId);
 
+    /**
+     * 删除账号分组
+     * @Title: deleteAccountGroup

+     * @Description:
+    
* @author guojuxing
+     * @param accountGroupId

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Void>

+    
*/
     ServiceResponse<Void> deleteAccountGroup(Integer accountGroupId);
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/service/DataAuthApiService.java

@@ -5,20 +5,87 @@ import com.gic.api.base.commons.ServiceResponse;
 import com.gic.cloud.dto.DataAuthDTO;
 
 import java.util.List;
-
+/**
+ * 数据权限
+ * @ClassName: DataAuthApiService

+ * @Description: 

+ * @author guojuxing

+ * @date 2020/9/7 11:13 AM

+ */
 public interface DataAuthApiService {
 
+    /**
+     * 新增数据权限
+     * @Title: saveDataAuth

+     * @Description:
+    
* @author guojuxing
+     * @param dto

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Integer>

+    
*/
     ServiceResponse<Integer> saveDataAuth(DataAuthDTO dto);
 
+    /**
+     * 编辑权限
+     * @Title: editDataAuth

+     * @Description:
+    
* @author guojuxing
+     * @param dto

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Void>

+    
*/
     ServiceResponse<Void> editDataAuth(DataAuthDTO dto);
 
+    /**
+     * 单条
+     * @Title: getDataAuth

+     * @Description:
+    
* @author guojuxing
+     * @param dataAuthId

+     * @return  com.gic.api.base.commons.ServiceResponse<com.gic.cloud.dto.DataAuthDTO>

+    
*/
     ServiceResponse<DataAuthDTO> getDataAuth(Integer dataAuthId);
 
+    /**
+     * 删除
+     * @Title: deleteDataAuth

+     * @Description:
+    
* @author guojuxing
+     * @param dataAuthId

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Void>

+    
*/
     ServiceResponse<Void> deleteDataAuth(Integer dataAuthId);
 
+    /**
+     * 分页查询数据权限
+     * @Title: pageDataAuth

+     * @Description:
+    
* @author guojuxing
+     * @param enterpriseId
+     * @param dataAuthName
+     * @param currentPage
+     * @param pageSize

+     * @return  com.gic.api.base.commons.ServiceResponse<com.gic.api.base.commons.Page<com.gic.cloud.dto.DataAuthDTO>>

+    
*/
     ServiceResponse<Page<DataAuthDTO>> pageDataAuth(Integer enterpriseId, String dataAuthName, Integer currentPage, Integer pageSize);
 
+    /**
+     * 查询数据权限
+     * @Title: listDataAuth

+     * @Description:
+    
* @author guojuxing
+     * @param enterpriseId
+     * @param dataAuthName

+     * @return  com.gic.api.base.commons.ServiceResponse<java.util.List<com.gic.cloud.dto.DataAuthDTO>>

+    
*/
     ServiceResponse<List<DataAuthDTO>> listDataAuth(Integer enterpriseId, String dataAuthName);
 
+    /**
+     * 查询单条
+     * @Title: ggetDataAuthByUserId

+     * @Description:
+    
* @author guojuxing
+     * @param enterpriseId
+     * @param userId

+     * @return  com.gic.api.base.commons.ServiceResponse<com.gic.cloud.dto.DataAuthDTO>

+    
*/
     ServiceResponse<DataAuthDTO> ggetDataAuthByUserId(Integer enterpriseId, Integer userId);
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/service/DataExplainApiService.java

@@ -3,7 +3,7 @@ package com.gic.cloud.service;
 import com.gic.api.base.commons.Page;
 import com.gic.api.base.commons.ServiceResponse;
 import com.gic.cloud.dto.DataExplainDTO;
-import com.gic.cloud.qo.DataExplainQO;
+import com.gic.cloud.qo.DataExplainQo;
 
 import java.util.List;
 
@@ -15,6 +15,7 @@ import java.util.List;
 public interface DataExplainApiService {
 
     /**
+     * 新增数据解读
      * @Title: saveDataExplain
      * @Description:
      * @author zhiwj
@@ -25,25 +26,31 @@ public interface DataExplainApiService {
     ServiceResponse<Void> saveDataExplain(DataExplainDTO dataExplainDTO);
     
     /**
+     * 编辑数据解读
      * @Title: updateDataExplain
      * @Description: 
      * @author zhiwj 
      * @param dataExplainDTO
+     * @param updateType
+     * @param reason
      * @return com.gic.api.base.commons.ServiceResponse<java.lang.Void>
      * @throws 
      */
     ServiceResponse<Void> updateDataExplain(DataExplainDTO dataExplainDTO, Integer updateType, String reason);
 
     /**
+     * 数据解读
      * @Title: getByDataExplainId
      * @Description: 
      * @author zhiwj
+     * @param dataExplainId
      * @return com.gic.api.base.commons.ServiceResponse<com.gic.cloud.dto.DataExplainDTO>
      * @throws 
      */
     ServiceResponse<DataExplainDTO> getByDataExplainId(Integer dataExplainId);
 
     /**
+     * 分页查询数据解读
      * @Title: listDataExplain
      * @Description:
      * @author zhiwj
@@ -51,9 +58,10 @@ public interface DataExplainApiService {
      * @return com.gic.api.base.commons.ServiceResponse<java.util.List<com.gic.cloud.dto.DataExplainDTO>>
      * @throws
      */
-    ServiceResponse<Page<DataExplainDTO>> listDataExplain(DataExplainQO dataExplainQO);
+    ServiceResponse<Page<DataExplainDTO>> listDataExplain(DataExplainQo dataExplainQO);
     
     /**
+     * 查询数据解读
      * @Title: listDataExplain
      * @Description: 
      * @author zhiwj 
@@ -64,6 +72,7 @@ public interface DataExplainApiService {
     ServiceResponse<List<DataExplainDTO>> listAllDataExplain();
 
     /**
+     * 删除数据解读
      * @Title: delete
      * @Description:
      * @author zhiwj
@@ -74,6 +83,7 @@ public interface DataExplainApiService {
     ServiceResponse<Void> delete(Integer dataExplainId);
 
     /**
+     * 发布数据解读
      * @Title: publish
      * @Description:
      * @author zhiwj
@@ -88,6 +98,7 @@ public interface DataExplainApiService {
     ServiceResponse<Void> publish(List<Integer> dataExplainIdList, Integer updateType, String reason, Integer optUserId, String optUserName);
     
     /**
+     * 查询
      * @Title: listByModule
      * @Description: 
      * @author zhiwj 

gic-data-cloud-api/src/main/java/com/gic/cloud/service/EnterprisePortraitRelApiService.java

@@ -4,7 +4,13 @@ import com.gic.api.base.commons.ServiceResponse;
 import com.gic.cloud.dto.EnterprisePortraitRelDTO;
 
 import java.util.List;
-
+/**
+ * 会员画像
+ * @ClassName: EnterprisePortraitRelApiService

+ * @Description: 

+ * @author guojuxing

+ * @date 2020/9/7 11:22 AM

+ */
 public interface EnterprisePortraitRelApiService {
 
     /**
@@ -29,6 +35,17 @@ public interface EnterprisePortraitRelApiService {
     
*/
     ServiceResponse<Void> insertForeach(List<EnterprisePortraitRelDTO> list);
 
+    /**
+     * 会员画像
+     * @Title: savePortraitField

+     * @Description:
+    
* @author guojuxing
+     * @param enterpriseId
+     * @param fieldCode
+     * @param fieldName
+     * @param dataType

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Void>

+    
*/
     ServiceResponse<Void> savePortraitField( Integer enterpriseId, String fieldCode, String fieldName, Integer dataType);
 
     /**

gic-data-cloud-api/src/main/java/com/gic/cloud/service/FunctionApiService.java

@@ -6,7 +6,13 @@ import com.gic.cloud.dto.FunctionDTO;
 import com.gic.cloud.dto.FunctionModuleDTO;
 
 import java.util.List;
-
+/**
+ * 功能接口
+ * @ClassName: FunctionApiService

+ * @Description: 

+ * @author guojuxing

+ * @date 2020/9/7 11:10 AM

+ */
 public interface FunctionApiService {
     /**
      * 新增功能权限集
@@ -18,15 +24,67 @@ public interface FunctionApiService {
     
*/
     ServiceResponse<Integer> saveFunction(FunctionDTO dto);
 
+    /**
+     * 编辑功能
+     * @Title: editFunction

+     * @Description:
+    
* @author guojuxing
+     * @param dto

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Void>

+    
*/
     ServiceResponse<Void> editFunction(FunctionDTO dto);
 
+    /**
+     * 删除功能
+     * @Title: deleteFunction

+     * @Description:
+    
* @author guojuxing
+     * @param functionId

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Void>

+    
*/
     ServiceResponse<Void> deleteFunction(Integer functionId);
 
+    /**
+     * 分页查询功能
+     * @Title: pageFunction

+     * @Description:
+    
* @author guojuxing
+     * @param enterpriseId
+     * @param functionName
+     * @param currentPage
+     * @param pageSize

+     * @return  com.gic.api.base.commons.ServiceResponse<com.gic.api.base.commons.Page<com.gic.cloud.dto.FunctionDTO>>

+    
*/
     ServiceResponse<Page<FunctionDTO>> pageFunction(Integer enterpriseId, String functionName, Integer currentPage, Integer pageSize);
 
+    /**
+     * 查询功能
+     * @Title: listFunction

+     * @Description:
+    
* @author guojuxing
+     * @param enterpriseId
+     * @param functionName

+     * @return  com.gic.api.base.commons.ServiceResponse<java.util.List<com.gic.cloud.dto.FunctionDTO>>

+    
*/
     ServiceResponse<List<FunctionDTO>> listFunction(Integer enterpriseId, String functionName);
 
+    /**
+     * 查询单条
+     * @Title: getFunction

+     * @Description:
+    
* @author guojuxing
+     * @param functionId

+     * @return  com.gic.api.base.commons.ServiceResponse<com.gic.cloud.dto.FunctionDTO>

+    
*/
     ServiceResponse<FunctionDTO> getFunction(Integer functionId);
 
+    /**
+     * 获取用户下的功能权限
+     * @Title: getFunctionByUserId

+     * @Description:
+    
* @author guojuxing
+     * @param userId

+     * @return  com.gic.api.base.commons.ServiceResponse<java.util.List<com.gic.cloud.dto.FunctionModuleDTO>>

+    
*/
     ServiceResponse<List<FunctionModuleDTO>> getFunctionByUserId(Integer userId);
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/service/FunctionModuleApiService.java

@@ -4,12 +4,42 @@ import com.gic.api.base.commons.ServiceResponse;
 import com.gic.cloud.dto.FunctionModuleDTO;
 
 import java.util.List;
-
+/**
+ * 功能模块
+ * @ClassName: FunctionModuleApiService

+ * @Description: 

+ * @author guojuxing

+ * @date 2020/9/7 11:11 AM

+ */
 public interface FunctionModuleApiService {
 
+    /**
+     * 新增功能模块
+     * @Title: saveFunctionModule

+     * @Description:
+    
* @author guojuxing
+     * @param dto

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Integer>

+    
*/
     ServiceResponse<Integer> saveFunctionModule(FunctionModuleDTO dto);
 
+    /**
+     * 编辑功能模块
+     * @Title: editFunctionModule

+     * @Description:
+    
* @author guojuxing
+     * @param dto

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Void>

+    
*/
     ServiceResponse<Void> editFunctionModule(FunctionModuleDTO dto);
 
+    /**
+     * 查询功能模块
+     * @Title: listFunctionModule

+     * @Description:
+    
* @author guojuxing
+     * @param search

+     * @return  com.gic.api.base.commons.ServiceResponse<java.util.List<com.gic.cloud.dto.FunctionModuleDTO>>

+    
*/
     ServiceResponse<List<FunctionModuleDTO>> listFunctionModule(String search);
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/service/IndexApiService.java

@@ -3,7 +3,7 @@ package com.gic.cloud.service;
 import com.gic.api.base.commons.Page;
 import com.gic.api.base.commons.ServiceResponse;
 import com.gic.cloud.dto.IndexDTO;
-import com.gic.cloud.qo.IndexQO;
+import com.gic.cloud.qo.IndexQo;
 
 import java.util.List;
 
@@ -15,6 +15,7 @@ import java.util.List;
 public interface IndexApiService {
 
     /**
+     * 新增指标
      * @Title: saveIndex
      * @Description:
      * @author zhiwj
@@ -25,16 +26,20 @@ public interface IndexApiService {
     ServiceResponse<Void> saveIndex(IndexDTO indexDTO);
 
     /**
+     * 编辑指标
      * @Title: editIndex
      * @Description:
      * @author zhiwj
      * @param indexDTO
+     * @param updateType
+     * @param reason
      * @return com.gic.api.base.commons.ServiceResponse<java.lang.Void>
      * @throws
      */
     ServiceResponse<Void> updateIndex(IndexDTO indexDTO, Integer updateType, String reason);
 
     /**
+     * 获取指标信息
      * @Title: getById
      * @Description:
      * @author zhiwj
@@ -45,24 +50,29 @@ public interface IndexApiService {
     ServiceResponse<IndexDTO> getByIndexId(Integer indexId);
 
     /**
+     * 分页查询指标
      * @Title: listIndex
      * @Description: 
      * @author zhiwj
+     * @param indexQO
      * @return com.gic.api.base.commons.ServiceResponse<java.util.List<com.gic.cloud.dto.IndexDTO>>
      * @throws 
      */
-    ServiceResponse<Page<IndexDTO>> listIndex(IndexQO indexQO);
+    ServiceResponse<Page<IndexDTO>> listIndex(IndexQo indexQO);
     
     /**
+     * 查询指标列表
      * @Title: listAllIndex
      * @Description: 
      * @author zhiwj
+     * @param indexQO
      * @return com.gic.api.base.commons.ServiceResponse<java.util.List<com.gic.cloud.dto.IndexDTO>>
      * @throws 
      */
-    ServiceResponse<List<IndexDTO>> listAllIndex(IndexQO indexQO);
+    ServiceResponse<List<IndexDTO>> listAllIndex(IndexQo indexQO);
 
     /**
+     * 删除指标
      * @Title: delete
      * @Description:
      * @author zhiwj
@@ -88,6 +98,7 @@ public interface IndexApiService {
     ServiceResponse<Void> publish(List<Integer> indexIdList, Integer updateType, String reason, Integer optUserId, String optUserName);
 
     /**
+     * 查询指标
      * @Title: listByModule
      * @Description: 
      * @author zhiwj 

gic-data-cloud-api/src/main/java/com/gic/cloud/service/IndexDescApiService.java

@@ -20,17 +20,21 @@ public interface IndexDescApiService {
      * @author zhiwj
      * @param enterpriseId
      * @param moduleId
+     * @param indexGroupName
      * @return com.gic.api.base.commons.ServiceResponse<java.lang.Void>
      * @throws
      */
     ServiceResponse<List<IndexDescDTO>> listByEnterpriseAndModule(Integer enterpriseId, String moduleId, String indexGroupName);
 
     /**
+     * 查询
      * @Title: listByEnterpriseAndModuleDetail
      * @Description:
      * @author zhiwj
      * @param enterpriseId
      * @param moduleId
+     * @param indexGroupName
+     * @param userId
      * @return com.gic.api.base.commons.ServiceResponse<com.gic.cloud.dto.IndexEnterpriseGroupDTO>
      * @throws
      */
@@ -43,6 +47,7 @@ public interface IndexDescApiService {
      * @author zhiwj
      * @param enterpriseId
      * @param moduleId
+     * @param indexGroupName
      * @param userId
      * @return com.gic.api.base.commons.ServiceResponse<com.gic.cloud.dto.IndexEnterpriseGroupDTO>
      * @throws
@@ -56,6 +61,7 @@ public interface IndexDescApiService {
      * @author zhiwj
      * @param enterpriseId 商户id
      * @param moduleId
+     * @param indexGroupName
      * @param indexDescEnterpriseId 指标id
      * @param seq 排到第几个
      * @return com.gic.api.base.commons.ServiceResponse<java.lang.Void>
@@ -68,16 +74,21 @@ public interface IndexDescApiService {
      * @Title: moveToRecycle
      * @Description:
      * @author zhiwj
-     * @param indexId
+     * @param indexDescEnterpriseId
      * @return com.gic.api.base.commons.ServiceResponse<java.lang.Void>
      * @throws
      */
     ServiceResponse<Void> moveToRecycle(Integer indexDescEnterpriseId);
 
     /**
+     * 查询
      * @Title: getIndexDesc
      * @Description:
      * @author zhiwj
+     * @param enterpriseId
+     * @param moduleId
+     * @param indexGroupName
+     * @param indexCode
      * @return com.gic.api.base.commons.ServiceResponse<com.gic.cloud.dto.IndexDescDTO>
      * @throws
      */
@@ -95,6 +106,7 @@ public interface IndexDescApiService {
     ServiceResponse<Void> batchUpdate(List<IndexDescDTO> descList);
 
     /**
+     * 批量更新
      * @Title: batchUpdate
      * @Description:
      * @author zhiwj
@@ -107,9 +119,12 @@ public interface IndexDescApiService {
     ServiceResponse<Void> batchUpdate(Integer enterpriseId, String moduleId, String ids);
 
     /**
+     * 置灰
      * @Title: eraseUpdateTips
      * @Description:
      * @author zhiwj
+     * @param userId
+     * @param updateTipsId
      * @return com.gic.api.base.commons.ServiceResponse<java.lang.Void>
      * @throws
      */
@@ -120,10 +135,19 @@ public interface IndexDescApiService {
      * @Title: listAll
      * @Description:
      * @author zhiwj
+     * @param moduleIds 
      * @return com.gic.api.base.commons.ServiceResponse<java.util.List<com.gic.cloud.dto.IndexDescDTO>>
      * @throws
      */
     ServiceResponse<List<IndexDescDTO>> listAllUnRel(String moduleIds);
 
+    /**
+     * 初始化
+     * @Title: init

+     * @Description:
+    
* @author zhiwj
+     * @param enterpriseId

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Void>

+    
*/
     ServiceResponse<Void> init(Integer enterpriseId);
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/service/IndexGroupApiService.java

@@ -13,6 +13,7 @@ import java.util.List;
 public interface IndexGroupApiService {
 
     /**
+     * 新增指标分组
      * @Title: save
      * @Description:
      * @author zhiwj
@@ -23,6 +24,7 @@ public interface IndexGroupApiService {
     ServiceResponse<Void> save(IndexGroupDTO indexGroupDTO);
 
     /**
+     * 更新指标分组
      * @Title: update
      * @Description:
      * @author zhiwj
@@ -33,6 +35,7 @@ public interface IndexGroupApiService {
     ServiceResponse<Void> update(IndexGroupDTO indexGroupDTO);
 
     /**
+     * 指标分组树结构
      * @Title: tree
      * @Description:
      * @author zhiwj
@@ -42,6 +45,7 @@ public interface IndexGroupApiService {
     ServiceResponse<List<IndexGroupDTO>> tree();
 
     /**
+     * 删除指标分组
      * @Title: delete
      * @Description:
      * @author zhiwj

gic-data-cloud-api/src/main/java/com/gic/cloud/service/IndexLogApiService.java

@@ -13,6 +13,7 @@ import java.util.List;
 public interface IndexLogApiService {
 
     /**
+     * 查询指标日志
      * @Title: listIndexLog
      * @Description:
      * @author zhiwj
@@ -23,6 +24,7 @@ public interface IndexLogApiService {
     ServiceResponse<List<IndexLogDTO>> listIndexLog(Integer indexId);
 
     /**
+     * 查询数据解读日志
      * @Title: listIndexLog
      * @Description:
      * @author zhiwj

gic-data-cloud-api/src/main/java/com/gic/cloud/service/StoreAttentionApiService.java

@@ -5,13 +5,59 @@ import com.gic.api.base.commons.ServiceResponse;
 import com.gic.cloud.dto.AttentionStoreDTO;
 
 import java.util.Map;
-
+/**
+ * 关注门店
+ * @ClassName: StoreAttentionApiService

+ * @Description: 

+ * @author boom

+ * @date 2020/9/7 11:18 AM

+ */
 public interface StoreAttentionApiService {
+    /**
+     * 新增关注门店
+     * @Title: addStoreAttenttion

+     * @Description:
+    
* @author boom
+     * @param userId
+     * @param enterpriseId
+     * @param storeId

+     * @return  com.gic.api.base.commons.ServiceResponse

+    
*/
     ServiceResponse addStoreAttenttion(Integer userId, Integer enterpriseId, Integer storeId);
 
+    /**
+     * 删除关注门店
+     * @Title: removeStoreAttenttion

+     * @Description:
+    
* @author boom
+     * @param enterpriseId
+     * @param userId
+     * @param storeIds

+     * @return  com.gic.api.base.commons.ServiceResponse

+    
*/
     ServiceResponse removeStoreAttenttion(Integer enterpriseId, Integer userId, String storeIds);
 
+    /**
+     * 分页查询关注门店
+     * @Title: pageStoreAttention

+     * @Description:
+    
* @author boom
+     * @param userId
+     * @param enterpriseId
+     * @param pageNum
+     * @param pageSize

+     * @return  com.gic.api.base.commons.ServiceResponse<com.gic.api.base.commons.Page<com.gic.cloud.dto.AttentionStoreDTO>>

+    
*/
     ServiceResponse<Page<AttentionStoreDTO>> pageStoreAttention(Integer userId, Integer enterpriseId, Integer pageNum, Integer pageSize);
 
+    /**
+     * 查询
+     * @Title: getAllAttenttionStore

+     * @Description:
+    
* @author boom
+     * @param userId
+     * @param enterpriseId

+     * @return  com.gic.api.base.commons.ServiceResponse<java.util.Map<java.lang.Integer,com.gic.cloud.dto.AttentionStoreDTO>>

+    
*/
     ServiceResponse<Map<Integer, AttentionStoreDTO>> getAllAttenttionStore(Integer userId, Integer enterpriseId);
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/service/TempStoreConditionApiService.java

@@ -2,11 +2,33 @@ package com.gic.cloud.service;
 
 import com.gic.api.base.commons.ServiceResponse;
 import com.gic.cloud.dto.TempStoreConditionDTO;
-
+/**
+ * 门店暂存区
+ * @ClassName: TempStoreConditionApiService

+ * @Description: 

+ * @author guojuxing

+ * @date 2020/9/7 11:15 AM

+ */
 public interface TempStoreConditionApiService {
 
+    /**
+     * 新增门店暂存区配置
+     * @Title: saveOrUpdateTempStoreCondition

+     * @Description:
+    
* @author guojuxing
+     * @param dto

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Integer>

+    
*/
     ServiceResponse<Integer> saveOrUpdateTempStoreCondition(TempStoreConditionDTO dto);
 
+    /**
+     * 获取门店暂存区配置信息
+     * @Title: getTempStoreCondition

+     * @Description:
+    
* @author guojuxing
+     * @param enterpriseId

+     * @return  com.gic.api.base.commons.ServiceResponse<com.gic.cloud.dto.TempStoreConditionDTO>

+    
*/
     ServiceResponse<TempStoreConditionDTO> getTempStoreCondition(Integer enterpriseId);
 
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/service/TestApiService.java

 package com.gic.cloud.service;
-
+/**test
+ * @ClassName: TestApiService

+ * @Description: 

+ * @author guojuxing

+ * @date 2020/9/7 11:22 AM

+ */
 public interface TestApiService {
 }

gic-data-cloud-api/src/main/java/com/gic/cloud/service/UserApiService.java

@@ -3,10 +3,16 @@ package com.gic.cloud.service;
 import com.gic.api.base.commons.Page;
 import com.gic.api.base.commons.ServiceResponse;
 import com.gic.cloud.dto.UserDTO;
-import com.gic.cloud.qo.UserQO;
+import com.gic.cloud.qo.UserQo;
 
 import java.util.List;
-
+/**
+ * 用户接口
+ * @ClassName: UserApiService

+ * @Description: 

+ * @author guojuxing

+ * @date 2020/9/7 11:09 AM

+ */
 public interface UserApiService {
 
     /**
@@ -29,6 +35,14 @@ public interface UserApiService {
     
*/
     ServiceResponse<Void> editUser(UserDTO dto);
 
+    /**
+     * 删除用户
+     * @Title: deleteUser

+     * @Description:
+    
* @author guojuxing
+     * @param userId

+     * @return  com.gic.api.base.commons.ServiceResponse<java.lang.Void>

+    
*/
     ServiceResponse<Void> deleteUser(Integer userId);
 
     /**
@@ -46,12 +60,20 @@ public interface UserApiService {
      * @Title: pageUser

      * @Description:
     
* @author guojuxing
-     * @param userQO

+     * @param userQo

      * @return  com.gic.api.base.commons.ServiceResponse<com.gic.api.base.commons.Page<com.gic.cloud.dto.UserDTO>>

     
*/
-    ServiceResponse<Page<UserDTO>> pageUser(UserQO userQO);
+    ServiceResponse<Page<UserDTO>> pageUser(UserQo userQo);
 
-    ServiceResponse<List<UserDTO>> listUser(UserQO userQO);
+    /**
+     * 用户列表数据
+     * @Title: listUser

+     * @Description:
+    
* @author guojuxing
+     * @param userQo

+     * @return  com.gic.api.base.commons.ServiceResponse<java.util.List<com.gic.cloud.dto.UserDTO>>

+    
*/
+    ServiceResponse<List<UserDTO>> listUser(UserQo userQo);
 
     /**
      * 批量转移分组
@@ -65,6 +87,7 @@ public interface UserApiService {
     ServiceResponse<Void> bulkTransferAccountGroup(List<Integer> userIdList, Integer targetAccountGroupId);
 
     /**
+     * 手机号查询用户
      * @Title: listUserByPhone

      * @Description:
     
* @author guojuxing
@@ -74,5 +97,13 @@ public interface UserApiService {
     
*/
     ServiceResponse<List<UserDTO>> listUserByPhone(String nationCode, String phone);
 
+    /**
+     * 获取用户
+     * @Title: getUser

+     * @Description:
+    
* @author guojuxing
+     * @param userId

+     * @return  com.gic.api.base.commons.ServiceResponse<com.gic.cloud.dto.UserDTO>

+    
*/
     ServiceResponse<UserDTO> getUser(Integer userId);
 }