---
title: clsBenefitPeriodCollection
summary: API reference for clsBenefitPeriodCollection.
status: draft
owner: SAIF Doc Gen
last_reviewed: 2026-07-28
library: SAIF.Business.Claim.Payment
reference_type: package
---

# clsBenefitPeriodCollection

`clsBenefitPeriodCollection` represents a collection of benefit period records used in claim payment processing, with lookup and list-management operations.*

## Purpose
- Holds benefit period records used by the surrounding workflow.*
- Supports indexed lookup and membership checks for the contained items.*
- Provides factory or retrieval entry points for building the collection.*

## Context
- Namespace: `SAIF.Business.Claim.Payment`
- Assembly/package: `SAIF.Business.Claim.Payment`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `TotalOffsetAmount` | `Public ReadOnly Property TotalOffsetAmount() As Decimal` | Returns total offset amount. |
| `TotalInterestAmount` | `Public ReadOnly Property TotalInterestAmount() As Decimal` | Returns total interest amount. |
| `TotalBenefitAmount` | `Public ReadOnly Property TotalBenefitAmount() As Decimal '` | Returns total benefit amount. |
| `TotalPrevioiusPaidAmount` | `Public ReadOnly Property TotalPrevioiusPaidAmount() As Decimal` | Returns total previoius paid amount. |
| `HasOverlappingPeriods` | `Public ReadOnly Property HasOverlappingPeriods() As Boolean` | Returns has overlapping periods. |
| `Item` | `Default Public ReadOnly Property Item(ByVal Index As Integer) As clsBenefitPeriod` | Returns item. |
| `Item` | `Default Public ReadOnly Property Item(ByVal inGuid As String) As clsBenefitPeriod` | Returns item. |
| `Item` | `Default Public ReadOnly Property Item(ByVal inBenefitPeriodID As Decimal) As clsBenefitPeriod` | Returns item. |
| `Add` | `Public Shadows Function Add(ByVal inClaimBenefitPeriod As clsBenefitPeriod) As Integer` | Executes the `Add` operation. |
| `Contains` | `Public Overloads Function Contains(ByVal inClaimBenefitPeriod As clsBenefitPeriod) As Boolean` | Exposes the public member. |
| `Contains` | `Public Overloads Function Contains(ByVal inBenefitPeriodID As Decimal) As Boolean` | Exposes the public member. |
| `Contains` | `Public Overloads Function Contains(ByVal inPeriodFromDate As Date, ByVal inPeriodThruDate As Date, _` | Exposes the public member. |
| `ContainsDeleted` | `Public Overloads Function ContainsDeleted(ByVal inClaimBenefitPeriod As clsBenefitPeriod) As Boolean` | Exposes the public member. |
| `ContainsDeleted` | `Public Overloads Function ContainsDeleted(ByVal inBenefitPeriodID As Decimal) As Boolean` | Exposes the public member. |
| `DateInPeriod` | `Public Function DateInPeriod(ByVal inWaitDate As Date) As Boolean` | Exposes the public member. |
| `ToList` | `Public Function ToList() As List(Of clsBenefitPeriod)` | Exposes the public member. |
| `Remove` | `Public Sub Remove(ByVal inClaimBenefitPeriod As clsBenefitPeriod)` | Executes the `Remove` operation. |
| `RemoveAll` | `Public Function RemoveAll(ByVal match As Predicate(Of clsBenefitPeriod)) As Integer` | Executes the `RemoveAll` operation. |
| `GetClaimBenefitPeriodCollection` | `Public Shared Function GetClaimBenefitPeriodCollection(ByVal inDataportal As IDataPortalInfo, _` | Retrieves the `GetClaimBenefitPeriodCollection` operation. |
| `NewClaimBenefitPeriodCollection` | `Public Shared Function NewClaimBenefitPeriodCollection(ByVal inDataportal As IDataPortalInfo, _` | Executes the `NewClaimBenefitPeriodCollection` operation. |

## Inherited public members

| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| `MyGuid` | `Public ReadOnly Property MyGuid() As String` | Returns the collection's generated GUID identifier.† | `Legacy\BusinessObjectFramework` — `clsBusinessCollectionBase` |
| `First` | `Public Function First() As clsBusinessBase` | Sets traversal to and returns the first child object.† | `Legacy\BusinessObjectFramework` — `clsBusinessCollectionBase` |
| `Next` | `Public Function [Next]() As clsBusinessBase` | Advances traversal to and returns the next child object.† | `Legacy\BusinessObjectFramework` — `clsBusinessCollectionBase` |
| `CurrentItem` | `Public ReadOnly Property CurrentItem() As clsBusinessBase` | Returns the current traversal item through the base collection API.† | `Legacy\BusinessObjectFramework` — `clsBusinessCollectionBase` |
| `Save` | `Public Overridable Function Save() As Boolean` | Persists the collection through the BOF save pipeline.† | `Legacy\BusinessObjectFramework` — `clsBusinessCollectionBase` |

## Behavioral notes
- This type is documented from its source declaration.
- The type participates in the `clsBusinessCollectionBase` inheritance path used by `SAIF.Business.Claim.Payment`.

## Constraints and usage notes
- Consumers should rely on the public members and BOF lifecycle patterns visible in the source file.

> **Note:** Statements marked with `†` are derived from dependency library documentation via the Legends CLI.

## Sources
- `Business\SAIF.Business.Claim.Payment\Periods\clsBenefitPeriodCollection.vb`
- `Legacy\BusinessObjectFramework\clsBusinessCollectionBase.vb`