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

# clsPremiumSetCollection

BOF collection of `clsPremiumSet` instances; groups premium set records for a policy period or combination period. Used by premium history and combination-period workflows to enumerate or aggregate premium sets.*

## Purpose
- Provides enumerable access to all premium set records for a policy period or combination.*
- Consumed by premium combination and history workflows that iterate over multiple premium sets to compute totals or produce reports.*

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

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| CurrentItem | `Public Shadows ReadOnly Property CurrentItem() As clsPremiumSet` | Business value exposed as current item for callers of this API.* |
| MostRecent | `Public ReadOnly Property MostRecent() As clsPremiumSet` | Business value exposed as most recent for callers of this API.* |
| Add | `Public Shadows Function Add(ByVal inPremiumSet As clsPremiumSet) As Integer` | Adds the supplied cls premium set to the collection. |
| Contains | `Public Overloads Function Contains(ByVal inPremiumSet As clsPremiumSet) As Boolean` | Checks whether the collection already contains the specified item or identifier. |
| Contains | `Public Overloads Function Contains(ByVal inPremiumSetID As Decimal) As Boolean` | Checks whether the collection already contains the specified item or identifier. |
| ContainsDeleted | `Public Overloads Function ContainsDeleted(ByVal inPremiumSet As clsPremiumSet) As Boolean` | Checks whether the collection's deleted-items list already contains the specified item or identifier. |
| ContainsDeleted | `Public Overloads Function ContainsDeleted(ByVal inPremiumSetID As Decimal) As Boolean` | Checks whether the collection's deleted-items list already contains the specified item or identifier. |
| Remove | `Public Sub Remove(ByVal inPremiumSet As clsPremiumSet)` | Removes the matching cls premium set from the collection. |
| Remove | `Public Sub Remove(ByVal inPremiumSetID As Decimal)` | Removes the matching cls premium set from the collection. |
| Where | `Public Function Where(ByVal match As Predicate(Of clsPremiumSet)) As clsPremiumSetCollection` | Returns a typed subset containing only items that satisfy the supplied predicate. |
| GetPremiumSets | `Public Shared Function GetPremiumSets(ByVal inDataportal As IDataPortalInfo, ByVal inCombinationPremiumSetId As Decimal, Optional ByRef inPeriodRatingInfo As iPeriodRatingInfo = Nothing, Optional ByVal inPremiumSetDatabase As PremiumSetDatabases = PremiumSetDatabases.Enterprise) As clsPremiumSetCollection` | Loads cls premium set collection for the supplied lookup criteria. |
| GetPremiumSets | `Public Shared Function GetPremiumSets(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNumber As Decimal, ByVal inPolicyPeriodEffectiveDate As Date, Optional ByRef inPeriodRatingInfo As iPeriodRatingInfo = Nothing, Optional ByVal inPremiumSetDatabase As PremiumSetDatabases = PremiumSetDatabases.Enterprise) As clsPremiumSetCollection` | Loads cls premium set collection for the supplied lookup criteria. |
| GetPremiumSetCollection | `Public Shared Function GetPremiumSetCollection(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNumber As Decimal, ByVal inPolicyPeriodEffectiveDate As Date, Optional ByRef inPeriodRatingInfo As iPeriodRatingInfo = Nothing, Optional ByVal inPremiumSetDatabase As PremiumSetDatabases = PremiumSetDatabases.Enterprise) As clsPremiumSetCollection` | Loads cls premium set 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\clsPremiumSetCollection.vb`.

## Constraints and usage notes
- Scoped to a single policy period or combination context; individual premium sets are retrieved or created through `clsPremiumSet` 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\clsPremiumSetCollection.vb`