clsEligPayeeClaim¶

clsEligPayeeClaim is the BOF business object representing a single eligible payee for a claim payment. It inherits clsBusinessBase, implements iPayee, exposes the nested PayeeAddressType enum, and carries person, address, eligibility, and contact data for a worker or beneficiary payee assembled in memory by clsEligPayeeClaimCollection.getEligClaimPayees.

Purpose¶

Model a single eligible-payee-for-claim-payment record in memory.
Expose the iPayee contract used by payment-processing workflows.
Classify the selected payee address as Home, Mailing, Primary, or NoAddress.

Context¶

Namespace: SAIF.Business.Payment
Assembly/package: SAIF.BOF.Business.Payment

Public members¶

Member	Signature	Purpose
`MSG_NO_ADDRESS_FOUND`	`Public Const MSG_NO_ADDRESS_FOUND As String = "No Mailing or Home address found"`	Sentinel text written into `Address.AddressLine1` when no usable worker or beneficiary address is available.
`PayeeAddressType`	`Public Enum PayeeAddressType`	Nested enum that classifies the chosen payee address as `Home`, `Mailing`, `Primary`, or `NoAddress`.
`NewEligPayeeClaim`	`Public Shared Function NewEligPayeeClaim(ByVal inDataportal As IDataPortalInfo, ByVal inPersonID As Decimal) As clsEligPayeeClaim`	BOF factory method that creates an in-memory eligible-payee object for the specified person.
`PersonID`	`Public Property PersonID() As Decimal`	Person identifier carried by the payee record.
`Address`	`Public Property Address() As clsAddress`	Address object selected for the payee.
`AddressType`	`Public Property AddressType() As PayeeAddressType`	Address classification value for the selected address.
`AddressTypeCode`	`Public ReadOnly Property AddressTypeCode() As String`	Returns the code string for the current address type (`HOME`, `MAIL`, or `PRIMARY`).
`Name`	`Public Property Name() As clsName`	Structured payee name object.
`DisplayName`	`Public ReadOnly Property DisplayName() As String`	Returns the payee name in standard last-name-first format.
`SecondName`	`Public Property SecondName() As String`	Secondary name value stored for the payee.
`Phone`	`Public Property Phone() As String`	Payee phone number.
`DateofBirth`	`Public Property DateofBirth() As Date`	Payee date of birth.
`DateofDeath`	`Public Property DateofDeath() As Date`	Payee date of death.
`Age`	`Public Property Age() As Integer`	Age value stored on the payee record.
`InvalidChild`	`Public Property InvalidChild() As String`	Invalid-child indicator copied from beneficiary source data.
`EligEffDate`	`Public Property EligEffDate() As Date`	Eligibility effective date stored on the payee record.
`EligExpDate`	`Public Property EligExpDate() As Date`	Eligibility expiration date stored on the payee record.
`HasAddress`	`Public ReadOnly Property HasAddress() As Boolean`	Returns `False` when `AddressLine1` is blank or equals `MSG_NO_ADDRESS_FOUND`.
`TaxID`	`Public Property TaxID() As String`	Tax identifier for the payee.
`NameUpdateDate`	`Public Property NameUpdateDate() As Date`	Update date for the payee name data.
`AddressUpdateDate`	`Public Property AddressUpdateDate() As Date`	Update date for the selected address data.
`PayeeAddress`	`Public ReadOnly Property PayeeAddress As clsAddress Implements iPayee.Address`	`iPayee` address view over the selected payee address.
`PayeeID`	`Public ReadOnly Property PayeeID As String Implements iPayee.PayeeID`	`iPayee` identifier view over `PersonID`.
`PayeeEmailAddress`	`Public Property PayeeEmailAddress As String Implements iPayee.EmailAddress`	Email address exposed through the `iPayee` contract.
`PayeeName`	`Public ReadOnly Property PayeeName As String Implements iPayee.Name`	`iPayee` name view using standard first-name formatting.
`PayeePhone`	`Public ReadOnly Property PayeePhone As String Implements iPayee.PhoneNumber`	`iPayee` phone-number view over `Phone`.
`PayeeSSNTaxID`	`Public ReadOnly Property PayeeSSNTaxID As String Implements iPayee.SSNTaxID`	`iPayee` tax-ID view over `TaxID`.
`PayeeType`	`Public ReadOnly Property PayeeType As iPayee.PayeeTypes Implements iPayee.PayeeType`	Returns the `iPayee` payee-type value exposed by this class.
`PayeeTypeCode`	`Public ReadOnly Property PayeeTypeCode As String Implements iPayee.PayeeTypeCode`	Returns the `iPayee` payee-type code exposed by this class.
`IsValid`	`Public Overrides ReadOnly Property IsValid() As Boolean`	Returns the BOF validity result from `clsBusinessBase` with no additional local rules.
`IsDirty`	`Public Overrides ReadOnly Property IsDirty() As Boolean`	Returns the BOF dirty-state result from `clsBusinessBase` with no additional local tracking.
`SetPersonIDNull`	`Public Sub SetPersonIDNull()`	Clears the smart-decimal `PersonID` value.
`SetDateofBitthNull`	`Public Sub SetDateofBitthNull()`	Clears the smart-date `DateofBirth` value; the `Bitth` spelling is preserved from source.
`SetDateofDeathNull`	`Public Sub SetDateofDeathNull()`	Clears the smart-date `DateofDeath` value.
`SetInvalidChildNull`	`Public Sub SetInvalidChildNull()`	Clears the smart-string `InvalidChild` value.
`SetEligEffDateNull`	`Public Sub SetEligEffDateNull()`	Clears the smart-date `EligEffDate` value.
`SetEligExpDateNull`	`Public Sub SetEligExpDateNull()`	Clears the smart-date `EligExpDate` value.
`IsPersonIDNull`	`Public Function IsPersonIDNull() As Boolean`	Returns `True` when `PersonID` is empty.
`IsAddressNull`	`Public Function IsAddressNull() As Boolean`	Returns `True` when `Address` is empty.
`IsNameNull`	`Public Function IsNameNull() As Boolean`	Returns `True` when `Name` is empty.
`IsPhoneNull`	`Public Function IsPhoneNull() As Boolean`	Returns `True` when `Phone` is empty.
`IsDateofBitthNull`	`Public Function IsDateofBitthNull() As Boolean`	Returns `True` when `DateofBirth` is empty; the `Bitth` spelling is preserved from source.
`IsDateofDeathNull`	`Public Function IsDateofDeathNull() As Boolean`	Returns `True` when `DateofDeath` is empty.
`IsInvalidChildNull`	`Public Function IsInvalidChildNull() As Boolean`	Returns `True` when `InvalidChild` is empty.
`IsEligEffDateNull`	`Public Function IsEligEffDateNull() As Boolean`	Returns `True` when `EligEffDate` is empty.
`IsEligExpDateNull`	`Public Function IsEligExpDateNull() As Boolean`	Returns `True` when `EligExpDate` is empty.
`Equals`	`Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean`	Returns `True` only when both objects are `clsEligPayeeClaim` instances whose `PersonID` values match.
`Equals`	`Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean`	Object-level equality overload that accepts only `clsEligPayeeClaim` values.
`Equals`	`Public Overloads Function Equals(ByVal inObject As clsEligPayeeClaim) As Boolean`	Type-specific equality overload that compares `PersonID` values.
`ToString`	`Public Overrides Function ToString() As String`	Returns `PersonID` as the string representation of the payee.

