clsPolicyPeriod¶
clsPolicyPeriod is a single term of coverage on a policy. It carries the effective and expiration dates that bound the term, the plan, rating and risk codes that price it, the group and chapter attributes that place it in a group programme, the employer-liability limits it was written at, and the final evaluation date used downstream. Periods are what let the rest of the library answer questions about a policy as at a particular date rather than only as at today.
Purpose¶
- Describes one term of coverage on a policy, including the dates that bound it (Retrieve policy header).
- Reports whether it is the current or the renewal period, which is how consumers pick a period without date arithmetic (BR-014).
- Carries the employer-liability limits, both individually and as a combined display string.*
Context¶
- Namespace:
SAIF.Business.View.Policy - Assembly/package:
SAIF.BOF.Business.View.Policy - Declared in:
Business/SAIF.Business.View.Policy/clsPolicyPeriod.vb
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| ndReimbFlag | Public ReadOnly Property ndReimbFlag() As String |
Y or N indicator recording whether non-disabling reimbursement applies to the policy period.* |
| ndReimbEff | Public ReadOnly Property ndReimbEff() As String |
The non-disabling reimbursement effective recorded on the policy period.* |
| ndReimbExp | Public ReadOnly Property ndReimbExp() As String |
The non-disabling reimbursement expiration recorded on the policy period.* |
| ndReimbFreq | Public ReadOnly Property ndReimbFreq As String |
How often the non-disabling reimbursement occurs for the policy period.* |
| FinancialSystemCode | Public ReadOnly Property FinancialSystemCode() As String |
Coded value classifying the financial system of the policy period.* |
| PayrollReportFrequencyCode | Public ReadOnly Property PayrollReportFrequencyCode() As String |
Coded value classifying the payroll report frequency of the policy period.* |
| PolicyPeriodExpDate | Public ReadOnly Property PolicyPeriodExpDate() As String |
The policy period expiration date recorded on the policy period.* |
| RatingPlanFactor | Public ReadOnly Property RatingPlanFactor() As Decimal |
Rating factor applied to the policy period when the rating plan component is priced.* |
| SarapFactor | Public ReadOnly Property SarapFactor() As Decimal |
Rating factor applied to the policy period when the SARAP component is priced.* |
| RiskTypeFactor | Public ReadOnly Property RiskTypeFactor() As Decimal |
Rating factor applied to the policy period when the risk type component is priced.* |
| SetID | Public ReadOnly Property SetID() As Decimal |
Records the identifier to apply to the policy period.* |
| PayrollReportFrequency | Public ReadOnly Property PayrollReportFrequency() As String |
How often the payroll report occurs for the policy period.* |
| PolicySuffix | Public ReadOnly Property PolicySuffix() As String |
The policy suffix recorded on the policy period.* |
| PolicyPeriodStatus | Public ReadOnly Property PolicyPeriodStatus() As String |
The policy period status recorded on the policy period.* |
| FinalEvalDate | Public Property FinalEvalDate() As Date |
The date at which the term's experience is finally evaluated; settable so consumers can project an evaluation.* |
| GroupChapter | Public ReadOnly Property GroupChapter() As String |
The group chapter recorded on the policy period.* |
| GroupType | Public ReadOnly Property GroupType() As String |
Classification of the group of the policy period.* |
| GroupName | Public ReadOnly Property GroupName() As String |
Name of the group recorded against the policy period.* |
| GroupTermDate | Public ReadOnly Property GroupTermDate As Date |
The group term date recorded on the policy period.* |
| AnniversaryRateDate | Public ReadOnly Property AnniversaryRateDate() As String |
The anniversary rate date recorded on the policy period.* |
| RatingEffectiveDate | Public ReadOnly Property RatingEffectiveDate() As String |
The rating effective date recorded on the policy period.* |
| PolicyPeriodEffDate | Public ReadOnly Property PolicyPeriodEffDate() As String |
The policy period effective date recorded on the policy period.* |
| PolicyNum | Public ReadOnly Property PolicyNum() As Decimal |
Identifier of the policy attached to the policy period.* |
| CancelDate | Public ReadOnly Property CancelDate() As String |
The cancel date recorded on the policy period.* |
| RiskTypeCode | Public ReadOnly Property RiskTypeCode() As String |
Coded value classifying the risk type of the policy period.* |
| SourceSystem | Public ReadOnly Property SourceSystem() As String |
The source system recorded on the policy period.* |
| OtherStatesPolicyNum | Public ReadOnly Property OtherStatesPolicyNum As String |
Identifier of the other states policy attached to the policy period.* |
| OtherStatesPolicyPeriodEffDate | Public ReadOnly Property OtherStatesPolicyPeriodEffDate As String |
The other states policy period effective date recorded on the policy period.* |
| OtherStatesPolicyPeriodExpDate | Public ReadOnly Property OtherStatesPolicyPeriodExpDate As String |
The other states policy period expiration date recorded on the policy period.* |
| PlanCode | Public ReadOnly Property PlanCode() As String |
Coded value classifying the plan of the policy period.* |
| RatingPlanCode | Public ReadOnly Property RatingPlanCode() As String |
Coded value classifying the rating plan of the policy period.* |
| StandardPremium | Public ReadOnly Property StandardPremium() As Decimal |
Monetary standard premium carried on the policy period.* |
| PeriodLength | Public ReadOnly Property PeriodLength() As Decimal |
The period length recorded on the policy period.* |
| PrepaidFreq | Public ReadOnly Property PrepaidFreq() As String |
How often the prepaid occurs for the policy period.* |
| PaymentPlanDescr | Public ReadOnly Property PaymentPlanDescr() As String |
Readable text describing the payment plan of the policy period.* |
| EmployerLiabStatCode | Public ReadOnly Property EmployerLiabStatCode() As String |
Coded value classifying the employer liability statutory of the policy period.* |
| EmployerLiabLimit1 | Public ReadOnly Property EmployerLiabLimit1() As String |
The employer liability limit1 recorded on the policy period.* |
| EmployerLiabLimit2 | Public ReadOnly Property EmployerLiabLimit2() As String |
The employer liability limit2 recorded on the policy period.* |
| EmployerLiabLimit3 | Public ReadOnly Property EmployerLiabLimit3() As String |
The employer liability limit3 recorded on the policy period.* |
| EmployerLiabLimits | Public ReadOnly Property EmployerLiabLimits() As String |
The three employer-liability limits combined into the single string a document displays.* |
| PayrollClass | Public ReadOnly Property PayrollClass() As String |
The payroll class recorded on the policy period.* |
| SortBy | Public Property SortBy() As String |
The key the containing collection orders this term by.* |
| isCurrentPolicyPeriod | Public ReadOnly Property isCurrentPolicyPeriod() As Boolean |
True when this term is the one in force today (BR-014). |
| isRenewalPolicyPeriod | Public ReadOnly Property isRenewalPolicyPeriod As Boolean |
True when this term renews the preceding one rather than starting new coverage.* |
| MyCriteria | Public ReadOnly Property MyCriteria() As Criteria |
The criteria this instance was retrieved with. |
| IsValid | Public Overrides ReadOnly Property IsValid() As Boolean |
False when no policy period row was found. |
| IsSavable | Public Overrides ReadOnly Property IsSavable() As Boolean |
Always false: policy periods are read-only in this library. |
| IsFinalEvalDateNull | Public Function IsFinalEvalDateNull() As Boolean |
True when final eval date null applies to the policy period.* |
| Equals | Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean |
Compares two instances for equality without requiring either reference to be non-null. |
| Equals | Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean |
Compares this instance with an arbitrary object. |
| Equals | Public Overloads Function Equals(ByVal inObject As clsPolicyPeriod) As Boolean |
Compares this instance with another of the same type. |
| GetHashCode | Public Overrides Function GetHashCode() As Integer |
Hashes on the same values that define equality for this type. |
| ToString | Public Overrides Function ToString() As String |
Renders the instance for logging and debugging.* |
Inherited public members¶
Members in this section are inherited from clsBusinessBase in SAIF.Framework.Core. They are available on this type through inheritance.
| Member | Signature | Purpose | Origin |
|---|---|---|---|
| BrokenRulesCollection | Public ReadOnly Property BrokenRulesCollection() As clsBrokenRulesCollection |
Carries the messages for the rules currently broken, which is what drives IsValid to false.† |
SAIF.Framework.Core — clsBusinessBase |
Note: Statements marked with
†are derived from dependency library documentation via the Legends CLI. Statements marked with*were inferred from code structure or contextual evidence. Statements marked with**could not be confirmed; treat as unknown until verified.
Sources¶
Business/SAIF.Business.View.Policy/clsPolicyPeriod.vb