clsLegalOrderPayment

clsLegalOrderPayment represents a legal order payment and exposes legal order type code, legal order types, and payees for claim payment processing.*

Purpose

• Captures legal order type code, legal order types, and payees for settlement payment processing.*
• Provides retrieval or loading behavior related to that workflow.*

Context

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

Public members

Member	Signature	Purpose
LegalOrderTypeCode	Public Property LegalOrderTypeCode() As String	Gets or sets legal order type code.
LegalOrderTypes	Public ReadOnly Property LegalOrderTypes As clsLegalOrderTypeCodes	Returns legal order types.
GetPayment	Public Shared Function GetPayment(ByVal inDPI As IDataPortalInfo, ByVal inClaimData As clsClaimData) As clsLegalOrderPayment	Retrieves the GetPayment operation.
GetLegalOrderTypeCodes	Public Function GetLegalOrderTypeCodes(inDPI As IDataPortalInfo, Optional inRefresh As Boolean = False) As clsLegalOrderTypeCodes	Retrieves the GetLegalOrderTypeCodes operation.

Inherited public members

Member	Signature	Purpose	Origin
IsStructedSettlement	Public Property IsStructedSettlement() As Boolean	Gets or sets is structed settlement.	SAIF.Business.Claim.Payment — clsSettlementPayment
SettlementTotalAmount	Public Property SettlementTotalAmount() As Decimal	Gets or sets settlement total amount.	SAIF.Business.Claim.Payment — clsSettlementPayment
SettlementTypeCode	Public Property SettlementTypeCode As String	Gets or sets settlement type code.	SAIF.Business.Claim.Payment — clsSettlementPayment
OrderApprovedDate	Public Property OrderApprovedDate() As Date	Gets or sets order approved date.	SAIF.Business.Claim.Payment — clsSettlementPayment
Payees	Public Overloads ReadOnly Property Payees As clsPayeeCollection	Returns payees.	SAIF.Business.Claim.Payment — clsSettlementPayment
ValidateRetrieval	Public ReadOnly Property ValidateRetrieval() As Boolean	Returns validate retrieval.	SAIF.Business.Claim.Payment — clsSettlementPayment
PayeeTypes	Public ReadOnly Property PayeeTypes() As IEnumerable(Of CTB.ExtendedCodeInfo(Of String, clsPayeeBase.PayeeTypes))	Returns payee types.	SAIF.Business.Claim.Payment — clsSettlementPayment
Save	Public Overrides Function Save() As Boolean	Executes the Save operation.	SAIF.Business.Claim.Payment — clsSettlementPayment
RecalculatePayeeAmounts	Public Sub RecalculatePayeeAmounts()	Exposes the public member.	SAIF.Business.Claim.Payment — clsSettlementPayment
ChangePayeeType	Public Function ChangePayeeType(Of T As clsPayeeBase)(payee As clsPayeeBase, payeeType As clsPayeeBase.PayeeTypes) As T	Exposes the public member.	SAIF.Business.Claim.Payment — clsSettlementPayment
AddPayee	Public Function AddPayee(Optional inPayeeType As clsPayeeBase.PayeeTypes = clsPayeeBase.PayeeTypes.Other) As clsProviderPayee	Executes the AddPayee operation.	SAIF.Business.Claim.Payment — clsSettlementPayment
Approve	Public Overrides Function Approve() As ApprovalErrors	Exposes the public member.	SAIF.Business.Claim.Payment — clsSettlementPayment
GetDCSTypeCodes	Public Shared Function GetDCSTypeCodes(inDPI As IDataPortalInfo, Optional inRefresh As Boolean = False) As clsDCSTypeCodes	Retrieves the GetDCSTypeCodes operation.	SAIF.Business.Claim.Payment — clsSettlementPayment
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
IsDirty	Public Overrides ReadOnly Property IsDirty() As Boolean	Returns is dirty.	SAIF.Business.Claim.Payment — clsPaymentBase
IsValid	Public Overrides ReadOnly Property IsValid() As Boolean	Returns is valid.	SAIF.Business.Claim.Payment — clsPaymentBase
Save	Public Overrides Function Save() As Boolean	Executes the Save operation.	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
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 clsSettlementPayment 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\SettlementPayments\clsLegalOrderPayment.vb
• Legacy\BusinessObjectFramework\clsBusinessBase.vb