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

# clsPaymentCollection

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

## Purpose
- Holds payment 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 clsPaymentBase` | Returns item. |
| `CurrentItem` | `Public Shadows ReadOnly Property CurrentItem() As clsPaymentBase` | Returns current item. |
| `Save` | `Public Overrides Function Save() As Boolean` | Executes the `Save` operation. |
| `Add` | `Public Shadows Function Add(ByVal inBenefitPayment As clsPaymentBase) As Integer` | Executes the `Add` operation. |
| `Contains` | `Public Overloads Function Contains(ByVal inBenefitPayment As clsPaymentBase) As Boolean` | Exposes the public member. |
| `Contains` | `Public Overloads Function Contains(ByVal inBenefitPaymentID As Decimal) As Boolean` | Exposes the public member. |
| `ContainsDeleted` | `Public Overloads Function ContainsDeleted(ByVal inBenefitPayment As clsPaymentBase) As Boolean` | Exposes the public member. |
| `ContainsDeleted` | `Public Overloads Function ContainsDeleted(ByVal inBenefitPaymentSeqNum As Decimal) As Boolean` | Exposes the public member. |
| `Remove` | `Public Sub Remove(ByVal inBenefitPayment As clsPaymentBase)` | Executes the `Remove` operation. |
| `Remove` | `Public Sub Remove(ByVal inBenefitPaymentID As Decimal)` | Executes the `Remove` operation. |
| `Where` | `Public Function Where(ByVal match As Predicate(Of clsPaymentBase)) As clsPaymentCollection` | Exposes the public member. |
| `NewBenefitPaymentCollection` | `Public Shared Function NewBenefitPaymentCollection(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal, ByVal inAwardNum As Decimal) As clsPaymentCollection` | Executes the `NewBenefitPaymentCollection` operation. |
| `GetBenefitPaymentCollection` | `Public Shared Function GetBenefitPaymentCollection(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal, ByVal inAwardNum As Decimal) As clsPaymentCollection` | Retrieves the `GetBenefitPaymentCollection` 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` |

## 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\clsPaymentCollection.vb`
- `Legacy\BusinessObjectFramework\clsBusinessCollectionBase.vb`