--- title: clsAuditablePeriod summary: API reference for clsAuditablePeriod. status: draft owner: Technical Writer last_reviewed: 2026-07-31 library: SAIF.Business.Policy.Audit.Premium reference_type: package --- # clsAuditablePeriod Represents an auditable coverage span for a policy, aggregating related policy periods, prior periods, premium deltas, and audit history used by selection and synchronization logic. ## Purpose - Represents an auditable coverage span for a policy, aggregating related policy periods, prior periods, premium deltas, and audit history used by selection and synchronization logic. ## Context - Namespace: `SAIF.Business.Policy.Audit.Premium` - Assembly/package: `SAIF.BOF.Business.Policy.Audit.Premium` ## Public members | Member | Signature | Purpose | | --- | --- | --- | | AfterStandardPremiumAmount | `Public ReadOnly Property AfterStandardPremiumAmount() As Decimal` | Aggregates after standard premium amount across the related child records used by this type.* | | AuditResultChangeAmount | `Public ReadOnly Property AuditResultChangeAmount() As Decimal` | Aggregates audit result change amount across the related child records used by this type.* | | AuditablePeriodStartDate | `Public ReadOnly Property AuditablePeriodStartDate() As Date` | Persisted auditable period start date recorded on this business object. | | AuditablePeriodEndDate | `Public ReadOnly Property AuditablePeriodEndDate() As Date` | Persisted auditable period end date recorded on this business object. | | AuditPolicyPeriods | `Public ReadOnly Property AuditPolicyPeriods() As clsAuditPolicyPeriodCollection` | Audit policy periods that define the auditable span. | | Audits | `Public ReadOnly Property Audits() As clsAuditCollection` | Loads the audits associated with this auditable period. | | AuditTypeCode | `Public ReadOnly Property AuditTypeCode() As String` | Persisted audit type code used to identify or classify this business object. | | BeforeStandardPremiumAmount | `Public ReadOnly Property BeforeStandardPremiumAmount() As Decimal` | Aggregates before standard premium amount across the related child records used by this type.* | | CurrentStandardPremiumAmount | `Public ReadOnly Property CurrentStandardPremiumAmount() As Decimal` | Derives current standard premium amount from the current object state and related child data.* | | CurrentPremiumAmount | `Public ReadOnly Property CurrentPremiumAmount() As Decimal` | Derives current premium amount from the current object state and related child data.* | | DisplayUnauditedPeriod | `Public ReadOnly Property DisplayUnauditedPeriod() As String` | Formats the unaudited date range for display. | | EndingERModFactor | `Public ReadOnly Property EndingERModFactor() As Decimal` | Derives ending er mod factor from the current object state and related child data.* | | GoverningClassCode | `Public ReadOnly Property GoverningClassCode() As String` | Derives governing class code from the current object state and related child data.* | | HasClaimForZeroPayrollClass | `Public ReadOnly Property HasClaimForZeroPayrollClass() As Boolean` | Derived flag used by workflow logic to detect claim for zero payroll class from the current persisted state.* | | HasCompletedComplianceFinalAudit | `Public ReadOnly Property HasCompletedComplianceFinalAudit() As Boolean` | Derived flag used by workflow logic to detect completed compliance final audit from the current persisted state.* | | HasCompletedFinalAudit | `Public ReadOnly Property HasCompletedFinalAudit() As Boolean` | Derived flag used by workflow logic to detect completed final audit from the current persisted state.* | | HasNewPayrollClass | `Public ReadOnly Property HasNewPayrollClass() As Boolean` | Derived flag used by workflow logic to detect new payroll class from the current persisted state.* | | HasUnauditedPeriod | `Public ReadOnly Property HasUnauditedPeriod() As Boolean` | Derived flag used by workflow logic to detect unaudited period from the current persisted state.* | | IsCancelled | `Public ReadOnly Property IsCancelled() As Boolean` | Derived lifecycle flag used by workflow logic when the current record state must be treated as cancelled.* | | MaximumPayrollClassBaseRate | `Public ReadOnly Property MaximumPayrollClassBaseRate() As Decimal` | Derives maximum payroll class base rate from the current object state and related child data.* | | PayrollClasses | `Public ReadOnly Property PayrollClasses() As System.Collections.Generic.IEnumerable(Of String)` | Payroll class codes represented in this auditable period.* | | PolicyNumber | `Public ReadOnly Property PolicyNumber() As Decimal` | Persisted policy number used to identify or classify this business object. | | PremiumDeviationPercent | `Public ReadOnly Property PremiumDeviationPercent() As Decimal` | Derives premium deviation percent from the current object state and related child data.* | | PriorNonManagerCancelledAuditablePeriod | `Public ReadOnly Property PriorNonManagerCancelledAuditablePeriod As clsAuditablePeriod` | Meaning of `PriorNonManagerCancelledAuditablePeriod` could not be confirmed beyond its compiled implementation context.** | | PriorAuditablePeriod | `Public ReadOnly Property PriorAuditablePeriod() As clsAuditablePeriod` | Reference to the prior auditable period used for comparison and history. | | UnauditedEndDate | `Public ReadOnly Property UnauditedEndDate() As Date` | Returns the auditable period end date when an unaudited span exists; otherwise `Date.MinValue`. | | UnauditedStartDate | `Public ReadOnly Property UnauditedStartDate() As Date` | Derives unaudited start date from the current object state and related child data.* | | WaiverAmount | `Public ReadOnly Property WaiverAmount() As Decimal` | Aggregates waiver amount across the related child records used by this type.* | | IsValid | `Public Overrides ReadOnly Property IsValid() As Boolean` | Derived lifecycle flag used by workflow logic when the current record state must be treated as valid.* | | IsDirty | `Public Overrides ReadOnly Property IsDirty() As Boolean` | Derived lifecycle flag used by workflow logic when the current record state must be treated as dirty.* | | Equals | `Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Compares two values using the identity rules for this policy span eligible for audit type.* | | Equals | `Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Meaning of `Equals` could not be confirmed beyond its compiled implementation context.** | | Equals | `Public Overloads Function Equals(ByVal inObject As clsAuditablePeriod) As Boolean` | Returns `True` when the supplied object represents the same logical record. | | GetHashCode | `Public Overrides Function GetHashCode() As Integer` | Hash code derived from the identity fields of this policy span eligible for audit for keyed comparisons.* | | ToString | `Public Overrides Function ToString() As String` | String representation used when showing this policy span eligible for audit in lists or diagnostics.* | | NewAuditablePeriod | `Public Shared Function NewAuditablePeriod(ByVal inDataPortal As IDataPortalInfo, _` | Creates a new unsaved auditable period initialized with the data-portal context needed for validation and save operations. | ## Behavioral notes - This type is part of the premium-audit library's public surface. ## Constraints and usage notes > **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.Audit.Premium\clsAuditablePeriod.vb`