|
32 | 32 | */ |
33 | 33 | public interface AppVersionService { |
34 | 34 | /** |
35 | | - * 通过appId获取 {@link AppVersion}. |
| 35 | + * 通过appId获取 {@link AppVersion}。 |
36 | 36 | * |
37 | | - * @param appId app多版本中的唯一标识. |
38 | | - * @return {@link Optional}{@code <}{@link AppVersion}{@code >} 对象. |
| 37 | + * @param appId app多版本中的唯一标识。 |
| 38 | + * @return {@link Optional}{@code <}{@link AppVersion}{@code >} 对象。 |
39 | 39 | */ |
40 | 40 | Optional<AppVersion> getByAppId(String appId); |
41 | 41 |
|
42 | 42 | /** |
43 | | - * 通过path获取 {@link AppVersion}. |
| 43 | + * 通过path获取 {@link AppVersion}。 |
44 | 44 | * |
45 | | - * @param path 路径. |
46 | | - * @return {@link Optional}{@code <}{@link AppVersion}{@code >} 对象. |
| 45 | + * @param path 路径。 |
| 46 | + * @return {@link Optional}{@code <}{@link AppVersion}{@code >} 对象。 |
47 | 47 | */ |
48 | 48 | Optional<AppVersion> getByPath(String path); |
49 | 49 |
|
50 | 50 | /** |
51 | | - * 强制获取一个应用,若获取不到则抛出应用版本不存在的异常. |
| 51 | + * 强制获取一个应用,若获取不到则抛出应用版本不存在的异常。 |
52 | 52 | * |
53 | | - * @param appId 应用版本id. |
54 | | - * @return {@link AppVersion} 对象 |
55 | | - * @throws AippException 异常. |
| 53 | + * @param appId 应用版本id。 |
| 54 | + * @return {@link AppVersion} 对象。 |
| 55 | + * @throws AippException 异常。 |
56 | 56 | */ |
57 | 57 | AppVersion retrieval(String appId); |
58 | 58 |
|
59 | 59 | /** |
60 | | - * 通过appSuiteId获取所有的 {@link AppVersion} 列表. |
| 60 | + * 通过appSuiteId获取所有的 {@link AppVersion} 列表。 |
61 | 61 | * |
62 | | - * @param appSuiteId 应用的唯一id. |
63 | | - * @return {@link List}{@code <}{@link AppVersion}{@code >} 集合. |
| 62 | + * @param appSuiteId 应用的唯一id。 |
| 63 | + * @return {@link List}{@code <}{@link AppVersion}{@code >} 集合。 |
64 | 64 | */ |
65 | 65 | List<AppVersion> getByAppSuiteId(String appSuiteId); |
66 | 66 |
|
67 | 67 | /** |
68 | | - * 运行 App 的某个版本. |
| 68 | + * 运行 App 的某个版本。 |
69 | 69 | * |
70 | | - * @param request 运行请求. |
71 | | - * @param context 操作人上下文信息. |
72 | | - * @return {@link Choir}{@code <}{@link Object}{@code >} SSE对象. |
| 70 | + * @param request 运行请求。 |
| 71 | + * @param context 操作人上下文信息。 |
| 72 | + * @return {@link Choir}{@code <}{@link Object}{@code >} SSE对象。 |
73 | 73 | */ |
74 | 74 | Choir<Object> run(CreateAppChatRequest request, OperationContext context); |
75 | 75 |
|
76 | 76 | /** |
77 | | - * 调试 App 的某个版本. |
| 77 | + * 调试 App 的某个版本。 |
78 | 78 | * |
79 | | - * @param request 运行请求. |
80 | | - * @param context 操作人上下文信息. |
81 | | - * @return {@link Choir}{@code <}{@link Object}{@code >} SSE对象. |
| 79 | + * @param request 运行请求。 |
| 80 | + * @param context 操作人上下文信息。 |
| 81 | + * @return {@link Choir}{@code <}{@link Object}{@code >} SSE对象。 |
82 | 82 | */ |
83 | 83 | Choir<Object> debug(CreateAppChatRequest request, OperationContext context); |
84 | 84 |
|
85 | 85 | /** |
86 | | - * 重新启动任务实例. |
| 86 | + * 重新启动任务实例。 |
87 | 87 | * |
88 | | - * @param instanceId 任务实例id. |
89 | | - * @param params 重启参数. |
90 | | - * @param context 操作人上下文. |
91 | | - * @return {@link Choir}{@code <}{@link Object}{@code >} SSE对象. |
| 88 | + * @param instanceId 任务实例id。 |
| 89 | + * @param params 重启参数。 |
| 90 | + * @param context 操作人上下文。 |
| 91 | + * @return {@link Choir}{@code <}{@link Object}{@code >} SSE对象。 |
92 | 92 | */ |
93 | 93 | Choir<Object> restart(String instanceId, Map<String, Object> params, OperationContext context); |
94 | 94 |
|
95 | 95 | /** |
96 | | - * 创建一个 {@link AppVersion} 对象. |
| 96 | + * 创建一个 {@link AppVersion} 对象。 |
97 | 97 | * |
98 | | - * @param templateId 模板id. |
99 | | - * @param dto 创建参数. |
100 | | - * @param context 操作人上下文信息. |
101 | | - * @return {@link AppVersion} 对象. |
| 98 | + * @param templateId 模板id。 |
| 99 | + * @param dto 创建参数。 |
| 100 | + * @param context 操作人上下文信息。 |
| 101 | + * @return {@link AppVersion} 对象。 |
102 | 102 | */ |
103 | 103 | AppVersion create(String templateId, AppBuilderAppCreateDto dto, OperationContext context); |
104 | 104 |
|
105 | 105 | /** |
106 | | - * 通过模板对象创建app. |
| 106 | + * 通过模板对象创建app。 |
107 | 107 | * |
108 | | - * @param template 模板对象. |
109 | | - * @param context 操作人上下文. |
110 | | - * @return {@link AppVersion} 应用版本. |
| 108 | + * @param template 模板对象。 |
| 109 | + * @param context 操作人上下文。 |
| 110 | + * @return {@link AppVersion} 应用版本。 |
111 | 111 | */ |
112 | 112 | AppVersion createByTemplate(AppTemplate template, OperationContext context); |
113 | 113 |
|
114 | 114 | /** |
115 | | - * 升级并创建一个新版本. |
| 115 | + * 升级并创建一个新版本。 |
116 | 116 | * |
117 | | - * @param appId 待升级的appid. |
118 | | - * @param dto 升级参数. |
119 | | - * @param context 操作人上下文信息. |
120 | | - * @return {@link AppVersion} 对象. |
| 117 | + * @param appId 待升级的appid。 |
| 118 | + * @param dto 升级参数。 |
| 119 | + * @param context 操作人上下文信息。 |
| 120 | + * @return {@link AppVersion} 对象。 |
121 | 121 | */ |
122 | 122 | AppVersion upgrade(String appId, AppBuilderAppCreateDto dto, OperationContext context); |
123 | 123 |
|
124 | 124 | /** |
125 | | - * 校验app名称是否符合规范. |
| 125 | + * 校验app名称是否符合规范。 |
126 | 126 | * |
127 | | - * @param name 名称. |
128 | | - * @param context 操作人上下文信息. |
129 | | - * @throws AippException 业务异常. |
| 127 | + * @param name 名称。 |
| 128 | + * @param context 操作人上下文信息。 |
| 129 | + * @throws AippException 业务异常。 |
130 | 130 | */ |
131 | 131 | void validateAppName(String name, OperationContext context) throws AippException; |
132 | 132 |
|
133 | 133 | /** |
134 | | - * 通过应用id获取最新创建的应用版本. |
| 134 | + * 通过应用id获取最新创建的应用版本。 |
135 | 135 | * |
136 | | - * @param appSuiteId 应用id. |
137 | | - * @return {@link Optional}{@code <}{@link AppVersion}{@code >} 对象. |
| 136 | + * @param appSuiteId 应用id。 |
| 137 | + * @return {@link Optional}{@code <}{@link AppVersion}{@code >} 对象。 |
138 | 138 | */ |
139 | 139 | Optional<AppVersion> getLatestCreatedByAppSuiteId(String appSuiteId); |
140 | 140 |
|
141 | 141 | /** |
142 | | - * 通过应用id获取最先创建的应用版本. |
| 142 | + * 通过应用id获取最先创建的应用版本。 |
143 | 143 | * |
144 | | - * @param appSuiteId 应用id. |
145 | | - * @return {@link Optional}{@code <}{@link AppVersion}{@code >} 对象. |
| 144 | + * @param appSuiteId 应用id。 |
| 145 | + * @return {@link Optional}{@code <}{@link AppVersion}{@code >} 对象。 |
146 | 146 | */ |
147 | 147 | Optional<AppVersion> getFirstCreatedByAppSuiteId(String appSuiteId); |
148 | 148 |
|
149 | 149 | /** |
150 | | - * 通过tenantId以及查询条件分页查询. |
| 150 | + * 通过tenantId以及查询条件分页查询。 |
151 | 151 | * |
152 | | - * @param cond 查询条件. |
153 | | - * @param tenantId 租户id. |
154 | | - * @param offset 偏移量. |
155 | | - * @param limit 条数限制. |
156 | | - * @return {@link AppVersion} 分页集合. |
| 152 | + * @param cond 查询条件。 |
| 153 | + * @param tenantId 租户id。 |
| 154 | + * @param offset 偏移量。 |
| 155 | + * @param limit 条数限制。 |
| 156 | + * @return {@link AppVersion} 分页集合。 |
157 | 157 | */ |
158 | 158 | RangedResultSet<AppVersion> pageListByTenantId(AppQueryCondition cond, String tenantId, long offset, int limit); |
159 | 159 |
|
160 | 160 | /** |
161 | | - * 根据条件以及tenantId统计app数量. |
| 161 | + * 根据条件以及tenantId统计app数量。 |
162 | 162 | * |
163 | | - * @param cond 查询条件. |
164 | | - * @param tenantId 租户id. |
165 | | - * @return 数量. |
| 163 | + * @param cond 查询条件。 |
| 164 | + * @param tenantId 租户id。 |
| 165 | + * @return 数量。 |
166 | 166 | */ |
167 | 167 | long countByTenantId(AppQueryCondition cond, String tenantId); |
168 | 168 |
|
169 | 169 | /** |
170 | | - * 根据传入的 {@link AppBuilderAppDto} 数据进行修改. |
| 170 | + * 根据传入的 {@link AppBuilderAppDto} 数据进行修改。 |
171 | 171 | * |
172 | | - * @param appId 版本id. |
173 | | - * @param appDto 待修改数据. |
174 | | - * @param context 操作人上下文信息. |
175 | | - * @return {@link AppVersion} 对象. |
| 172 | + * @param appId 版本id。 |
| 173 | + * @param appDto 待修改数据。 |
| 174 | + * @param context 操作人上下文信息。 |
| 175 | + * @return {@link AppVersion} 对象。 |
176 | 176 | */ |
177 | 177 | AppVersion update(String appId, AppBuilderAppDto appDto, OperationContext context); |
178 | 178 |
|
179 | 179 | /** |
180 | | - * 根据传入的 {@link AppBuilderFlowGraphDto} 数据进行修改. |
| 180 | + * 根据传入的 {@link AppBuilderFlowGraphDto} 数据进行修改。 |
181 | 181 | * |
182 | | - * @param appId 版本id. |
183 | | - * @param graphDto 待修改数据. |
184 | | - * @param context 操作人上下文信息. |
185 | | - * @return {@link AppVersion} 对象. |
| 182 | + * @param appId 版本id。 |
| 183 | + * @param graphDto 待修改数据。 |
| 184 | + * @param context 操作人上下文信息。 |
| 185 | + * @return {@link AppVersion} 对象。 |
186 | 186 | */ |
187 | 187 | AppVersion update(String appId, AppBuilderFlowGraphDto graphDto, OperationContext context); |
188 | 188 |
|
189 | 189 | /** |
190 | | - * 根据传入的 {@link AppBuilderSaveConfigDto} 数据进行修改. |
| 190 | + * 根据传入的 {@link AppVersion} 数据更新流程。 |
191 | 191 | * |
192 | | - * @param appId 版本id. |
193 | | - * @param appBuilderSaveConfigDto 待修改数据. |
194 | | - * @param context 操作人上下文信息. |
195 | | - * @return {@link AppVersion} 对象. |
| 192 | + * @param appVersion 应用版本。 |
| 193 | + * @param graphDto 待修改数据。 |
| 194 | + * @param context 操作人上下文信息。 |
| 195 | + */ |
| 196 | + void updateGraph(AppVersion appVersion, AppBuilderFlowGraphDto graphDto, OperationContext context); |
| 197 | + |
| 198 | + /** |
| 199 | + * 根据传入的 {@link AppBuilderSaveConfigDto} 数据进行修改。 |
| 200 | + * |
| 201 | + * @param appId 版本id。 |
| 202 | + * @param appBuilderSaveConfigDto 待修改数据。 |
| 203 | + * @param context 操作人上下文信息。 |
| 204 | + * @return {@link AppVersion} 对象。 |
196 | 205 | */ |
197 | 206 | AppVersion update(String appId, AppBuilderSaveConfigDto appBuilderSaveConfigDto, OperationContext context); |
198 | 207 |
|
199 | 208 | /** |
200 | | - * 根据传入的 {@link AppVersion} 进行修改. |
| 209 | + * 根据传入的 {@link AppVersion} 进行修改。 |
201 | 210 | * |
202 | | - * @param appVersion {@link AppVersion} 对象. |
| 211 | + * @param appVersion {@link AppVersion} 对象。 |
203 | 212 | */ |
204 | 213 | void update(AppVersion appVersion); |
205 | 214 |
|
206 | 215 | /** |
207 | | - * 通过id批量删除. |
| 216 | + * 通过id批量删除。 |
208 | 217 | * |
209 | | - * @param appIds 版本id集合. |
| 218 | + * @param appIds 版本id集合。 |
210 | 219 | */ |
211 | 220 | void deleteByIds(List<String> appIds); |
212 | 221 |
|
213 | 222 | /** |
214 | | - * 判断应用名称是否已经存在. |
| 223 | + * 判断应用名称是否已经存在。 |
215 | 224 | * |
216 | | - * @param appName 应用名称. |
217 | | - * @param context 操作人上下文. |
218 | | - * @return true/false. |
| 225 | + * @param appName 应用名称。 |
| 226 | + * @param context 操作人上下文。 |
| 227 | + * @return true/false。 |
219 | 228 | */ |
220 | 229 | boolean isNameExists(String appName, OperationContext context); |
221 | 230 |
|
222 | 231 | /** |
223 | | - * 保存. |
| 232 | + * 保存。 |
224 | 233 | * |
225 | | - * @param appVersion {@link AppVersion} 对象. |
| 234 | + * @param appVersion {@link AppVersion} 对象。 |
226 | 235 | */ |
227 | 236 | void save(AppVersion appVersion); |
228 | 237 | } |
0 commit comments