---
title: clsUSBankUser
summary: API reference for clsUSBankUser.
status: draft
owner: SAIF
last_reviewed: 2026-07-24
library: SAIF.Business.EPay.USBank
reference_type: package
---

# clsUSBankUser

`clsUSBankUser` is the BOF-backed persistence model for `US_BANK_USER`. It stores the SAIF-side link between a policy, a business-online user ID, and the related US Bank profile state.

## Purpose
- Persist SAIF-owned US Bank user linkage data.
- Support lookup, insert, update, and delete behavior for local user rows.

## Context
- Namespace: `SAIF.Business.EPay.USBank`
- Assembly/package: `SAIF.BOF.Business.EPay.USBank`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| USBankUserSeqNum | `Public ReadOnly Property USBankUserSeqNum() As Decimal Implements IUSBankUser.USBankUserSeqNum` | Gets the `USBankUserSeqNum` value. |
| PolicyNumber | `Public ReadOnly Property PolicyNumber() As Decimal Implements IUSBankUser.PolicyNumber` | Gets the `PolicyNumber` value. |
| BusinessOnlineUserId | `Public ReadOnly Property BusinessOnlineUserId() As String Implements IUSBankUser.BusinessOnlineUserId` | Gets the `BusinessOnlineUserId` value. |
| FirstName | `Public Property FirstName() As String Implements IUSBankUser.FirstName` | Gets or sets the `FirstName` value. |
| LastName | `Public Property LastName() As String Implements IUSBankUser.LastName` | Gets or sets the `LastName` value. |
| IsTransferBankAccounts | `Public Property IsTransferBankAccounts As Boolean Implements IUSBankUser.IsTransferBankAccounts` | Gets or sets the `IsTransferBankAccounts` value. |
| Password | `Public ReadOnly Property Password As String Implements IUSBankUser.Password` | Gets the `Password` value. |
| SetFirstNameNull | `Public Sub SetFirstNameNull()` | Executes `SetFirstNameNull`. |
| SetLastNameNull | `Public Sub SetLastNameNull()` | Executes `SetLastNameNull`. |
| IsFirstNameNull | `Public Function IsFirstNameNull() As Boolean` | Returns the result of `IsFirstNameNull`. |
| IsLastNameNull | `Public Function IsLastNameNull() As Boolean` | Returns the result of `IsLastNameNull`. |
| Equals | `Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Returns the result of `Equals`. |
| Equals | `Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Returns the result of `Equals`. |
| Equals | `Public Overloads Function Equals(ByVal inObject As clsUSBankUser) As Boolean` | Returns the result of `Equals`. |
| GetHashCode | `Public Overrides Function GetHashCode() As Integer` | Returns the result of `GetHashCode`. |
| ToString | `Public Overrides Function ToString() As String` | Returns the result of `ToString`. |
| NewUSBankUser | `Public Shared Function NewUSBankUser(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNumber As Decimal, ByVal inBusinessOnlineUserId As String) As clsUSBankUser` | Returns the result of `NewUSBankUser`. |
| GetUSBankUser | `Public Shared Function GetUSBankUser(ByVal inDataportal As IDataPortalInfo, ByVal inUSBankUserSeqNum As Decimal) As clsUSBankUser` | Returns the result of `GetUSBankUser`. |
| GetUSBankUser | `Public Shared Function GetUSBankUser(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNumber As Decimal, ByVal inBusinessOnlineUserId As String) As clsUSBankUser` | Returns the result of `GetUSBankUser`. |

## Inherited public members

Members in this section are inherited from `clsBusinessBase` in `BusinessObjectFramework`. They are available on this type through inheritance.

| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| MyGuid | `Public ReadOnly Property MyGuid() As String` | Gets the `MyGuid` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| IsNew | `Public ReadOnly Property IsNew() As Boolean` | Gets the `IsNew` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| IsDeleted | `Public ReadOnly Property IsDeleted() As Boolean` | Gets the `IsDeleted` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| IsDirty | `Public Overridable ReadOnly Property IsDirty() As Boolean` | Gets the `IsDirty` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| SetValueOnChange | `Public Function SetValueOnChange(Of T)(ByRef inFieldValue As T, ByVal inSetValue As T, Optional ByVal inMarkDirty As Boolean = True) As Boolean` | Returns the result of `SetValueOnChange`. | `BusinessObjectFramework` — `clsBusinessBase` |
| IsSavable | `Public Overridable ReadOnly Property IsSavable() As Boolean` | Gets the `IsSavable` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| PreviousLinkItem | `Public ReadOnly Property PreviousLinkItem() As ILinkItem Implements ILinkItem.PreviousLinkItem` | Gets the `PreviousLinkItem` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| NextLinkItem | `Public ReadOnly Property NextLinkItem() As ILinkItem Implements ILinkItem.NextLinkItem` | Gets the `NextLinkItem` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| SetPreviousLink | `Public Sub SetPreviousLink(ByRef inLinkItem As ILinkItem) Implements ILinkItem.SetPreviousLink` | Executes `SetPreviousLink`. | `BusinessObjectFramework` — `clsBusinessBase` |
| SetNextLink | `Public Sub SetNextLink(ByRef inLinkItem As ILinkItem) Implements ILinkItem.SetNextLink` | Executes `SetNextLink`. | `BusinessObjectFramework` — `clsBusinessBase` |
| InsertLinkAfter | `Public Sub InsertLinkAfter(ByRef inLinkItem As ILinkItem) Implements ILinkItem.InsertLinkAfter` | Executes `InsertLinkAfter`. | `BusinessObjectFramework` — `clsBusinessBase` |
| InsertLinkBefore | `Public Sub InsertLinkBefore(ByRef inLinkItem As ILinkItem) Implements ILinkItem.InsertLinkBefore` | Executes `InsertLinkBefore`. | `BusinessObjectFramework` — `clsBusinessBase` |
| RemoveLinks | `Public Sub RemoveLinks() Implements ILinkItem.RemoveLinks` | Executes `RemoveLinks`. | `BusinessObjectFramework` — `clsBusinessBase` |
| BeginEdit | `Public Sub BeginEdit()` | Executes `BeginEdit`. | `BusinessObjectFramework` — `clsBusinessBase` |
| CancelEdit | `Public Sub CancelEdit()` | Executes `CancelEdit`. | `BusinessObjectFramework` — `clsBusinessBase` |
| ApplyEdit | `Public Sub ApplyEdit()` | Executes `ApplyEdit`. | `BusinessObjectFramework` — `clsBusinessBase` |
| Delete | `Public Sub Delete()` | Executes `Delete`. | `BusinessObjectFramework` — `clsBusinessBase` |
| Clone | `Public Function Clone() As Object Implements ICloneable.Clone` | Returns the result of `Clone`. | `BusinessObjectFramework` — `clsBusinessBase` |
| ValidateOnDelete | `Public Property ValidateOnDelete() As Boolean` | Gets or sets the `ValidateOnDelete` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| Rules | `Public ReadOnly Property Rules() As clsRulesManager` | Gets the `Rules` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| IsValid | `Public Overridable ReadOnly Property IsValid() As Boolean` | Gets the `IsValid` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| ErrorCount | `Public ReadOnly Property ErrorCount() As Integer` | Gets the `ErrorCount` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| ErrorMessages | `Public ReadOnly Property ErrorMessages() As String()` | Gets the `ErrorMessages` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| WarningCount | `Public ReadOnly Property WarningCount() As Integer` | Gets the `WarningCount` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| WarningMessages | `Public ReadOnly Property WarningMessages() As String()` | Gets the `WarningMessages` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| InformationalCount | `Public ReadOnly Property InformationalCount() As Integer` | Gets the `InformationalCount` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| InformationalMessages | `Public ReadOnly Property InformationalMessages() As String()` | Gets the `InformationalMessages` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| Save | `Public Overridable Function Save() As Boolean` | Returns the result of `Save`. | `BusinessObjectFramework` — `clsBusinessBase` |
| SaveChild | `Public Overridable Function SaveChild() As Boolean` | Returns the result of `SaveChild`. | `BusinessObjectFramework` — `clsBusinessBase` |
| XMLElementName | `Public Property XMLElementName() As String` | Gets or sets the `XMLElementName` value. | `BusinessObjectFramework` — `clsBusinessBase` |
| GetDataset | `Public Sub GetDataset(ByRef inDS As DataSet)` | Executes `GetDataset`. | `BusinessObjectFramework` — `clsBusinessBase` |
| GetDataset | `Public Sub GetDataset(ByRef inDS As DataSet, ByVal inTableName As String)` | Executes `GetDataset`. | `BusinessObjectFramework` — `clsBusinessBase` |
| GetReportXML | `Public Function GetReportXML(ByVal inElementName As String) As String` | Returns the result of `GetReportXML`. | `BusinessObjectFramework` — `clsBusinessBase` |
| GetReportXML | `Public Function GetReportXML() As String` | Returns the result of `GetReportXML`. | `BusinessObjectFramework` — `clsBusinessBase` |
| ToXml | `Public Function ToXml() As String` | Returns the result of `ToXml`. | `BusinessObjectFramework` — `clsBusinessBase` |
| ToXml | `Public Function ToXml(ByVal inTagName As String) As String` | Returns the result of `ToXml`. | `BusinessObjectFramework` — `clsBusinessBase` |

## Behavioral notes
- The class enforces required Business Online user ID and policy number rules through `AddBusinessRules()`.

## Constraints and usage notes
- Persistence lifecycle behavior is inherited from the BOF base classes used by the library.

## Sources
- `Business\SAIF.Business.EPay.USBank\clsUSBankUser.vb`