File size: 16,926 Bytes
b4f2238 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 | """
案件相关 Protocol 接口定义
包含:ICaseService, ICaseSearchService, ICaseNumberService, ICaseLogService
"""
from typing import Any, Protocol
from apps.core.dto import CaseDTO, CasePartyDTO, CaseSearchResultDTO, CaseTemplateBindingDTO
class ICaseService(Protocol):
"""
案件服务接口
定义案件服务的公共方法,供其他模块使用
"""
def get_case(self, case_id: int) -> CaseDTO | None:
"""
获取案件信息
Args:
case_id: 案件 ID
Returns:
案件 DTO,不存在时返回 None
"""
...
def get_cases_by_contract(self, contract_id: int) -> list[CaseDTO]:
"""
获取合同关联的案件
Args:
contract_id: 合同 ID
Returns:
案件 DTO 列表
"""
...
def check_case_access(self, case_id: int, user_id: int) -> bool:
"""
检查用户是否有权限访问案件
Args:
case_id: 案件 ID
user_id: 用户 ID
Returns:
是否有权限访问
"""
...
def get_cases_by_ids(self, case_ids: list[int]) -> list[CaseDTO]:
"""
批量获取案件信息
Args:
case_ids: 案件 ID 列表
Returns:
案件 DTO 列表
"""
...
def validate_case_active(self, case_id: int) -> bool:
"""
验证案件是否有效(状态为 active)
Args:
case_id: 案件 ID
Returns:
案件是否有效
"""
...
def get_case_current_stage(self, case_id: int) -> str | None:
"""
获取案件的当前阶段
Args:
case_id: 案件 ID
Returns:
当前阶段,案件不存在时返回 None
"""
...
def create_case(self, data: dict[str, Any]) -> CaseDTO:
"""
创建案件
Args:
data: 案件数据字典,包含:
- name: 案件名称(必填)
- contract_id: 合同 ID(可选)
- is_archived: 是否已建档(可选,默认 False)
- case_type: 案件类型(可选)
- target_amount: 涉案金额(可选)
- cause_of_action: 案由(可选)
- current_stage: 当前阶段(可选)
Returns:
创建的案件 DTO
"""
...
def create_case_assignment(self, case_id: int, lawyer_id: int) -> bool:
"""
创建案件指派
Args:
case_id: 案件 ID
lawyer_id: 律师 ID
Returns:
是否创建成功
"""
...
def create_case_party(self, case_id: int, client_id: int, legal_status: str | None = None) -> bool:
"""
创建案件当事人
Args:
case_id: 案件 ID
client_id: 客户 ID
legal_status: 诉讼地位(可选)
Returns:
是否创建成功
"""
...
def get_user_extra_case_access(self, user_id: int) -> list[int]:
"""
获取用户的额外案件访问授权
Args:
user_id: 用户 ID
Returns:
用户有额外访问权限的案件 ID 列表
"""
...
def get_case_by_id_internal(self, case_id: int) -> CaseDTO | None:
"""
内部方法:获取案件信息(无权限检查)
Args:
case_id: 案件 ID
Returns:
案件 DTO,不存在时返回 None
"""
...
def search_cases_by_party_internal(self, party_names: list[str], status: str | None = None) -> list[CaseDTO]:
"""
内部方法:根据当事人名称搜索案件
Args:
party_names: 当事人名称列表
status: 案件状态筛选(可选)
Returns:
匹配的案件 DTO 列表
"""
...
def get_case_numbers_by_case_internal(self, case_id: int) -> list[str]:
"""
内部方法:获取案件的所有案号
Args:
case_id: 案件 ID
Returns:
案号字符串列表
"""
...
def get_case_party_names_internal(self, case_id: int) -> list[str]:
"""
内部方法:获取案件的所有当事人名称
Args:
case_id: 案件 ID
Returns:
当事人名称列表
"""
...
def search_cases_by_case_number_internal(self, case_number: str) -> list[CaseDTO]:
"""
内部方法:根据案号搜索案件
Args:
case_number: 案号字符串
Returns:
匹配的案件 DTO 列表
"""
...
def create_case_log_internal(self, case_id: int, content: str, user_id: int | None = None) -> int:
"""
内部方法:创建案件日志,返回日志ID
Args:
case_id: 案件 ID
content: 日志内容
user_id: 用户 ID(可选)
Returns:
创建的日志 ID
Raises:
NotFoundError: 案件不存在
"""
...
def add_case_log_attachment_internal(self, case_log_id: int, file_path: str, file_name: str) -> bool:
"""
内部方法:添加案件日志附件
Args:
case_log_id: 案件日志 ID
file_path: 文件路径
file_name: 文件名称
Returns:
是否添加成功
Raises:
NotFoundError: 案件日志不存在
"""
...
def add_case_number_internal(self, case_id: int, case_number: str, user_id: int | None = None) -> bool:
"""
内部方法:为案件添加案号(如果不存在)
Args:
case_id: 案件 ID
case_number: 案号字符串
user_id: 操作用户 ID(可选)
Returns:
是否添加成功(已存在也返回 True)
"""
...
def update_case_log_reminder_internal(self, case_log_id: int, reminder_time: Any, reminder_type: str) -> bool:
"""
内部方法:更新案件日志的提醒时间和类型
Args:
case_log_id: 案件日志 ID
reminder_time: 提醒时间(datetime)
reminder_type: 提醒类型(CaseLogReminderType 枚举值)
Returns:
是否更新成功
"""
...
def get_case_model_internal(self, case_id: int) -> Any | None:
"""
内部方法:获取案件 Model 对象(用于外键赋值)
Args:
case_id: 案件 ID
Returns:
Case Model 对象,不存在时返回 None
"""
...
def get_case_log_model_internal(self, case_log_id: int) -> Any | None:
"""
内部方法:获取案件日志 Model 对象(用于外键赋值)
Args:
case_log_id: 案件日志 ID
Returns:
CaseLog Model 对象,不存在时返回 None
"""
...
def get_case_with_details_internal(self, case_id: int) -> dict[str, Any] | None:
"""
内部方法:获取案件详细信息(包含当事人、案号等关联数据)
Args:
case_id: 案件 ID
Returns:
案件详细信息字典
"""
...
def unbind_cases_from_contract_internal(self, contract_id: int) -> int:
"""
内部方法:解绑合同下的所有案件
Args:
contract_id: 合同 ID
Returns:
解绑的案件数量
"""
...
def count_cases_by_contract(self, contract_id: int) -> int:
"""
内部方法:统计合同下的案件数（删除合同时用于日志记录）
Args:
contract_id: 合同 ID
Returns:
案件数量
"""
...
def get_primary_lawyer_names_by_case_ids_internal(self, case_ids: list[int]) -> dict[int, str | None]:
"""
内部方法:批量获取案件主办律师姓名(取案件指派列表的第一个律师)
"""
...
def get_case_parties_by_legal_status_internal(self, case_id: int, legal_status: str) -> list[str]:
"""
内部方法:根据诉讼地位获取当事人名称列表
Args:
case_id: 案件 ID
legal_status: 诉讼地位 (plaintiff/defendant 等)
Returns:
当事人名称列表
"""
...
def get_case_template_binding_internal(self, case_id: int) -> CaseTemplateBindingDTO | None:
"""
内部方法:获取案件的模板绑定信息
Args:
case_id: 案件 ID
Returns:
CaseTemplateBindingDTO,不存在返回 None
"""
...
def get_case_parties_internal(self, case_id: int, legal_status: str | None = None) -> list[CasePartyDTO]:
"""
内部方法:获取案件当事人列表
Args:
case_id: 案件 ID
legal_status: 法律地位筛选(可选)
Returns:
CasePartyDTO 列表
"""
...
def get_case_template_bindings_by_name_internal(
self, case_id: int, template_name: str
) -> list[CaseTemplateBindingDTO]:
"""
内部方法:根据模板名称获取案件模板绑定列表
Args:
case_id: 案件 ID
template_name: 模板名称
Returns:
CaseTemplateBindingDTO 列表
"""
...
def get_case_internal(self, case_id: int) -> CaseDTO | None:
"""
内部方法:获取案件信息(无权限检查)
Args:
case_id: 案件 ID
Returns:
案件 DTO,不存在时返回 None
"""
...
def search_cases_for_binding_internal(self, search_term: str = "", limit: int = 20) -> list[dict[str, Any]]:
"""
内部方法:搜索可绑定的案件(用于文书识别等跨模块场景)
支持按案件名称、案号、当事人搜索,返回包含案号和当事人的完整信息.
Args:
search_term: 搜索关键词
limit: 返回数量限制
Returns:
案件信息字典列表,每个元素包含:
- id: 案件 ID
- name: 案件名称
- case_numbers: 案号列表
- parties: 当事人名称列表
- created_at: 创建时间 ISO 格式字符串
"""
...
class ICaseSearchService(Protocol):
"""
案件搜索服务接口
定义案件搜索的核心方法,供跨模块调用.
用于 API 层搜索案件,避免直接导入 Model 和使用 Q() 查询.
Requirements: 1.1, 2.1
"""
def search_cases(self, query: str, limit: int = 20) -> list[CaseSearchResultDTO]:
"""
搜索案件
支持按案件名称、案号、当事人搜索.
Args:
query: 搜索关键词(案件名称、案号、当事人)
limit: 返回结果数量限制,默认20
Returns:
匹配的案件搜索结果 DTO 列表
"""
...
class ICaseNumberService(Protocol):
"""
案号服务接口
定义案号管理的核心方法,供跨模块调用
"""
def list_numbers_internal(self, case_id: int) -> list[Any]:
"""
内部方法:获取案件的所有案号
Args:
case_id: 案件 ID
Returns:
案号对象列表
"""
...
def create_number_internal(self, case_id: int, number: str, remarks: str | None = None) -> Any:
"""
内部方法:创建案号
Args:
case_id: 案件 ID
number: 案号
remarks: 备注(可选)
Returns:
创建的案号对象
"""
...
def format_case_number(self, number: str) -> str:
"""
格式化案号:统一括号、删除空格
在保存前调用此方法，确保案号格式统一。
Args:
number: 原始案号
Returns:
格式化后的案号
"""
...
def normalize_case_number(self, number: str) -> str:
"""
规范化案号:统一括号、删除空格
.. deprecated::
使用 :meth:`format_case_number` 代替
Args:
number: 原始案号
Returns:
规范化后的案号
"""
...
class ICaseFilingNumberService(Protocol):
def generate_case_filing_number_internal(self, case_id: int, case_type: str, created_year: int) -> str: ...
class ICaseLogService(Protocol):
"""
案件日志服务接口
定义案件日志管理的核心方法
"""
def list_logs(
self,
case_id: int | None = None,
user: Any | None = None,
org_access: dict[str, Any] | None = None,
perm_open_access: bool = False,
) -> Any:
"""
获取日志列表
Args:
case_id: 案件 ID(可选,用于过滤)
user: 当前用户
org_access: 组织访问策略
perm_open_access: 是否有开放访问权限
Returns:
日志查询集
"""
...
def get_log(
self,
log_id: int,
user: Any | None = None,
org_access: dict[str, Any] | None = None,
perm_open_access: bool = False,
) -> Any:
"""
获取单个日志
Args:
log_id: 日志 ID
user: 当前用户
org_access: 组织访问策略
perm_open_access: 是否有开放访问权限
Returns:
日志对象
Raises:
NotFoundError: 日志不存在
PermissionDenied: 无权限访问
"""
...
def create_log(
self,
case_id: int,
content: str,
user: Any | None = None,
reminder_type: str | None = None,
reminder_time: Any | None = None,
) -> Any:
"""
创建案件日志
Args:
case_id: 案件 ID
content: 日志内容
user: 当前用户
reminder_type: 提醒类型
reminder_time: 提醒时间
Returns:
创建的日志对象
Raises:
NotFoundError: 案件不存在
"""
...
def update_log(
self,
log_id: int,
data: dict[str, Any],
user: Any | None = None,
org_access: dict[str, Any] | None = None,
perm_open_access: bool = False,
) -> Any:
"""
更新案件日志
Args:
log_id: 日志 ID
data: 更新数据字典
user: 当前用户
org_access: 组织访问策略
perm_open_access: 是否有开放访问权限
Returns:
更新后的日志对象
Raises:
NotFoundError: 日志不存在
PermissionDenied: 无权限修改
"""
...
def delete_log(
self,
log_id: int,
user: Any | None = None,
org_access: dict[str, Any] | None = None,
perm_open_access: bool = False,
) -> dict[str, bool]:
"""
删除案件日志
Args:
log_id: 日志 ID
user: 当前用户
org_access: 组织访问策略
perm_open_access: 是否有开放访问权限
Returns:
{"success": True}
Raises:
NotFoundError: 日志不存在
PermissionDenied: 无权限删除
"""
...
def upload_attachments(
self,
log_id: int,
files: list[Any],
user: Any | None = None,
org_access: dict[str, Any] | None = None,
perm_open_access: bool = False,
) -> dict[str, int]:
"""
上传日志附件
Args:
log_id: 日志 ID
files: 上传的文件列表
user: 当前用户
org_access: 组织访问策略
perm_open_access: 是否有开放访问权限
Returns:
{"count": 上传数量}
Raises:
NotFoundError: 日志不存在
PermissionDenied: 无权限上传
ValidationException: 文件验证失败
"""
...
class ILitigationFeeCalculatorService(Protocol):
def calculate_all_fees(
self,
target_amount: Any | None = None,
preservation_amount: Any | None = None,
case_type: str | None = None,
cause_of_action: str | None = None,
cause_of_action_id: int | None = None,
) -> dict[str, Any]: ...
|