---
title: clsPolicyUnitCollection
summary: API reference for clsPolicyUnitCollection.
status: draft
owner: SAIF
last_reviewed: 2026-07-24
library: SAIF.Business.UnitStat
reference_type: package
---

# clsPolicyUnitCollection

Collection wrapper for policy-unit aggregates.

## Purpose

- Retrieve policy units by policy or policy period.

## Context

- Namespace: `SAIF.Business.UnitStat`
- Assembly/package: `SAIF.Business.UnitStat` (distributed as NuGet package `SAIF.BOF.Business.UnitStat`)

## Public members

| Member | Signature | Purpose |
| --- | --- | --- |
| `CurrentItem` | `Public Shadows ReadOnly Property CurrentItem() As clsPolicyUnit` | Gets current item. |
| `Save` | `Public Overrides Function Save() As Boolean` | Executes the member operation. |
| `Add` | `Public Shadows Function Add(ByVal inPolicyUnit As clsPolicyUnit) As Integer` | Executes the member operation. |
| `Contains` | `Public Overloads Function Contains(ByVal inPolicyUnit As clsPolicyUnit) As Boolean` | Executes the member operation. |
| `Contains` | `Public Overloads Function Contains(ByVal inPolicyUnitSeqNum As Decimal) As Boolean` | Executes the member operation. |
| `Contains` | `Public Overloads Function Contains(ByVal inPolicyNumber As Decimal, ByVal inPolicyPeriodEffectiveDate As Date, ByVal inUnitEffectiveDate As Date) As Boolean` | Executes the member operation. |
| `ContainsDeleted` | `Public Overloads Function ContainsDeleted(ByVal inPolicyUnit As clsPolicyUnit) As Boolean` | Executes the member operation. |
| `ContainsDeleted` | `Public Overloads Function ContainsDeleted(ByVal inPolicyUnitSeqNum As Decimal) As Boolean` | Executes the member operation. |
| `ContainsDeleted` | `Public Overloads Function ContainsDeleted(ByVal inPolicyNumber As Decimal, ByVal inPolicyPeriodEffectiveDate As Date, ByVal inUnitEffectiveDate As Date) As Boolean` | Executes the member operation. |
| `NewPolicyUnitCollection` | `Public Shared Function NewPolicyUnitCollection(ByVal inDataportal As IDataPortalInfo) As clsPolicyUnitCollection` | Creates a new policy unit collection instance. |
| `GetPolicyUnits` | `Public Shared Function GetPolicyUnits(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNumber As Decimal) As clsPolicyUnitCollection` | Retrieves policy units. |
| `GetPolicyUnits` | `Public Shared Function GetPolicyUnits(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNumber As Decimal, ByVal inPolicyPeriodEffectiveDate As Date) As clsPolicyUnitCollection` | Retrieves policy units. |
| `ToString` | `Public Overrides Function ToString() As String` | Executes the member operation. |
| `PolicyNumber` | `Public Property PolicyNumber() As Decimal` | Gets or sets policy number. |
| `PolicyPeriodEffectiveDate` | `Public Property PolicyPeriodEffectiveDate() As Date` | Gets or sets policy period effective date. |
| `RetrieveType` | `Public Property RetrieveType() As RetrieveTypes` | Gets or sets retrieve type. |
| `IsRetrieveByPolicy` | `Public ReadOnly Property IsRetrieveByPolicy() As Boolean` | Indicates whether retrieve by policy. |
| `IsRetrieveByPolicyPeriod` | `Public ReadOnly Property IsRetrieveByPolicyPeriod() As Boolean` | Indicates whether retrieve by policy period. |
| `IsRetrieveByLossEditFlag` | `Public ReadOnly Property IsRetrieveByLossEditFlag() As Boolean` | Indicates whether retrieve by loss edit flag. |

## Inherited public members

Members in this section are inherited from `clsBusinessCollectionBase` in `SAIF.BOF.Framework`. They are available on this type through inheritance.

| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| `MyGuid` | `ReadOnly Property MyGuid() As String` | Gets the framework GUID assigned to the collection. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `ItemByGuid` | `ReadOnly Property ItemByGuid(ByVal inGuid As String) As clsBusinessBase` | Gets a child item by framework GUID. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `Rules` | `ReadOnly Property Rules() As clsRulesManager` | Gets the rules manager attached to the collection. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `ErrorCount` | `ReadOnly Property ErrorCount() As Integer` | Gets the current validation error count. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `ErrorMessages` | `ReadOnly Property ErrorMessages() As String()` | Gets the current validation error messages. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `WarningCount` | `ReadOnly Property WarningCount() As Integer` | Gets the current validation warning count. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `WarningMessages` | `ReadOnly Property WarningMessages() As String()` | Gets the current validation warning messages. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `BeginEdit` | `Sub BeginEdit()` | Begins an editable snapshot for the collection. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `CancelEdit` | `Sub CancelEdit()` | Restores the prior editable snapshot for the collection. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `ApplyEdit` | `Sub ApplyEdit()` | Commits the current editable snapshot for the collection. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `Clone` | `Function Clone() As Object` | Creates a clone of the collection. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `IsManaged` | `ReadOnly Property IsManaged() As Boolean` | Indicates whether the collection uses managed save behavior. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `CurrentIndex` | `ReadOnly Property CurrentIndex() As Integer` | Gets the current traversal index. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `XMLElementName` | `Property XMLElementName() As String` | Gets or sets the XML element name used by framework serialization. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `XMLItemName` | `Property XMLItemName() As String` | Gets or sets the serialized item element name. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `GetReportXML` | `Function GetReportXML(Optional ByVal inFileStream As System.IO.StreamWriter = Nothing) As String` | Returns framework report XML for the collection. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |
| `ToXML` | `Function ToXML() As String` | Serializes the collection to XML. | `SAIF.BOF.Framework — clsBusinessCollectionBase` |

## Behavioral notes

- Collection retrieval uses `US_POLICY_UNIT` selectors described in the SQL catalog.

## Constraints and usage notes

- Collection criteria include policy, policy-period, and loss-edit retrieval modes.

## Sources

- `Business\SAIF.Business.UnitStat\clsPolicyUnitCollection.vb`
- `Legacy\BusinessObjectFramework\clsBusinessCollectionBase.vb`