Skip to content

clsBeneficiaryPayee

clsBeneficiaryPayee represents a beneficiary payee and exposes person ID, beneficiary, and payee names for claim payment payee handling.*

Purpose

  • Captures person ID, beneficiary, and payee names for claim payment payee handling.*

Context

  • Namespace: SAIF.Business.Claim.Payment
  • Assembly/package: SAIF.Business.Claim.Payment

Public members

Member Signature Purpose
PersonID Public Property PersonID() As Decimal Gets or sets person i d.
Beneficiary Public ReadOnly Property Beneficiary() As clsClaimPersonView Returns beneficiary.
PayeeName Public Overrides ReadOnly Property PayeeName() As String Returns payee name.
PaymentAddress Public Overrides ReadOnly Property PaymentAddress() As clsAddress Returns payment address.

Inherited public members

Member Signature Purpose Origin
BenefitPayeeID Public ReadOnly Property BenefitPayeeID() As Decimal Implements IPayee.PayeeID Returns benefit payee i d. SAIF.Business.Claim.Payment — clsPayeeBase
BenefitPaymentID Public ReadOnly Property BenefitPaymentID() As Decimal Returns benefit payment i d. SAIF.Business.Claim.Payment — clsPayeeBase
ClaimData Public ReadOnly Property ClaimData() As clsClaimData Returns claim data. SAIF.Business.Claim.Payment — clsPayeeBase
PaymentAmount Public Property PaymentAmount() As Decimal Implements IPayee.PaymentAmount Gets or sets payment amount. SAIF.Business.Claim.Payment — clsPayeeBase
PaymentAmountMin Public Property PaymentAmountMin() As Decimal Gets or sets payment amount min. SAIF.Business.Claim.Payment — clsPayeeBase
PaymentAmountMax Public Property PaymentAmountMax() As Decimal Gets or sets payment amount max. SAIF.Business.Claim.Payment — clsPayeeBase
PaymentPercentage Public Property PaymentPercentage() As Decimal Gets or sets payment percentage. SAIF.Business.Claim.Payment — clsPayeeBase
SpecialHandlingCode Public Property SpecialHandlingCode() As String Gets or sets special handling code. SAIF.Business.Claim.Payment — clsPayeeBase
IsDenialFinalLanguage Public Property IsDenialFinalLanguage() As Boolean Gets or sets is denial final language. SAIF.Business.Claim.Payment — clsPayeeBase
PayeeDescription Public ReadOnly Property PayeeDescription() As String Returns payee description. SAIF.Business.Claim.Payment — clsPayeeBase
PayeeType Public Property PayeeType() As PayeeTypes Implements IPayee.PayeeType Gets or sets payee type. SAIF.Business.Claim.Payment — clsPayeeBase
PayeeTypeCode Public Property PayeeTypeCode As String Gets or sets payee type code. SAIF.Business.Claim.Payment — clsPayeeBase
RetroReserveAmount Public Property RetroReserveAmount() As Decimal Implements IPayee.RetroReserveAmount Gets or sets retro reserve amount. SAIF.Business.Claim.Payment — clsPayeeBase
PaymentText Public Property PaymentText() As String Gets or sets payment text. SAIF.Business.Claim.Payment — clsPayeeBase
CashCardID Public Property CashCardID() As Decimal Implements IPayee.CashCardID Gets or sets cash card i d. SAIF.Business.Claim.Payment — clsPayeeBase
HasCashCard Public ReadOnly Property HasCashCard() As Boolean Returns has cash card. SAIF.Business.Claim.Payment — clsPayeeBase
UpdateInfo Public ReadOnly Property UpdateInfo() As clsUpdateInfo Returns update info. SAIF.Business.Claim.Payment — clsPayeeBase
BenefitRemark Public ReadOnly Property BenefitRemark() As clsBenefitRemark Returns benefit remark. SAIF.Business.Claim.Payment — clsPayeeBase
MonthlyAwardInfo Public ReadOnly Property MonthlyAwardInfo() As clsAwardPayeeInfo Implements IPayee.MonthlyAwardInfo Returns monthly award info. SAIF.Business.Claim.Payment — clsPayeeBase
MonthlyPaymentAmount Public ReadOnly Property MonthlyPaymentAmount() As Decimal Returns monthly payment amount. SAIF.Business.Claim.Payment — clsPayeeBase
MonthlyRetroReserveAmount Public ReadOnly Property MonthlyRetroReserveAmount() As Decimal Returns monthly retro reserve amount. SAIF.Business.Claim.Payment — clsPayeeBase
TotalMonthlyPaymentAmount Public ReadOnly Property TotalMonthlyPaymentAmount() As Decimal Returns total monthly payment amount. SAIF.Business.Claim.Payment — clsPayeeBase
TotalImmediatePaymentAmount Public ReadOnly Property TotalImmediatePaymentAmount() As Decimal Returns total immediate payment amount. SAIF.Business.Claim.Payment — clsPayeeBase
TotalPaymentAmount Public ReadOnly Property TotalPaymentAmount() As Decimal Returns total payment amount. SAIF.Business.Claim.Payment — clsPayeeBase
IsSpecialHandlingNull Public ReadOnly Property IsSpecialHandlingNull() As Boolean Returns is special handling null. SAIF.Business.Claim.Payment — clsPayeeBase
SetSpecialHandlingNull Public Sub SetSpecialHandlingNull() Executes the SetSpecialHandlingNull operation. SAIF.Business.Claim.Payment — clsPayeeBase
IsPaymentTextNull Public ReadOnly Property IsPaymentTextNull() As Boolean Returns is payment text null. SAIF.Business.Claim.Payment — clsPayeeBase
SetPaymentTextNull Public Sub SetPaymentTextNull() Executes the SetPaymentTextNull operation. SAIF.Business.Claim.Payment — clsPayeeBase
IsCashCardIDNull Public ReadOnly Property IsCashCardIDNull() As Boolean Returns is cash card i d null. SAIF.Business.Claim.Payment — clsPayeeBase
SetCashCardIDNull Public Sub SetCashCardIDNull() Executes the SetCashCardIDNull operation. SAIF.Business.Claim.Payment — clsPayeeBase
IsDirty Public Overrides ReadOnly Property IsDirty() As Boolean Returns is dirty. SAIF.Business.Claim.Payment — clsPayeeBase
IsValid Public Overrides ReadOnly Property IsValid() As Boolean Returns is valid. SAIF.Business.Claim.Payment — clsPayeeBase
GetReadonlyPayee Public Shared Function GetReadonlyPayee(ByVal inPayeeType As PayeeTypes, ByVal inDPI As IDataPortalInfo, ByVal inClaimData As clsClaimData) As clsPayeeBase Retrieves the GetReadonlyPayee operation. SAIF.Business.Claim.Payment — clsPayeeBase
Save Public Overrides Function Save() As Boolean Executes the Save operation. SAIF.Business.Claim.Payment — clsPayeeBase
PayeeTypeMap Public ReadOnly Property PayeeTypeMap() As clsPayeeTypeMap Returns payee type map. SAIF.Business.Claim.Payment — clsPayeeBase
GetPayeeTypeMap Public Shared Function GetPayeeTypeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal RefreshPayeeTypes As Boolean = False) As clsPayeeTypeMap Retrieves the GetPayeeTypeMap operation. SAIF.Business.Claim.Payment — clsPayeeBase
GetSpecialHandlingCodes Public Shared Function GetSpecialHandlingCodes(ByVal inDPI As IDataPortalInfo, Optional ByVal RefreshCodes As Boolean = False) As SpecialHandlingCodes Retrieves the GetSpecialHandlingCodes operation. SAIF.Business.Claim.Payment — clsPayeeBase
New Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo) Executes the New operation. SAIF.Business.Claim.Payment — clsPayeeBase
MyGuid Public ReadOnly Property MyGuid() As String Returns the object's generated GUID identifier.† Legacy\BusinessObjectFramework — clsBusinessBase
IsNew Public ReadOnly Property IsNew() As Boolean Indicates whether the object represents unsaved data.† Legacy\BusinessObjectFramework — clsBusinessBase
IsDeleted Public ReadOnly Property IsDeleted() As Boolean Indicates whether the object has been marked for deletion.† Legacy\BusinessObjectFramework — clsBusinessBase
SetValueOnChange Public Function SetValueOnChange(Of T)(ByRef inFieldValue As T, ByVal inSetValue As T, Optional ByVal inMarkDirty As Boolean = True) As Boolean Assigns a new field value only when it differs and optionally marks the object dirty.† Legacy\BusinessObjectFramework — clsBusinessBase
Rules Public ReadOnly Property Rules() As clsRulesManager Exposes the BOF rules manager for validation and messages.† Legacy\BusinessObjectFramework — clsBusinessBase
Save Public Overridable Function Save() As Boolean Persists the object through the BOF save pipeline.† Legacy\BusinessObjectFramework — clsBusinessBase
SaveChild Public Overridable Function SaveChild() As Boolean Persists the object as a BOF child object.† Legacy\BusinessObjectFramework — clsBusinessBase
ToXml Public Function ToXml() As String Returns the object's XML representation using the configured default tag name.† Legacy\BusinessObjectFramework — clsBusinessBase

Behavioral notes

  • This type is documented from its source declaration.
  • The type participates in the clsPayeeBase 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\clsBeneficiaryPayee.vb
  • Legacy\BusinessObjectFramework\clsBusinessBase.vb