SAIF.Business.Claim.Person 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 | Inputs | Outputs | Rules | Tables | SQL |
|---|---|---|---|---|---|---|---|
| Worker profile management | Retrieve and update the injured-worker profile aggregate through the worker-data API. | Caller requests a worker by ID or edits and saves the profile. | Worker ID, demographic and contact fields | Populated or updated clsWorker |
BR-PER-001, BR-PER-002 | — | SQL-008 |
| Claim-person name management | Maintain claim-person name history and derive the phonetic name code before persistence. | Caller edits and saves a person's name-history collection. | Person ID, name fields, primary/void flags | Persisted clsClaimPersonName rows |
BR-PER-002, BR-PER-028, BR-PER-029, BR-PER-030, BR-PER-031, BR-PER-032 | CL_CLAIM_PERSON_NAME_HISTORY, DUAL | SQL-002, SQL-008, SQL-009, SQL-017, SQL-021 |
| Claim-person address management | Maintain home, mailing, and payment addresses, validating content while delegating persistence to the worker-address API. | Caller edits and saves a person's address collection. | Person ID, address code, address fields | Persisted address through the worker-address API | BR-PER-033, BR-PER-034, BR-PER-035 | DUAL | SQL-006, SQL-007 |
| Tax ID history management | Maintain per-person tax ID history and validate primary/duplicate tax IDs. | Caller edits and saves a person's tax ID history collection. | Person ID, tax ID, primary/void flags | Persisted clsPersonTaxIDHistory rows |
BR-PER-001, BR-PER-003, BR-PER-006, BR-PER-008, BR-PER-009 | CL_PERSON_TAX_ID_HISTORY, CL_CLAIM_PERSON | SQL-003, SQL-010, SQL-011, SQL-012, SQL-013, SQL-019, SQL-022 |
| Award eligibility management | Maintain beneficiary award-eligibility periods and validate boundary/overlap rules. | Caller edits and saves a beneficiary's eligibility-period collection. | Person ID, effective/expiration dates | Persisted clsAwardEligibility rows |
BR-PER-010, BR-PER-011, BR-PER-012, BR-PER-013, BR-PER-014 | CL_AWARD_ELIGIBILITY | SQL-001, SQL-005, SQL-015, SQL-020 |
| Beneficiary management | Retrieve worker beneficiary contacts and validate demographic/eligibility rules. | Caller requests beneficiaries for a worker and edits the loaded beneficiary. | Worker ID, optional claim ID | Hydrated clsBeneficiary objects |
BR-PER-015 through BR-PER-026 | — | — |
| Guardian and power-of-attorney management | Retrieve guardian and power-of-attorney contact snapshots and hydrate nested addresses. | Caller requests guardian or power-of-attorney data by claim ID or claim number. | Claim ID or claim number | Hydrated clsGuardian/clsPowerOfAttorney objects |
— | — | — |
| Worker health issue tracking | Maintain worker exposure/health-issue rows. | Caller edits and saves a worker's health-issue collection. | Worker ID, exposure code | Persisted clsWorkerHealthIssue rows |
BR-PER-001, BR-PER-027 | CL_WORKER_HEALTH_ISSUE | SQL-004, SQL-014, SQL-023 |
| Claim-person audit history | Record before/after snapshots for tracked claim-person field changes. | Caller creates an audit-history entry or lists a person's history. | Person ID, claim ID, audit type, before/after text | Persisted audit-history entry or retrieved collection | — | — | — |
Process flow diagram¶
The following diagram visualizes the primary operational flow across operations.
flowchart TD
Start([Start]) --> Load[Retrieve worker, name, address,<br>tax ID, eligibility, beneficiary,<br>guardian, or health-issue data]
Load --> Validate[Apply per-operation business rules]
Validate --> Decision{Valid?}
Decision -->|No| EndNo([Broken rules or warnings returned])
Decision -->|Yes| Persist[Persist through Oracle SQL<br>or CCClaimDataApi]
Persist --> EndYes([Save completes; audit history<br>recorded for tracked fields])
Inherited operations and processes¶
Operations in this section originate from base classes provided by dependency framework libraries. They are inherited or delegated, not implemented in this library.
From clsBusinessBase / clsBusinessApiBase (saif-framework-core)¶
| Operation | Intent | Provided by | Origin | Embedded in |
|---|---|---|---|---|
| Save entity lifecycle | Provide BOF create, update, and delete orchestration, including dirty-state tracking and rule propagation, for business objects.† | clsBusinessBase, clsBusinessApiBase |
saif-framework-core |
Worker profile management, Claim-person name management, Claim-person address management, Tax ID history management, Award eligibility management, Worker health issue tracking |
| Address value behavior | Supply shared address fields, formatting, and zip/state validation hooks consumed by claim-person addresses.† | clsAddress |
saif-framework-core |
Claim-person address management |
Origin: These behaviors are defined in
saif-framework-coreand inherited by this component's business objects. Their step-by-step logic is embedded inline (with base-class behavior noted) in each consuming operation's detail page.
Database interactions¶
The following table summarizes which operations read from or write to the database. Per-step SQL and table citations live in each operation's detail page under operations/.
| Operation | SQL | Tables | Type |
|---|---|---|---|
| Worker profile management | SQL-008 | DUAL | Read |
| Claim-person name management | SQL-002, SQL-008, SQL-009, SQL-017, SQL-021 | CL_CLAIM_PERSON_NAME_HISTORY, DUAL | Write |
| Claim-person address management | SQL-006, SQL-007 | DUAL | Write |
| Tax ID history management | SQL-003, SQL-010, SQL-011, SQL-012, SQL-013, SQL-019, SQL-022 | CL_PERSON_TAX_ID_HISTORY, CL_CLAIM_PERSON | Write |
| Award eligibility management | SQL-001, SQL-005, SQL-015, SQL-020 | CL_AWARD_ELIGIBILITY | Write |
| Worker health issue tracking | SQL-004, SQL-014, SQL-023 | CL_WORKER_HEALTH_ISSUE | Write |
Beneficiary management, guardian and power-of-attorney management, and claim-person audit history either retrieve data exclusively through CCClaimDataApi or use tables (CL_IW_AUDIT_HISTORY, CL_IW_AUDIT_TYPE_CODE) that are not part of this library's cataloged database-tables.md set, so they are omitted from this table.*
Failure and edge-case behavior¶
- Every BOF-backed operation (name, address, tax ID, award eligibility, health issue) surfaces a standard DB-contention error when an insert, update, or delete does not affect the expected number of rows.
clsWorkerand the address-persistence path inclsClaimPersonAddressroute real reads and writes throughCCClaimDataApirather than local SQL, so contention detection for those paths depends on the API's own status/response handling rather than a rows-affected check.*- Beneficiary management's
Save()/savechild()currently return success without persisting any beneficiary edits; callers must not treat a successful save as confirmation of a database or API write. - Guardian and power-of-attorney classes are read-oriented API hydration only; this source set implements no local save workflow for either object.
Related documentation¶
- Index
- Overview
- Architecture
- Dependencies
- Business rules
- Database tables
- SQL catalog
- Procedures
- API reference
Note: Statements marked with
†are derived from dependency library documentation via the Legends CLI. They describe inherited behavior from the indicated origin library and should be verified if the dependency version changes. Statements marked with*were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts.
Sources¶
Business\SAIF.Business.Claim.Person\clsWorker.vbBusiness\SAIF.Business.Claim.Person\clsWorkerAddress.vbBusiness\SAIF.Business.Claim.Person\clsClaimPersonName.vbBusiness\SAIF.Business.Claim.Person\clsClaimPersonNameCollection.vbBusiness\SAIF.Business.Claim.Person\clsClaimPersonAddress.vbBusiness\SAIF.Business.Claim.Person\clsClaimPersonAddressCollection.vbBusiness\SAIF.Business.Claim.Person\clsClaimPersonAuditHistory.vbBusiness\SAIF.Business.Claim.Person\clsPersonTaxIDHistory.vbBusiness\SAIF.Business.Claim.Person\clsPersonTaxIDHistoryCollection.vbBusiness\SAIF.Business.Claim.Person\clsAwardEligibility.vbBusiness\SAIF.Business.Claim.Person\clsAwardEligibilityCollection.vbBusiness\SAIF.Business.Claim.Person\clsBeneficiary.vbBusiness\SAIF.Business.Claim.Person\clsBeneficiaryCollection.vbBusiness\SAIF.Business.Claim.Person\clsGuardian.vbBusiness\SAIF.Business.Claim.Person\clsGuardianAddress.vbBusiness\SAIF.Business.Claim.Person\clsGuardianCollection.vbBusiness\SAIF.Business.Claim.Person\clsPowerOfAttorney.vbBusiness\SAIF.Business.Claim.Person\clsPowerOfAttorneyAddress.vbBusiness\SAIF.Business.Claim.Person\clsWorkerHealthIssue.vbBusiness\SAIF.Business.Claim.Person\clsWorkerHealthIssueCollection.vbBusiness\SAIF.Business.Claim.Person\CCClaimDataApi\clsBeneficiaryAddress.vb
Stored procedure operations¶
Operations implemented in Oracle stored procedures referenced by this library.
| Operation | Description | Source | Link |
|---|---|---|---|
| Phonetic name derivation | Generates the phonetic name token used by worker and claim-person name persistence. | PK82028_PHONETIC_NAME.createPhoneticName |
Details |