SAIF.Business.Claim.Legal operations and processes¶
This page is the operation catalog and cross-operation hub for this library. Each operation's detailed, step-by-step logic lives in its own page under operations/.
Operation catalog¶
| Operation | Intent | Trigger | Rules | Tables | SQL |
|---|---|---|---|---|---|
| Manage legal case lifecycle | Create, update, and retrieve the legal-case header record and drive its status through the case lifecycle. | Presentation caller creates, edits, or saves a legal case | BR-CLM-LGL-005 | LEGAL_CASE, CASE_STATUS_HISTORY | DB-CLL-046, DB-CLL-047, DB-CLL-048 |
| Manage case cost entries | Create, validate, update, and delete billing/cost line items associated with a legal case. | User adds or edits a cost line on a legal case | BR-CLM-LGL-001, BR-CLM-LGL-002, BR-CLM-LGL-003, BR-CLM-LGL-005 | CASE_COST | DB-CLL-001, DB-CLL-002, DB-CLL-003 |
| Manage appeals and appeal extensions | Create, update, delete, and retrieve appeal records and their extensions for a legal case. | User files, updates, extends, or deletes an appeal | BR-CLM-LGL-005 | APPEAL, APPEAL_EXTENSION | DB-CLL-009, DB-CLL-010, DB-CLL-011 |
| Manage case notes | Create, update, delete, and retrieve free-text case notes attached to a legal case. | User adds, edits, or deletes a case note | BR-CLM-LGL-005 | CASE_NOTE | DB-CLL-016, DB-CLL-017, DB-CLL-018 |
| Manage case outcomes, issues, and staff | Create, update, delete, and retrieve case outcome records along with their outcome-issue and outcome-staff detail rows. | User records the outcome of a hearing/board action | BR-CLM-LGL-005 | CASE_OUTCOME, OUTCOME_ISSUE, OUTCOME_STAFF | DB-CLL-020, DB-CLL-021, DB-CLL-022 |
| Manage legal case evaluations | Create, update, and retrieve legal-case evaluation records. | User records or updates a case evaluation | BR-CLM-LGL-005 | LEGAL_CASE_EVALUATION | DB-CLL-033, DB-CLL-034, DB-CLL-035 |
| Manage legal file locations | Track and update the physical/electronic file location of a legal case's documents. | File location changes (e.g., file sent to storage, attorney, or board) | BR-CLM-LGL-005, BR-CLM-LGL-019 | LEGAL_FILE_LOCATION | DB-CLL-036, DB-CLL-037, DB-CLL-038 |
| Manage legal schedule and hearing calendar | Create, update, delete, and retrieve hearing/schedule entries for a legal case, and resolve secretary/ALJ display names. | User schedules, reschedules, or cancels a hearing | BR-CLM-LGL-005, BR-CLM-LGL-025 | LEGAL_SCHEDULE, SCHEDULE | DB-CLL-040, DB-CLL-041, DB-CLL-042 |
| Manage acknowledgements | Update acknowledgement records confirming receipt of legal correspondence for a case. | User records receipt of an acknowledgement (e.g., from LegalApi) | BR-CLM-LGL-005 | — | DB-CLL-008 |
| Manage mail dates and OAR flags | Stamp mail dates and order-and-award (OAR) flags on legal cases, individually or as a batch. | Order is mailed to a claimant/attorney, or a batch mail run executes | — | LEGAL_CASE | DB-CLL-054, DB-CLL-055 |
| Manage case consolidation | Link one legal case to another as a consolidated case, cascading a case-status update. | User consolidates two or more legal cases | BR-CLM-LGL-025 | CONSOLIDATED_CASE, LEGAL_CASE, CASE_STATUS_HISTORY | DB-CLL-056, DB-CLL-057 |
| Create legal case file and assign document sequence | Stamp a file-create date on a legal case and pull the next print-document sequence number for generated correspondence. | A new legal file is created for a case (typically as part of print/letter generation) | — | LEGAL_CASE | DB-CLL-052, DB-CLL-053 |
| Manage other legal parties and request issues | Retrieve employer/other-party associations and request-issue records tied to a legal case. | Case detail screens load request issues or other-party associations | — | REQUEST_ISSUE, LEGAL_CASE_EMPLOYER | DB-CLL-028, DB-CLL-029, DB-CLL-030 |
| Manage hearing locations | Maintain hearing-location reference data (create, retrieve, update, delete) and validate state codes, guarding delete when active schedule rows exist. | Reference-data maintenance user adds, edits, or deletes a hearing location | BR-CLM-LGL-012, BR-CLM-LGL-013 | HEARING_LOCATION, SCHEDULE, ALL_STATES | DB-CLL-032, DB-CLL-062, DB-CLL-063 |
| Manage attorney and legal-person reference data | Maintain attorney profiles, conflicts, policy assignments, schedules, legal persons, other firms, and rotation assignments, enforcing duplicate/referential-integrity checks. | Reference-data maintenance user adds, edits, or deletes attorney/firm/person records | BR-CLM-LGL-006, BR-CLM-LGL-007, BR-CLM-LGL-008, BR-CLM-LGL-009, BR-CLM-LGL-010, BR-CLM-LGL-011, BR-CLM-LGL-014, BR-CLM-LGL-015, BR-CLM-LGL-016, BR-CLM-LGL-017, BR-CLM-LGL-018 | ATTORNEY_CONFLICT, ATTORNEY_POLICY_ASSIGNMENT, ATTORNEY_SCHEDULE | DB-CLL-061, DB-CLL-064, DB-CLL-065-104 |
| Sync attorney schedule to Exchange calendar | Push saved attorney schedule entries to the Exchange calendar via SAIF.Services.Exchange, suppressed outside Production. | clsAttorneySchedule.Save()/OnSave() completes a successful save in a Production environment | BR-CLM-LGL-010, BR-CLM-LGL-011, BR-CLM-LGL-024 | ATTORNEY_SCHEDULE | — |
| Search legal cases | Validate search criteria by search type and retrieve matching legal cases via the LegalApi REST integration tier. | User submits a case search from the presentation layer | BR-CLM-LGL-004 | — | — |
| Print a legal letter | Assemble print-ready letter content (attorney names, worker info, policy names) primarily via LegalApi REST calls, resolve case number via LEGAL.vw_cases, and generate a print-document sequence number. | User requests a printed letter for a legal case | BR-CLM-LGL-020, BR-CLM-LGL-021, BR-CLM-LGL-022, BR-CLM-LGL-023 | LEGAL.vw_cases | DB-CLL-058, DB-CLL-053 |
| Review attorney assignment calendar | Compute the next assignment result sequence and trigger an Oracle-side calendar review for attorney work assignment. | Scheduled/batch attorney-assignment review runs | — | — | DB-CLL-059, DB-CLL-060 |
| Resolve code-table lookups | Populate dropdown/code-table lookup lists (attorney types, case status, hearing locations, and related joined reference data) consumed across most domains in this library. | Any screen or business object requests dropdown/code-table data | — | ADP_EMPLOYEE, ATTORNEY_PROFILE, LEGAL_PERSON | DB-CLL-CT-001 |
Process flow diagram¶
flowchart TD
Start([Legal case created or updated]) --> Case[Manage legal case lifecycle]
Case --> Sub1[Manage appeal / case cost / case note / case outcome]
Sub1 --> Sub2[Manage legal schedule / hearing location]
Sub2 --> Print[Print legal letter]
Print --> EndOk([Case processed])
Inherited operations and processes¶
Operations in this section originate from base classes provided by SAIF.Framework.Core (see architecture.md). They are inherited, not implemented in this library.
From clsBusinessBase clsBusinessCollectionBase (SAIF.Framework.Core)†¶
| Operation | Intent | Provided by | Origin | Embedded in |
|---|---|---|---|---|
| Standard Save lifecycle (BeforeInsert/BeforeUpdate/AfterCreate/BeforeDelete dispatch) | Routes CRUD calls to the correct IBusinessCriteria SQL property based on object state† |
clsBusinessBase |
SAIF.Framework.Core |
Manage legal case lifecycle and all other CRUD operations in this catalog |
| Retrieve-only SQL suppression | Suppresses Insert/Update/Delete SQL for retrieve-only criteria objects† | clsRetrieveOnlyBusinessCriteria |
SAIF.Framework.Core |
Manage hearing location (clsHearingLocationInfo), Resolve code-table lookups |
Origin: These operations are defined in
SAIF.Framework.Coreand inherited by everyclsBusinessBase/clsBusinessCollectionBase/clsRetrieveOnlyBusinessCriteria-derived object in this library. Their generic lifecycle dispatch logic is not re-documented per operation; seearchitecture.mdfor the full inherited framework behavior list.
Database interactions¶
Failure and edge-case behavior¶
- Validation failures across all
Manage *operations return collected errors without persisting partial changes (standard frameworkclsBusinessBasebehavior). ValidateStatechecks (used in Manage hearing location and Manage attorney and legal-person reference data) build SQL via raw string concatenation rather than a bind parameter — flagged as a SQL-injection risk; see business-rules.md.
Stored procedure operations¶
Oracle source retrieval confirmed the following server-side operations in pk80001_legalnet and pk80005_assignment.
| Operation | Description | Source | Link |
|---|---|---|---|
| Manage appeal records and extensions | Creates, updates, retrieves, and deletes appeal rows and extension requests, including linked schedule cleanup during appeal deletion. | pk80001_legalnet |
Details |
| Maintain case notes and outcomes | Retrieves and persists case notes and case outcomes, and deletes dependent issue/staff rows before removing an outcome. | pk80001_legalnet |
Details |
| Maintain hearing schedules and consolidated case state | Retrieves schedule rows, recalculates hearing pointers, and keeps consolidated-case status/hearing metadata aligned. | pk80001_legalnet |
Details |
| Stamp acknowledgements, file creation, and mail dates | Updates acknowledgement identifiers, file-location/file-create metadata, OAR flags, and mail or recon dates. | pk80001_legalnet |
Details |
| Evaluate assignment conflicts and availability | Applies conflict, leave, holiday, location, and workload checks before a hearing assignment can succeed. | pk80005_assignment |
Details |
| Execute attorney assignment | Attempts assignment, records result codes, updates the schedule row, and moves the legal case to ASSGN on success. |
pk80005_assignment |
Details |
| Assign rotation hearings | Selects pending unassigned hearing rows in active rotation coverage and evaluates the rotation attorney. | pk80005_assignment |
Details |
| Review attorney assignment calendar | Returns attorney/location/schedule/load/vacation metrics and separate future schedule-conflict reporting. | pk80005_assignment |
Details |
| Publish assignment result feeds | Returns latest assignment results, assigned-hearing lists, and related follow-up data for operational review. | pk80005_assignment |
Details |
Related documentation¶
Sources¶
SAIF.Business.Claim.Legal\LegalNet\(all.vbfiles)SAIF.Business.Claim.Legal\TableMaint\(all.vbfiles)SAIF.Business.Claim.Legal\mdlCodeTables.vb