Resolve a code description¶
This operation documents how clsInterestedParty, clsInterestedPartyCollection, or clsCorporateOfficerExemption code-description membersfulfills the policy-affiliate behavior described forSAIF.Business.Policy.Affiliate`.
| Field | Value |
|---|---|
| Operation ID | OP-012 |
| Trigger | A caller reads an affiliate title, insured-code, or exemption-reason description property. |
| Inputs | Portal context plus stored code value on the current object |
| Outputs | Description string from the framework code collection |
| Primary components | clsInterestedParty, clsInterestedPartyCollection, or clsCorporateOfficerExemption code-description members |
| Entry point | Business\SAIF.Business.Policy.Affiliate\clsInterestedParty.vb |
Steps¶
- When the cached code collection is empty, request it from the framework for the relevant code table: AFFILIATE_TITLE_CODE, INSURED_CODE, or EXEMPT_REASON_CODE (BR-AFF-016).
- Cache the returned code collection on the current object or collection for reuse by later lookups.
- Index the collection by the stored code and return the description text for that code.
Process flow¶
The following diagram shows the cache-then-lookup pattern used to resolve a code description.
flowchart TD
Start(["Caller reads a description property"]) --> CacheCheck{"Cached code collection<br>already loaded?"}
CacheCheck -->|No| Request["Request framework code table:<br>AFFILIATE_TITLE_CODE, INSURED_CODE, or EXEMPT_REASON_CODE"]
Request --> Cache["Cache returned code collection<br>for reuse by later lookups"]
CacheCheck -->|Yes| Cache
Cache --> Index["Index collection by stored code"]
Index --> Result(["Return description text for that code"])
Failure and edge-case behavior¶
- The SQL text for these code-table reads lives in the framework package rather than in this library.
Related documentation¶
Sources¶
Business\SAIF.Business.Policy.Affiliate\clsInterestedParty.vb