clsTimelossPaymentBase¶

clsTimelossPaymentBase is the shared base for time loss payment, centralizing payees, worker payee, and first period for derived types.*

Purpose¶

Centralizes payees, worker payee, and first period for derived types.*
Provides shared lifecycle checks used before derived objects are saved or retrieved.*

Context¶

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

Public members¶

Member	Signature	Purpose
`WorkerPayee`	`Public ReadOnly Property WorkerPayee() As clsWorkerPayee`	Returns worker payee.
`Payees`	`Public Shadows ReadOnly Property Payees() As clsPayeeCollection`	Returns payees.
`FirstPeriod`	`Public ReadOnly Property FirstPeriod() As clsBenefitPeriod`	Returns first period.
`Periods`	`Public Shadows ReadOnly Property Periods() As clsBenefitPeriodCollection`	Returns periods.
`PaymentCategoryList`	`Public MustOverride ReadOnly Property PaymentCategoryList() As List(Of CTB.ExtendedCodeInfo(Of String, PaymentCategories))`	Returns payment category list.
`PayeeTypes`	`Public MustOverride ReadOnly Property PayeeTypes() As List(Of CTB.ExtendedCodeInfo(Of String, clsPayeeBase.PayeeTypes))`	Returns payee types.
`PaymentScheduler`	`Public ReadOnly Property PaymentScheduler() As clsBenefitSchedule`	Returns payment scheduler.
`CanSchedule`	`Public ReadOnly Property CanSchedule() As clsResultInfo(Of Boolean)`	Returns can schedule.
`CalculatedBenefitAmount`	`Public Property CalculatedBenefitAmount() As Decimal`	Gets or sets calculated benefit amount.
`ValidateRetrieval`	`Public ReadOnly Property ValidateRetrieval() As Boolean`	Returns validate retrieval.
`ValidateCalculation`	`Public ReadOnly Property ValidateCalculation() As Boolean`	Returns validate calculation.
`IsFirstPayment`	`Public ReadOnly Property IsFirstPayment() As Boolean`	Returns is first payment.
`CanPaySupportAmount`	`Public ReadOnly Property CanPaySupportAmount() As Boolean`	Returns can pay support amount.
`TotalSupplementalAmount`	`Public ReadOnly Property TotalSupplementalAmount() As Decimal`	Returns total supplemental amount.
`IsDirty`	`Public Overrides ReadOnly Property IsDirty() As Boolean`	Returns is dirty.
`IsValid`	`Public Overrides ReadOnly Property IsValid() As Boolean`	Returns is valid.
`Save`	`Public Overrides Function Save() As Boolean`	Executes the `Save` operation.
`GenerateFinancialTranactions`	`Public Function GenerateFinancialTranactions() As Boolean`	Exposes the public member.
`AddPayee`	`Public Function AddPayee() As clsProviderPayee`	Executes the `AddPayee` operation.
`AddPeriod`	`Public Function AddPeriod() As clsBenefitPeriod`	Executes the `AddPeriod` operation.
`CreateSchedule`	`Public Sub CreateSchedule(ByVal inNumberOfPayments As Integer)`	Executes the `CreateSchedule` operation.
`RecalculatePayeeBenefitPercentages`	`Public Sub RecalculatePayeeBenefitPercentages()`	Exposes the public member.
`LoadPeriodsPreviouslyPaidProperties`	`Public Sub LoadPeriodsPreviouslyPaidProperties()`	Exposes the public member.
`ResetHalfShiftFlags`	`Public Sub ResetHalfShiftFlags(ByVal inIsFirstPeriodHalfShift As Boolean)`	Exposes the public member.
`GetApprovedPaymentList`	`Public Shared Function GetApprovedPaymentList(ByVal inDPI As IDataPortalInfo, ByVal inNextIssueDate As Date) As List(Of clsTimelossPaymentBase)`	Retrieves the `GetApprovedPaymentList` operation.

Inherited public members¶

