SAIF.Business.View.Policy API reference¶
This page lists every public type exposed by SAIF.Business.View.Policy. All types sit in the single root namespace SAIF.Business.View.Policy; the library declares no nested namespaces. Each type links to its full API reference page.
Policy header¶
| Type | Kind | Namespace | Purpose |
|---|---|---|---|
| clsPolicyData | Class | SAIF.Business.View.Policy |
Read-only policy header aggregate and the entry point for nearly every read in the library. |
| clsPolicyData.Criteria | Class | SAIF.Business.View.Policy |
Retrieval criteria and the SQL catalog for policy header and detail reads. |
Authorization¶
| Type | Kind | Namespace | Purpose |
|---|---|---|---|
| clsPolicySecurity | Class | SAIF.Business.View.Policy |
Decides whether the current principal may view a policy and produces the principal's permitted policy list. |
| clsPolicySecurity.IPolicySecurityDataProvider | Interface | SAIF.Business.View.Policy |
The policy attributes an authorization decision needs, expressed independently of clsPolicyData. |
| clsPolicySecurity.strPolicyList | Structure | SAIF.Business.View.Policy |
Policy number, name, and combined display text returned in permitted-policy lists. |
Supporting aggregates¶
| Type | Kind | Namespace | Purpose |
|---|---|---|---|
| clsAffiliatedPolicy | Class | SAIF.Business.View.Policy |
One row of a policy's affiliated-policy list, with lazy access to the full policy behind it. |
| clsAffiliatedPolicyCollection | Class | SAIF.Business.View.Policy |
The affiliated policies of one policy for a given affiliate type, with agent and agency filtering. |
| clsAgency | Class | SAIF.Business.View.Policy |
Agency and producing-agent contact information for a policy. |
| clsNonEmployerAccount | Class | SAIF.Business.View.Policy |
A non-employer account — an account holder that is not a policy — with explicit null-state helpers. |
| clsPolicyAddress | Class | SAIF.Business.View.Policy |
Policy-related addresses — mailing, claim, third-party manager, policyholder, and by location — plus the officer of notice. |
| clsPolicyPeriod | Class | SAIF.Business.View.Policy |
One policy period, with its dates, plan and rating codes, group attributes, and employer-liability limits. |
| clsPolicyPeriodCollection | Class | SAIF.Business.View.Policy |
The policy periods of a policy, including top-N retrieval and effective-at-date lookup. |
| clsTeamAssignment | Class | SAIF.Business.View.Policy |
One SAIF staff assignment to a policy, with the team function, the employee, and contact details. |
| clsTeamAssignmentCollection | Class | SAIF.Business.View.Policy |
The staff assignments on a policy, addressable by team function. |
| clsTradingAs | Class | SAIF.Business.View.Policy |
One registered "trading as" (DBA) name on a policy, with its effective and cancellation dates. |
| clsTradingAsCollection | Class | SAIF.Business.View.Policy |
The trading-as names registered against a policy, with predicate filtering. |
| clsAffiliatedPolicyCollection.Criteria | Class | SAIF.Business.View.Policy |
Retrieval criteria for a policy's affiliated-policy list. |
| clsAgency.Criteria | Class | SAIF.Business.View.Policy |
Retrieval criteria for the agency attached to a policy. |
| clsPolicyAddress.Criteria | Class | SAIF.Business.View.Policy |
Retrieval criteria for a policy address. |
| clsPolicyPeriod.Criteria | Class | SAIF.Business.View.Policy |
Retrieval criteria for a single policy period. |
| clsPolicyPeriodCollection.Criteria | Class | SAIF.Business.View.Policy |
Retrieval criteria for a policy's policy-period list. |
| clsTeamAssignmentCollection.Criteria | Class | SAIF.Business.View.Policy |
Retrieval criteria for a policy's team assignments. |
Associations¶
| Type | Kind | Namespace | Purpose |
|---|---|---|---|
| AssociationTypeExtensions | Module | SAIF.Business.View.Policy |
Predicates over association types, including the secured-type test. |
| clsAssociationType | Class | SAIF.Business.View.Policy |
Lightweight association-type adapter that retrieves associations without a code-table read. |
| clsAssociationTypeCode | Class | SAIF.Business.View.Policy |
Code-table-backed association type: code, category, description, security group, and source procedure. |
| clsAssociationTypeCodeCollection | Class | SAIF.Business.View.Policy |
Loader for the association type code table. |
| clsAssociationTypeFactory | Class | SAIF.Business.View.Policy |
Supplies association type instances, including the two rating-combination types. |
| clsPolicyAssociation | Class | SAIF.Business.View.Policy |
A policy-header association: the related policy with enough header detail to display it. |
| clsPolicyHeaderAssociationFactory | Class | SAIF.Business.View.Policy |
Builds the policy-header associations for a policy, optionally restricted to selected types. |
| PolicyAssociation | Class | SAIF.Business.View.Policy |
An immutable record that one policy is associated with another, and on which side. |
| PolicyAssociationExtensions | Module | SAIF.Business.View.Policy |
Query helpers over association sequences. |
| PolicyAssociationList | Class | SAIF.Business.View.Policy |
Retrieves and holds the complete association set for a policy across all four association sources. |
| clsAssociationTypeCode.clsUnknownAssociationTypeCode | Class | SAIF.Business.View.Policy |
Null-object association type returned when a code is not recognised. |
| clsAssociationTypeCode.NonTypedAssociation | Class | SAIF.Business.View.Policy |
Row-shaped carrier for association data returned by a source procedure before it is typed. |
Enumerations and helper modules¶
| Type | Kind | Namespace | Purpose |
|---|---|---|---|
| AffiliateTypeExtensions | Module | SAIF.Business.View.Policy |
Converts an affiliate type into its equivalent association type. |
| AssociationTypes | Enum | SAIF.Business.View.Policy |
The kinds of relationship one policy can have with another. |
| PolicyStatusEnums | Module | SAIF.Business.View.Policy |
Policy status and status-group codes with their code-to-enum conversions. |
| clsPolicyAddress.YesNoFlag | Enum | SAIF.Business.View.Policy |
Y or N option controlling the claim-address mailing fallback. |
| clsPolicyData.AffiliateTypes | Enum | SAIF.Business.View.Policy |
Parent and member affiliation classifications for a policy. |
| clsPolicyData.UserAccessLevels | Enum | SAIF.Business.View.Policy |
Ranked visibility levels that decide how much policy data a caller receives. |
| clsTeamAssignment.EmployeeStatuses | Enum | SAIF.Business.View.Policy |
Employment status classifications for an assigned employee. |
| clsTeamAssignmentCollection.TeamFunctions | Enum | SAIF.Business.View.Policy |
The staff roles that can be assigned to a policy. |
| PolicyStatusEnums.Statuses | Enum | SAIF.Business.View.Policy |
The states a policy can be in. |
| PolicyStatusEnums.StatusGroups | Enum | SAIF.Business.View.Policy |
Coarse groupings of policy status for filtering and display. |
Generated types¶
| Type | Kind | Namespace | Purpose |
|---|---|---|---|
| Institutions | Typed DataSet | SAIF.Business.View.Policy |
Generated banking-institution dataset with no hand-written behaviour. |
Types not part of the public surface¶
Six .vb files sit in the project folder but are excluded from the <Compile> item group, so they are not part of the shipped assembly and are not documented here: clsMCOCollection.vb, clsPolicyMCO.vb, clsPolicyMCOCollection.vb, clsPayrollClassInfo.vb, clsPayrollClassInfoCollection.vb, and clsPolicySearch.vb.
Several nested Criteria classes are declared Friend and are therefore not callable from outside the assembly; they are consumed only through the shared factory methods of their containing types.
Related documentation¶
- Index
- Overview
- Architecture
- Dependencies
- Operations and processes
- Business rules
- Security and authorization
- Database tables
- SQL catalog
- Procedures
- Configuration
Sources¶
Business/SAIF.Business.View.Policy/SAIF.BOF.Business.View.Policy.vbproj