clsPayeeCollection

clsPayeeCollection represents a collection of payee records used in claim payment payee handling, with lookup and list-management operations.*

Purpose

• Holds payee 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 clsPayeeBase	Returns item.
Item	Default Public ReadOnly Property Item(ByVal inBenefitPayeeID As String) As clsPayeeBase	Returns item.
Item	Default Public ReadOnly Property Item(ByVal inBenefitPayeeType As clsPayeeBase.PayeeTypes) As clsPayeeBase	Returns item.
TotalBenefitPercentage	Public ReadOnly Property TotalBenefitPercentage() As Decimal	Returns total benefit percentage.
GetClaimPayees	Public Shared Function GetClaimPayees(ByVal inDPI As IDataPortalInfo, ByVal inBenefitPaymentID As Decimal, ByVal inClaimData As clsClaimData) As clsPayeeCollection	Retrieves the GetClaimPayees operation.
Contains	Public Overloads Function Contains(ByVal inClaimPayee As clsPayeeBase) As Boolean	Exposes the public member.
Contains	Public Overloads Function Contains(ByVal inBenefitPayeeID As Decimal) As Boolean	Exposes the public member.
Contains	Public Overloads Function Contains(ByVal inPayeeType As clsPayeeBase.PayeeTypes) As Boolean	Exposes the public member.
ContainsDeleted	Public Overloads Function ContainsDeleted(ByVal inClaimPayee As clsPayeeBase) As Boolean	Exposes the public member.
ContainsDeleted	Public Overloads Function ContainsDeleted(ByVal inBenefitPayeeID As Decimal) As Boolean	Exposes the public member.
Remove	Public Sub Remove(ByVal inClaimPayee As clsPayeeBase)	Executes the Remove operation.
ToList	Public Function ToList() As List(Of clsPayeeBase)	Exposes the public member.
GetAutoPayees	Public Shared Function GetAutoPayees(ByVal inDPI As IDataPortalInfo, ByVal inClaimData As clsClaimData, _	Retrieves the GetAutoPayees 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
Add	Public Sub Add(ByVal inChild As clsBusinessBase)	Adds a BOF child object through the untyped base collection API.†	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\Payees\clsPayeeCollection.vb
• Legacy\BusinessObjectFramework\clsBusinessCollectionBase.vb