Member	Signature	Purpose	Origin
`BenefitPaymentID`	`Public Property BenefitPaymentID() As Decimal`	Gets or sets benefit payment i d.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`ClaimData`	`Public ReadOnly Property ClaimData() As clsClaimData`	Returns claim data.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`IsPaymentTransactionType`	`Public Property IsPaymentTransactionType() As Boolean`	Gets or sets is payment transaction type.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`IsInBatchMode`	`Public ReadOnly Property IsInBatchMode() As Boolean`	Returns is in batch mode.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`IssueDate`	`Public Property IssueDate() As Date`	Gets or sets issue date.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`MaxFutureIssueDays`	`Public Property MaxFutureIssueDays() As Integer`	Gets or sets max future issue days.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`MaxIssueDate`	`Public ReadOnly Property MaxIssueDate() As Date`	Returns max issue date.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`InitiatorUser`	`Public Property InitiatorUser() As String`	Gets or sets initiator user.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`ApproverUser`	`Public Property ApproverUser() As String`	Gets or sets approver user.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`CurrentUser`	`Public ReadOnly Property CurrentUser() As clsPaymentUser`	Returns current user.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`IsAdditionToComp`	`Public Property IsAdditionToComp() As Boolean`	Gets or sets is addition to comp.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`IsChargeable`	`Public Property IsChargeable() As Boolean`	Gets or sets is chargeable.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`IsRevolvingFund`	`Public Property IsRevolvingFund() As Boolean`	Gets or sets is revolving fund.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`IsRushCheck`	`Public Property IsRushCheck() As Boolean`	Gets or sets is rush check.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`IsApproved`	`Public ReadOnly Property IsApproved() As Boolean`	Returns is approved.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`IsAwaitingApproval`	`Public ReadOnly Property IsAwaitingApproval() As Boolean`	Returns is awaiting approval.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`IsInProgress`	`Public ReadOnly Property IsInProgress() As Boolean`	Returns is in progress.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`PaymentReleased`	`Public ReadOnly Property PaymentReleased() As Boolean`	Returns payment released.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`PaymentAmountMin`	`Public Property PaymentAmountMin() As Decimal`	Gets or sets payment amount min.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`PaymentAmountMax`	`Public Property PaymentAmountMax() As Decimal`	Gets or sets payment amount max.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`UpdateInfo`	`Public ReadOnly Property UpdateInfo() As clsUpdateInfo`	Returns update info.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`TotalPaymentAmount`	`Public Overridable ReadOnly Property TotalPaymentAmount() As Decimal`	Returns total payment amount.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`TotalPaymentPercentage`	`Public ReadOnly Property TotalPaymentPercentage() As Decimal`	Returns total payment percentage.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`PaymentBusinessFunction`	`Public ReadOnly Property PaymentBusinessFunction() As PaymentBusinessFunctions`	Returns payment business function.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`PaymentTransactionTypeMap`	`Public ReadOnly Property PaymentTransactionTypeMap() As clsPaymentTransactionTypeMap`	Returns payment transaction type map.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`PaymentTransactionType`	`Public ReadOnly Property PaymentTransactionType() As PaymentTransactionTypes`	Returns payment transaction type.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`BenefitTypeMap`	`Public ReadOnly Property BenefitTypeMap() As clsBenefitTypeMap`	Returns benefit type map.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`PaymentCategoryMap`	`Public ReadOnly Property PaymentCategoryMap() As clsPaymentCategoryMap`	Returns payment category map.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`Disapprove`	`Public Sub Disapprove()`	Exposes the public member.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`Approve`	`Public Overridable Function Approve() As ApprovalErrors`	Exposes the public member.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`GetNextIssueDate`	`Public Shared Function GetNextIssueDate(ByVal inDPI As IDataPortalInfo, _`	Retrieves the `GetNextIssueDate` operation.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`GetNextIssueDate`	`Public Function GetNextIssueDate(ByVal inPaymentTransactionType As PaymentTransactionTypes) As Date`	Retrieves the `GetNextIssueDate` operation.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`GetNextIssueDate`	`Public Function GetNextIssueDate() As Date`	Retrieves the `GetNextIssueDate` operation.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`UpdateIssueDate`	`Public Function UpdateIssueDate() As Boolean`	Executes the `UpdateIssueDate` operation.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`MaxTotalMonthlyAmount`	`Public ReadOnly Property MaxTotalMonthlyAmount() As Decimal`	Returns max total monthly amount.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`HasCurrentSupportOrder`	`Public ReadOnly Property HasCurrentSupportOrder() As Boolean`	Returns has current support order.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`HasDelinquentSupportOrder`	`Public ReadOnly Property HasDelinquentSupportOrder() As Boolean`	Returns has delinquent support order.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`HasSupportOrder`	`Public ReadOnly Property HasSupportOrder() As Boolean`	Returns has support order.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`HasArrearage`	`Public ReadOnly Property HasArrearage As Boolean`	Returns has arrearage.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`PreviousPaidAmount`	`Public ReadOnly Property PreviousPaidAmount(ByVal inIssueDate As Date) As Decimal`	Returns previous paid amount.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`GetTotalSupportAmount`	`Public Function GetTotalSupportAmount(ByVal inPayees As clsPayeeCollection) As Decimal`	Retrieves the `GetTotalSupportAmount` operation.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`New`	`Public Sub New(ByVal inDPI As IDataPortalInfo, ByVal inClaimData As clsClaimData)`	Executes the `New` operation.	`SAIF.Business.Claim.Payment` — `clsPaymentBase`
`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`
`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 clsPaymentBase 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\Payments\TimelossPayments\clsTimelossPaymentBase.vb
Legacy\BusinessObjectFramework\clsBusinessBase.vb