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

# clsBenefitScheduleCollection

`clsBenefitScheduleCollection` represents a collection of benefit schedule records used in time-loss payment processing, with lookup and list-management operations.*

## Purpose
- Holds benefit schedule 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 |
| --- | --- | --- |
| `Item` | `Default Public ReadOnly Property Item(ByVal Index As Integer) As clsBenefitSchedule` | Returns item. |
| `Item` | `Default Public ReadOnly Property Item(ByVal inClaimID As Decimal, ByVal inBenefitPaymentSeqNum As Decimal) As clsBenefitSchedule` | Returns item. |
| `Item` | `Default Public ReadOnly Property Item(ByVal inNextIssueDate As Date) As clsBenefitSchedule` | Returns item. |
| `Add` | `Public Shadows Function Add(ByVal inClaimBenefitSchedule As clsBenefitSchedule) As Integer` | Executes the `Add` operation. |
| `Contains` | `Public Overloads Function Contains(ByVal inClaimBenefitSchedule As clsBenefitSchedule) As Boolean` | Exposes the public member. |
| `Contains` | `Public Overloads Function Contains(ByVal inBenefitPeriodSeqNum As Decimal) As Boolean` | Exposes the public member. |
| `ContainsDeleted` | `Public Overloads Function ContainsDeleted(ByVal inClaimBenefitSchedule As clsBenefitSchedule) As Boolean` | Exposes the public member. |
| `ContainsDeleted` | `Public Overloads Function ContainsDeleted(ByVal inBenefitPeriodSeqNum As Decimal) As Boolean` | Exposes the public member. |
| `Remove` | `Public Sub Remove(ByVal inClaimBenefitSchedule As clsBenefitSchedule)` | Executes the `Remove` operation. |
| `GetClaimBenefitScheduleCollection` | `Public Shared Function GetClaimBenefitScheduleCollection(ByVal inDataportal As IDataPortalInfo, _` | Retrieves the `GetClaimBenefitScheduleCollection` operation. |
| `GetClaimBenefitScheduleCollection` | `Public Shared Function GetClaimBenefitScheduleCollection(ByVal inDataportal As IDataPortalInfo) As clsBenefitScheduleCollection` | Retrieves the `GetClaimBenefitScheduleCollection` operation. |
| `NewClaimBenefitScheduleCollection` | `Public Shared Function NewClaimBenefitScheduleCollection(ByVal inDataportal As IDataPortalInfo, _` | Executes the `NewClaimBenefitScheduleCollection` 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\Payments\TimelossPayments\clsBenefitScheduleCollection.vb`
- `Legacy\BusinessObjectFramework\clsBusinessCollectionBase.vb`