Преглед изворни кода

修改接口注释;keywordSearchColumns成员变量改为private

sunyj пре 8 година
родитељ
комит
904e41c267

+ 1 - 1
search-api-b2b/src/main/java/com/uas/search/b2b/model/PageParams.java

@@ -23,7 +23,7 @@ public class PageParams implements Serializable {
 	/**
 	 * keyword模糊搜索的字段名称
 	 */
-	List<String> keywordSearchColumns;
+	private List<String> keywordSearchColumns;
 
 	private Map<String, Object> filters;
 	private Map<String, Object> notEqualFilters;

+ 33 - 9
search-api-b2b/src/main/java/com/uas/search/b2b/service/SearchService.java

@@ -259,15 +259,39 @@ public interface SearchService {
 	 * @param tableName
 	 *            不为空,单据类型
 	 * @param pageParams
-	 *            可为空,可能含有翻页信息,filters中可能有过滤信息,包括:1.状态、所属企业uu、其他状态(如已采纳、未采纳等),
-	 *            该部分参数的键为数据库表中相应的字段名称,值为字段对应的值,若值有多个,则使用
-	 *            {@link com.uas.search.b2b.model.MultiValue}
-	 *            ;2.开始时间(Long)、截止时间(Long), 这两个参数用于对时间范围进行筛选(包含开始和截止时间),键为
-	 *            {@link com.uas.search.b2b.util.SearchConstants}
-	 *            中的常量;3.排序方式(ArrayList(Sort)),键为
-	 *            {@link com.uas.search.b2b.util.SearchConstants}中的常量,值为List(
-	 *            {@link com.uas.search.b2b.model.Sort}
-	 *            )。notEqualFilters中进行排除过滤,键为数据库表中相应的字段名称,值为需排除的值
+	 *            可为空,翻页、过滤、排序、排除过滤等信息
+	 *            <p>
+	 *            关于过滤,通过键值对指定过滤条件,值的类型由键决定:
+	 *            </p>
+	 * 
+	 *            <table border=1 cellpadding=5 cellspacing=0 summary=
+	 *            "Fields and types">
+	 *            <tr>
+	 *            <th>Description</th>
+	 *            <th>Field</th>
+	 *            <th>Type</th>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>状态、所属企业uu、其他状态(如已采纳、未采纳等)</td>
+	 *            <td>键为数据库表中相应的字段名称</td>
+	 *            <td>值为字段对应的值,若值有多个,则使用
+	 *            {@link com.uas.search.b2b.model.MultiValue}</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>开始时间、截止时间, 这两个参数用于对时间范围进行筛选</td>
+	 *            <td>{@link com.uas.search.b2b.util.SearchConstants}</td>
+	 *            <td>Long</td>
+	 *            </tr>
+	 *            <tr>
+	 *            <td>排序方式</td>
+	 *            <td>{@link com.uas.search.b2b.util.SearchConstants}</td>
+	 *            <td>List({@link com.uas.search.b2b.model.Sort})</td>
+	 *            </tr>
+	 *            </table>
+	 * 
+	 *            <p>
+	 *            关于排除过滤,键为数据库表中相应的字段名称,值为需排除的值
+	 *            </p>
 	 * @return 单据id
 	 * @throws SearchException
 	 */