﻿---
title: clsPolicyPeriodRatingPlanCollection
summary: API reference for clsPolicyPeriodRatingPlanCollection.
status: draft
owner: Technical Writer
last_reviewed: 2026-07-31
library: SAIF.Business.Policy.Premium
reference_type: package
---

# clsPolicyPeriodRatingPlanCollection

BOF collection of `clsPolicyPeriodRatingPlan` instances; groups rating plan records across multiple periods for a policy. Used to enumerate historical or concurrent rating plans for a policy.*

## Purpose
- Provides enumerable access to all rating plan records across policy periods for a given policy.*
- Consumed by rating plan history and reporting workflows that need to compare or audit rating plan changes over time.*

## Context
- Namespace: `SAIF.Business.Policy.Premium`
- Assembly/package: `SAIF.Business.Policy.Premium`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| CurrentItem | `Public Shadows ReadOnly Property CurrentItem() As clsPolicyPeriodRatingPlan` | Business value exposed as current item for callers of this API.* |
| MyCriteria | `Public ReadOnly Property MyCriteria() As Criteria` | The criteria object used to retrieve this instance; useful for re-fetching or reloading.* |
| PeriodRatingInfo | `Public Property PeriodRatingInfo() As iPeriodRatingInfo` | Returns the policy-period rating context used to load and evaluate premium data. |
| Save | `Public Overrides Function Save() As Boolean` | Persists this instance and all child objects to Oracle through the BOF data portal; returns True on success. |
| Add | `Public Shadows Function Add(ByVal inPolicyPeriodRatingPlan As clsPolicyPeriodRatingPlan) As Integer` | Adds the supplied cls policy period rating plan to the collection. |
| Contains | `Public Overloads Function Contains(ByVal inPolicyPeriodRatingPlan As clsPolicyPeriodRatingPlan) As Boolean` | Checks whether the collection already contains the specified item or identifier. |
| Contains | `Public Overloads Function Contains(ByVal inRatingPlanEffectiveDate As Object) As Boolean` | Checks whether the collection already contains the specified item or identifier. |
| ContainsDeleted | `Public Overloads Function ContainsDeleted(ByVal inPolicyPeriodRatingPlan As clsPolicyPeriodRatingPlan) As Boolean` | Checks whether the collection's deleted-items list already contains the specified item or identifier. |
| ContainsDeleted | `Public Overloads Function ContainsDeleted(ByVal inRatingPlanEffectiveDate As Object) As Boolean` | Checks whether the collection's deleted-items list already contains the specified item or identifier. |
| Remove | `Public Sub Remove(ByVal inPolicyPeriodRatingPlan As clsPolicyPeriodRatingPlan)` | Removes the matching cls policy period rating plan from the collection. |
| Remove | `Public Sub Remove(ByVal inRatingPlanEffectiveDate As Object)` | Removes the matching cls policy period rating plan from the collection. |
| Where | `Public Function Where(ByVal match As Predicate(Of clsPolicyPeriodRatingPlan)) As clsPolicyPeriodRatingPlanCollection` | Returns a typed subset containing only items that satisfy the supplied predicate. |
| GetPolicyPeriodRatingPlans | `Public Shared Function GetPolicyPeriodRatingPlans(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNumber As Decimal, ByVal inPolicyPeriodEffectiveDate As Date, Optional ByRef inPeriodRatingInfo As iPeriodRatingInfo = Nothing) As clsPolicyPeriodRatingPlanCollection` | Loads cls policy period rating plan collection for the supplied lookup criteria. |
| GetPolicyPeriodRatingPlansView | `Public Shared Function GetPolicyPeriodRatingPlansView(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNumber As Decimal, ByVal inPolicyPeriodEffectiveDate As Date, ByVal inUpdatePolicyDbOK As Boolean, Optional ByRef inPeriodRatingInfo As iPeriodRatingInfo = Nothing) As clsPolicyPeriodRatingPlanCollection` | Loads cls policy period rating plan collection for the supplied lookup criteria. |
## Inherited public members

| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| First | `Sub First()` | Moves traversal to the first item in the BOF collection.† | `SAIF.Framework.Core — clsBusinessCollectionBase` |
| Last | `Sub Last()` | Moves traversal to the last item in the BOF collection.† | `SAIF.Framework.Core — clsBusinessCollectionBase` |
| Next | `Sub Next()` | Advances traversal to the next item.† | `SAIF.Framework.Core — clsBusinessCollectionBase` |
| Previous | `Sub Previous()` | Moves traversal to the previous item.† | `SAIF.Framework.Core — clsBusinessCollectionBase` |

## Behavioral notes
- Source file: `Business\SAIF.Business.Policy.Premium\clsPolicyPeriodRatingPlanCollection.vb`.

## Constraints and usage notes
- Scoped to a single policy; individual rating plan entries are retrieved or modified through `clsPolicyPeriodRatingPlan` factory methods.*


> **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\clsPolicyPeriodRatingPlanCollection.vb`