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

# clsProviderEFTCollection

clsProviderEFTCollection is a public type in `SAIF.Business.Provider.PaymentPreference`.

## Purpose
- Collection that retrieves EFT rows and EFT-management context for providers or batch processing.

## Context
- Namespace: `SAIF.Business.Provider.PaymentPreference`
- Assembly/package: `SAIF.BOF.Business.Provider.PaymentPreference`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| IsUserSAIFEmployee | `Public Property IsUserSAIFEmployee As Boolean` | Context flag for child objects |
| AdminUserTypeSeqNum | `Public Property AdminUserTypeSeqNum As Decimal` | Admin user type passed to child EFTs |
| MaskBankNumbers | `Public Property MaskBankNumbers As Boolean` | Passed to child EFTs |
| BankValidatorXML | `Public Property BankValidatorXML As XDocument` | Passed to child EFTs |
| UnAssignedPaymentLocations | `Public ReadOnly Property UnAssignedPaymentLocations As IEnumerable(Of clsProviderEFT)` | Locations without active EFT |
| AssignedPaymentLocations | `Public ReadOnly Property AssignedPaymentLocations As IEnumerable(Of clsProviderEFT)` | Locations with active EFT |
| AllPaymentLocations | `Public ReadOnly Property AllPaymentLocations As IEnumerable(Of clsProviderEFT)` | Active plus unassigned locations |
| NewProviderEFTCollection | `Public Shared Function NewProviderEFTCollection(dpi) As clsProviderEFTCollection` | Creates an empty collection |
| GetProviderEFTColl | `Public Shared Function GetProviderEFTColl(inDPI, inProviderSeqNum) As clsProviderEFTCollection` | Loads all EFTs for a provider |
| GetAllEFTsColl | `Public Shared Function GetAllEFTsColl(inDPI) As clsProviderEFTCollection` | Loads all EFT rows for batch processing |
| GetProviderEFTLocations | `Public Shared Function GetProviderEFTLocations(inDPI, inProviderID, inIsUserSAIFEmployee, inAdminUserTypeSeqNum, inMaskBankNumbers, inBankValidatorXMLDocument) As clsProviderEFTCollection` | Loads provider locations with optional EFT joins and collection context |
| GetProviderEFTLocEmails | `Public Shared Function GetProviderEFTLocEmails(ByVal inDPI As IDataPortalInfo, inProviderID As Decimal, inIsUserSAIFEmployee As Boolean, inAdminUserTypeSeqNum As Decimal, inMaskBankNumbers As Boolean, inBankValidatorXMLDocument As XDocument) As clsProviderEFTCollection` | Loads provider EFT locations together with external-user email addresses for notification workflows |

## Behavioral notes
- Collection-level context (`IsUserSAIFEmployee`, `AdminUserTypeSeqNum`, `MaskBankNumbers`, `BankValidatorXML`) is read back by child `clsProviderEFT` objects through parent accessors.
- `GetProviderEFTLocations()` produces the location lists used for assignment, unassignment, and batch workflows.
- Related behavior is cross-referenced from the library-level [Business rules](../../business-rules.md) and [SQL catalog](../../sql/index.md).

## Constraints and usage notes
- Use collection factories rather than constructing this type directly.

