Retrieve an interested party¶
This operation documents how clsInterestedParty.GetInterestedParty fulfills the policy-affiliate behavior described for SAIF.Business.Policy.Affiliate.
| Field | Value |
|---|---|
| Operation ID | OP-003 |
| Trigger | A caller needs one interested-party association identified by policy, affiliate, and effective date. |
| Inputs | IDataPortalInfo, affiliate SSN, policy number, effective date |
| Outputs | clsInterestedParty |
| Primary components | clsInterestedParty.GetInterestedParty |
| Entry point | Business\SAIF.Business.Policy.Affiliate\clsInterestedParty.vb |
Steps¶
- Create the interested-party criteria from the composite key and delegate the request to the BOF retrieve lifecycle.
- In
BeforeRetrieve, assign SQL-004 and bind the key parameters for BUSINESS_AFFILIATE and AFFILIATE. - The SQL filters to affiliate type
1and joins the association row to the affiliate person row by SSN (BR-AFF-003, BR-AFF-004). - When a row exists, call
Fillso the base association fields, nested affiliate, and interested-party-specific properties are all hydrated; otherwise return a default object (BR-AFF-001). - Return the read-only interested-party object, which resolves code descriptions through framework code collections when those properties are later read (BR-AFF-016).
Process flow¶
The following diagram shows the type-1 filtered, SSN-joined retrieval and the default-object fallback.
flowchart TD
Start(["Caller supplies policy, affiliate, effective date"]) --> Criteria["Build composite-key Criteria"]
Criteria --> Before["BeforeRetrieve: assign SQL-004<br>bind policy/affiliate/date against BUSINESS_AFFILIATE + AFFILIATE"]
Before --> Filter["SQL filters AFFILIATE_TYPE_CODE = 1<br>joins association to person by SSN"]
Filter --> Query{"Row returned?"}
Query -->|Yes| Fill["Fill base association, nested affiliate,<br>and interested-party fields"]
Query -->|No| Default["Return default object"]
Fill --> Result(["Return clsInterestedParty"])
Default --> Result
Failure and edge-case behavior¶
- The retrieve path is read-only; no persistence SQL is available through the criteria object.
Related documentation¶
Sources¶
Business\SAIF.Business.Policy.Affiliate\clsInterestedParty.vb