Inherited public members¶

Members in this section are inherited from clsBusinessBase in Legacy\BusinessObjectFramework.

From `clsBusinessBase` (`Legacy\BusinessObjectFramework`)¶

Member	Signature	Purpose	Origin
`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`
`IsSavable`	`Public Overridable ReadOnly Property IsSavable() As Boolean`	Indicates whether the object is in a state that can be saved through the BOF pipeline.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`PreviousLinkItem`	`Public ReadOnly Property PreviousLinkItem() As ILinkItem`	Returns the previous item in the BOF link chain.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`NextLinkItem`	`Public ReadOnly Property NextLinkItem() As ILinkItem`	Returns the next item in the BOF link chain.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`SetPreviousLink`	`Public Sub SetPreviousLink(ByRef inLinkItem As ILinkItem)`	Assigns the previous BOF link item.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`SetNextLink`	`Public Sub SetNextLink(ByRef inLinkItem As ILinkItem)`	Assigns the next BOF link item.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`InsertLinkAfter`	`Public Sub InsertLinkAfter(ByRef inLinkItem As ILinkItem)`	Inserts the current object after another item in the BOF link chain.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`InsertLinkBefore`	`Public Sub InsertLinkBefore(ByRef inLinkItem As ILinkItem)`	Inserts the current object before another item in the BOF link chain.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`RemoveLinks`	`Public Sub RemoveLinks()`	Clears the BOF link-item relationships for this object.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`BeginEdit`	`Public Sub BeginEdit()`	Starts an editable-object transaction snapshot.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`CancelEdit`	`Public Sub CancelEdit()`	Rolls back the current editable-object transaction snapshot.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`ApplyEdit`	`Public Sub ApplyEdit()`	Commits the current editable-object transaction snapshot.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`Delete`	`Public Sub Delete()`	Marks the object for deletion in the BOF lifecycle.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`Clone`	`Public Function Clone() As Object`	Returns a cloned copy of the business object.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`ValidateOnDelete`	`Public Property ValidateOnDelete() As Boolean`	Controls whether validation is performed when the object is deleted.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`Rules`	`Public ReadOnly Property Rules() As clsRulesManager`	Exposes the BOF rules manager for validation and messages.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`ErrorCount`	`Public ReadOnly Property ErrorCount() As Integer`	Returns the current number of BOF error messages.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`ErrorMessages`	`Public ReadOnly Property ErrorMessages() As String()`	Returns the current BOF error messages.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`WarningCount`	`Public ReadOnly Property WarningCount() As Integer`	Returns the current number of BOF warning messages.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`WarningMessages`	`Public ReadOnly Property WarningMessages() As String()`	Returns the current BOF warning messages.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`InformationalCount`	`Public ReadOnly Property InformationalCount() As Integer`	Returns the current number of BOF informational messages.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`InformationalMessages`	`Public ReadOnly Property InformationalMessages() As String()`	Returns the current BOF informational 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`
`XMLElementName`	`Public Property XMLElementName() As String`	Gets or sets the XML element name used for serialization output.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`GetDataset`	`Public Sub GetDataset(ByRef inDS As DataSet)`	Appends the object's dataset representation to the supplied `DataSet`.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`GetDataset`	`Public Sub GetDataset(ByRef inDS As DataSet, ByVal inTableName As String)`	Appends the object's dataset representation using the supplied table name.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`GetReportXML`	`Public Function GetReportXML(ByVal inElementName As String) As String`	Returns report XML using the supplied element name.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`GetReportXML`	`Public Function GetReportXML() As String`	Returns report XML using the configured default element name.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`ToXml`	`Public Function ToXml() As String`	Returns the object's XML representation using the configured default tag name.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`ToXml`	`Public Function ToXml(ByVal inTagName As String) As String`	Returns the object's XML representation using the supplied tag name.	`Legacy\BusinessObjectFramework` — `clsBusinessBase`

Behavioral notes¶

Create() copies MyCriteria.PersonID into the new object and performs no database request.
Criteria.CreateSQL, Criteria.DeleteSQL, Criteria.InsertSQL, and Criteria.UpdateSQL throw ApplicationException with clsConstants.Messages.InvalidSQLProperty.
Criteria.RetrieveSQL returns a single-space string literal rather than executable SQL.
AddressTypeCode maps Home to HOME, Mailing to MAIL, and all other values to PRIMARY.
PayeeType always returns iPayee.PayeeTypes.Worker and PayeeTypeCode always returns WORKR, even when beneficiary data is copied into the object by clsEligPayeeClaimCollection.getEligClaimPayees.

Constraints and usage notes¶

This class does not execute live SQL; its BOF criteria object exists only to satisfy factory scaffolding.
SetDateofBitthNull and IsDateofBitthNull preserve the original source spelling and therefore expose Bitth rather than Birth in their member names.

Sources¶

Business\SAIF.Business.Payment\clsEligPayeeClaim.vb
Legacy\BusinessObjectFramework\clsBusinessBase.vb