## Inherited members (from clsBusinessCollectionBase via clsBusinessCollection(Of T))
This collection type inherits the following public surface from clsBusinessCollectionBase (`Legacy\BusinessObjectFramework\clsBusinessCollectionBase.vb`), in addition to the members listed above:
| Member | Signature | Purpose |
| --- | --- | --- |
| Item | `Default Public ReadOnly Property Item(ByVal index As Integer) As clsBusinessBase` | Returns the collection member at the given index (default indexer). |
| Add | `Sub Add(ByVal inChild As clsBusinessBase)` | Adds a child business object to the collection. |
| Remove | `Sub Remove(ByVal inChild As clsBusinessBase)` | Marks a child business object as deleted and removes it from the active list. |
| Contains | `Function Contains(ByVal Item As clsBusinessBase) As Boolean` | Indicates whether the collection contains the given item. |
| ContainsDeleted | `Function ContainsDeleted(ByVal Item As clsBusinessBase) As Boolean` | Indicates whether the given item exists in the collection's deleted-items list. |
| ItemByGuid | `ReadOnly Property ItemByGuid(ByVal inGuid As String) As clsBusinessBase` | Returns the collection member matching the given internal GUID. |
| MyGuid | `ReadOnly Property MyGuid() As String` | Returns the internal GUID that uniquely identifies this in-memory collection instance. |
| IsDirty | `ReadOnly Property IsDirty() As Boolean` | Indicates whether the collection or any child member has unsaved changes. |
| IsValid | `Overridable ReadOnly Property IsValid() As Boolean` | Indicates whether all child members currently have no broken validation rules. |
| ValidateAllChildren | `Overridable Property ValidateAllChildren() As Boolean` | Controls whether every child is validated or only the current item. |
| Rules | `ReadOnly Property Rules() As clsRulesManager` | Returns the rules manager that tracks broken rules for the collection. |
| ErrorCount / ErrorMessages | `ReadOnly Property ErrorCount() As Integer` / `ReadOnly Property ErrorMessages() As String()` | Returns the count and text of broken error-severity rules across the collection. |
| WarningCount / WarningMessages | `ReadOnly Property WarningCount() As Integer` / `ReadOnly Property WarningMessages() As String()` | Returns the count and text of broken warning-severity rules across the collection. |
| InformationalCount / InformationalMessages | `ReadOnly Property InformationalCount() As Integer` / `ReadOnly Property InformationalMessages() As String()` | Returns the count and text of broken informational-severity rules across the collection. |
| BeginEdit / CancelEdit / ApplyEdit | `Sub BeginEdit()` / `Sub CancelEdit()` / `Sub ApplyEdit()` | Begins, rolls back, or commits an edit transaction across the collection. |
| Save | `Overridable Function Save() As Boolean` | Persists all added, changed, and deleted members through the BOF data portal. |
| SaveChild | `Overridable Function SaveChild() As Boolean` | Persists the collection as a child of a parent object. |
| Clone | `Function Clone() As Object` | Returns a deep copy of the collection and its members. |
| IsManaged | `ReadOnly Property IsManaged() As Boolean` | Indicates whether the collection is managed by a parent object's lifecycle. |
| First / FirstItem | `Function First() As clsBusinessBase` / `ReadOnly Property FirstItem() As clsBusinessBase` | Moves to and/or returns the first item in traversal order. |
| Next / NextItem | `Function [Next]() As clsBusinessBase` / `ReadOnly Property NextItem() As clsBusinessBase` | Moves to and/or returns the next item in traversal order. |
| Previous / PreviousItem | `Function Previous() As clsBusinessBase` / `ReadOnly Property PreviousItem() As clsBusinessBase` | Moves to and/or returns the previous item in traversal order. |
| Last / LastItem | `Function Last() As clsBusinessBase` / `ReadOnly Property LastItem() As clsBusinessBase` | Moves to and/or returns the last item in traversal order. |
| CurrentItem / CurrentIndex | `ReadOnly Property CurrentItem() As clsBusinessBase` / `ReadOnly Property CurrentIndex() As Integer` | Returns the current traversal item and its index. |
| SetCurrent | `Sub SetCurrent(ByRef inObject As clsBusinessBase)` / `Sub SetCurrent(ByVal inIndex As Integer)` | Sets the current traversal position by item or index. |
| IndexOf | `ReadOnly Property IndexOf(ByVal inObject As clsBusinessBase) As Integer` | Returns the index of the given item within the collection. |
| IsFirst / IsNext / IsLast / IsPrevious / IsCurrent | `ReadOnly Property IsFirst(ByVal inItem As clsBusinessBase) As Boolean` (and analogous overloads) | Indicate an item's position relative to the current traversal state. |
| XMLElementName / XMLItemName | `Property XMLElementName() As String` / `Property XMLItemName() As String` | Get or set the XML element/item names used when serializing the collection. |
| GetReportXML | `Function GetReportXML(ByVal inElementName As String) As String` (and file-stream overload) | Returns an XML fragment representing the collection and its members. |
| ToXML / ToXml | `Function ToXML() As String` / `Function ToXml(ByVal inTagName As String) As String` | Serializes the collection to XML using the default or a supplied tag name. |

## Sources
- `Business\SAIF.Business.Provider.PaymentPreference\clsProviderEFT.vb`