clsPolicyPeriodFederalCoverage¶
Represents federal coverage data for a policy period; holds federal jurisdiction flags and premium totals for federal reporting and compliance workflows.*
Purpose¶
- Persists and retrieves federal coverage flags and premium totals for a policy period.*
- Consumed by federal reporting workflows that require jurisdiction-specific premium and coverage data.*
Context¶
- Namespace:
SAIF.Business.Policy.Premium - Assembly/package:
SAIF.Business.Policy.Premium
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| PolicyNumber | Public ReadOnly Property PolicyNumber() As Decimal |
The numeric policy number identifying the policy to which this record belongs. |
| PolicyPeriodEffectiveDate | Public ReadOnly Property PolicyPeriodEffectiveDate() As Date |
The effective date of the policy period to which this rating plan applies. |
| FederalCoverageTypeCode | Public Property FederalCoverageTypeCode() As String |
Stores the Oracle code value that classifies this cls Policy Period Federal Coverage. |
| FederalCoverageType | Public Property FederalCoverageType() As clsFederalCoverageTypeCode.FederalCoverageTypes |
Lookup object that describes the current federal coverage type.* |
| FederalCoverageTypeDescriptions | Public ReadOnly Property FederalCoverageTypeDescriptions As clsCodeCollection |
Returns the associated federal coverage type descriptions used by this type. |
| FederalCoverageTypeDescription | Public ReadOnly Property FederalCoverageTypeDescription As String |
Human-readable description associated with the current federal coverage type.* |
| FederalCoverageEffectiveDate | Public Property FederalCoverageEffectiveDate() As Date |
Business value exposed as federal coverage effective date for callers of this API.* |
| CreateDate | Public Property CreateDate() As Date |
The timestamp at which this record was created in the Oracle database. |
| CreateUser | Public Property CreateUser() As String |
The username of the account that created this record. |
| FederalCoverageExpirationDate | Public Property FederalCoverageExpirationDate() As Date |
Business value exposed as federal coverage expiration date for callers of this API.* |
| FederalLiabilityLimitSeqNum | Public Property FederalLiabilityLimitSeqNum() As Decimal |
Identifier used to correlate this row with related premium records.* |
| FederalCoverageLiabilityLimit | Public ReadOnly Property FederalCoverageLiabilityLimit() As clsFederalCoverageLiabilityLimit |
Business value exposed as federal coverage liability limit for callers of this API.* |
| OperationsDescription | Public Property OperationsDescription() As String |
Human-readable description associated with the current operations.* |
| EmployeesDescription | Public Property EmployeesDescription() As String |
Human-readable description associated with the current employees.* |
| UpdateDate | Public Property UpdateDate() As Date |
The timestamp of the most recent update to this record.* |
| UpdateUser | Public Property UpdateUser() As String |
The username of the account that last modified this record.* |
| CodeDescr | Public Property CodeDescr As String |
Business value exposed as code descr for callers of this API.* |
| IsValid | Public Overrides ReadOnly Property IsValid() As Boolean |
Returns True when all registered business rules pass; delegates to the framework rule engine. |
| IsDirty | Public Overrides ReadOnly Property IsDirty() As Boolean |
Returns True when one or more tracked properties have been modified since the last save or MarkOld() call. |
| SetFederalCoverageExpirationDateNull | Public Sub SetFederalCoverageExpirationDateNull() |
Clears FederalCoverageExpirationDate, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetFederalLiabilityLimitSeqNumNull | Public Sub SetFederalLiabilityLimitSeqNumNull() |
Clears FederalLiabilityLimitSeqNum, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetOperationsDescriptionNull | Public Sub SetOperationsDescriptionNull() |
Clears OperationsDescription, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetEmployeesDescriptionNull | Public Sub SetEmployeesDescriptionNull() |
Clears EmployeesDescription, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetUpdateDateNull | Public Sub SetUpdateDateNull() |
Clears UpdateDate, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetUpdateUserNull | Public Sub SetUpdateUserNull() |
Clears UpdateUser, marking it as null/unset so the column will be written as NULL on the next save.* |
| IsFederalCoverageExpirationDateNull | Public Function IsFederalCoverageExpirationDateNull() As Boolean |
Tests whether FederalCoverageExpirationDate is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsFederalLiabilityLimitSeqNumNull | Public Function IsFederalLiabilityLimitSeqNumNull() As Boolean |
Tests whether FederalLiabilityLimitSeqNum is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsOperationsDescriptionNull | Public Function IsOperationsDescriptionNull() As Boolean |
Tests whether OperationsDescription is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsEmployeesDescriptionNull | Public Function IsEmployeesDescriptionNull() As Boolean |
Tests whether EmployeesDescription is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsUpdateDateNull | Public Function IsUpdateDateNull() As Boolean |
Tests whether UpdateDate is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsUpdateUserNull | Public Function IsUpdateUserNull() As Boolean |
Tests whether UpdateUser is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| Equals | Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean |
Static overload: compares two Object references for equality using value-equality semantics.* |
| Equals | Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean |
Compares this instance with another Object instance for value equality.* |
| Equals | Public Overloads Function Equals(ByVal inObject As clsPolicyPeriodFederalCoverage) As Boolean |
Compares this instance with another clsPolicyPeriodFederalCoverage instance for value equality.* |
| GetHashCode | Public Overrides Function GetHashCode() As Integer |
Returns a hash code consistent with the value-equality implementation. |
| ToString | Public Overrides Function ToString() As String |
Returns a string representation of this instance, typically for diagnostics.* |
| NewPolicyPeriodFederalCoverage | Public Shared Function NewPolicyPeriodFederalCoverage(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNum As Decimal, ByVal inPolicyPeriodEffDate As Date, ByVal inFedCoverageTypeCode As String, ByVal inFedCoverageEffDate As Date) As clsPolicyPeriodFederalCoverage |
Creates a new cls policy period federal coverage initialized from the supplied source values.* |
| GetPolicyPeriodFederalCoverage | Public Shared Function GetPolicyPeriodFederalCoverage(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNum As Decimal, ByVal inPolicyPeriodEffDate As Date, ByVal inFedCoverageTypeCode As String, ByVal inFedCoverageEffDate As Date) As clsPolicyPeriodFederalCoverage |
Loads a cls policy period federal coverage that matches the supplied lookup criteria. |
| ## Inherited public members |
| Member | Signature | Purpose | Origin |
|---|---|---|---|
| Rules | Property Rules As clsRulesManager |
Framework rules manager used to register, evaluate, and surface broken rules on the object.† | SAIF.Framework.Core — clsBusinessBase |
| BeginEdit | Sub BeginEdit() |
Starts an n-level edit session so callers can stage changes.† | SAIF.Framework.Core — clsBusinessBase |
| CancelEdit | Sub CancelEdit() |
Rolls back the active edit session.† | SAIF.Framework.Core — clsBusinessBase |
| ApplyEdit | Sub ApplyEdit() |
Commits the active edit session.† | SAIF.Framework.Core — clsBusinessBase |
Behavioral notes¶
- Source file:
Business\SAIF.Business.Policy.Premium\clsPolicyPeriodFederalCoverage.vb.
Constraints and usage notes¶
- Federal coverage records are scoped to a specific policy period; multiple federal coverage entries may exist per period for different jurisdictions.*
Note: Statements marked with * were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with ** could not be confirmed; treat as unknown until verified.
Sources¶
Business\SAIF.Business.Policy.Premium\clsPolicyPeriodFederalCoverage.vb