clsActiveBenefitSchedule

Represents an active claim benefit payment schedule, including remaining and released payment counts, next issue date, and stop-task information. ProcessBenefitPayment updates the schedule for a claim and can surface deleted or released-payment review states.

Purpose

• Exposes the identifiers, payment counts, next issue date, and status values for an active benefit schedule.
• Processes benefit payments for a claim based on the calling application and function.
• Produces task text and stop status information when the schedule is deleted or requires review.

Context

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

Public members

Member	Signature	Purpose
CallingApplication	Enum CallingApplication	Exposes the nested enum CallingApplication.
CallingFunction	Enum CallingFunction	Exposes the nested enum CallingFunction.
StopStatus	Enum StopStatus	Exposes the nested enum StopStatus.
BenefitPaymentSeqNum	ReadOnly Property BenefitPaymentSeqNum() As Decimal	Returns the BenefitPaymentSeqNum value.
ClaimID	ReadOnly Property ClaimID() As Decimal	Returns the ClaimID value.
ReleasedPaymentCount	ReadOnly Property ReleasedPaymentCount() As Decimal	Returns the ReleasedPaymentCount value.
UpdateDate	ReadOnly Property UpdateDate() As Date	Returns the UpdateDate value.
UpdateNum	ReadOnly Property UpdateNum() As Decimal	Returns the UpdateNum value.
UpdateUser	ReadOnly Property UpdateUser() As String	Returns the UpdateUser value.
RemainingPaymentCount	Property RemainingPaymentCount() As Decimal	Gets or sets the RemainingPaymentCount value.
NextIssueDate	ReadOnly Property NextIssueDate() As Date	Returns the NextIssueDate value.
Task	ReadOnly Property Task() As String	Returns the Task value.
TaskStatus	ReadOnly Property TaskStatus() As StopStatus	Returns the TaskStatus value.
IsValid	ReadOnly Property IsValid() As Boolean	Returns the IsValid value.
IsDirty	ReadOnly Property IsDirty() As Boolean	Returns the IsDirty value.
Save	Overrides Function Save() As Boolean	Executes Save and returns the result.
ProcessBenefitPayment	Function ProcessBenefitPayment(ByVal inClaimId As Decimal,ByVal inCallingApplication As CallingApplication,Optional ByVal inCallingFunction As CallingFunction = CallingFunction.Unknown) As Boolean	Executes ProcessBenefitPayment and returns the result.
SetNextIssueDateNull	Sub SetNextIssueDateNull()	Performs the SetNextIssueDateNull operation.
IsNextIssueDateNull	Function IsNextIssueDateNull() As Boolean	Executes IsNextIssueDateNull and returns the result.
Equals	Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean	Executes Equals and returns the result.
Equals	Overrides Function Equals(ByVal inObject As Object) As Boolean	Executes Equals and returns the result.
Equals	Overloads Function Equals(ByVal inObject As clsActiveBenefitSchedule) As Boolean	Executes Equals and returns the result.
GetHashCode	Overrides Function GetHashCode() As Integer	Executes GetHashCode and returns the result.
ToString	Overrides Function ToString() As String	Executes ToString and returns the result.
NewBenefitSchedule	Shared Function NewBenefitSchedule(ByVal inDataportal As IDataPortalInfo, ByVal inBenefitPaymentSeqNum As Decimal, ByVal inClaimID As Decimal) As clsActiveBenefitSchedule	Executes NewBenefitSchedule and returns the result.
NewBenefitSchedule	Shared Function NewBenefitSchedule(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal) As clsActiveBenefitSchedule	Executes NewBenefitSchedule and returns the result.
GetBenefitSchedule	Shared Function GetBenefitSchedule(ByVal inDataportal As IDataPortalInfo, ByVal inBenefitPaymentSeqNum As Decimal, ByVal inClaimID As Decimal) As clsActiveBenefitSchedule	Executes GetBenefitSchedule and returns the result.

Inherited public members

Members in this section are inherited from clsBusinessBase. | Member | Signature | Purpose | Origin | | --- | --- | --- | --- | | Rules | Property Rules As clsRulesManager | Exposes the BOF rules manager used to evaluate object validation rules.* | saif-framework-core — clsBusinessBase | | BeginEdit | Sub BeginEdit() | Starts an edit session for n-level undo support.* | saif-framework-core — clsBusinessBase | | CancelEdit | Sub CancelEdit() | Cancels the active edit session and reverts pending changes.* | saif-framework-core — clsBusinessBase | | ApplyEdit | Sub ApplyEdit() | Commits the active edit session and accepts pending changes.* | saif-framework-core — clsBusinessBase |

Behavioral notes

• clsActiveBenefitSchedule is part of the documented SAIF.Business.Claim public contract.
• Public members are declared in Business\SAIF.Business.Claim\clsActiveBenefitSchedule.vb.

Constraints and usage notes

• Consumers should use the documented public members directly when integrating this type.

Note: Statements marked with * were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with ** could not be confirmed; treat as unknown until verified.

Sources

• Business\SAIF.Business.Claim\clsActiveBenefitSchedule.vb