clsFederalBenefitSchedule¶

clsFederalBenefitSchedule supports business object — federal benefit schedule in SAIF.Business.Claim.*

Purpose¶

Business object — federal benefit schedule

Context¶

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

Public members¶

Member	Signature	Purpose
BenefitPaymentSeqNum	`ReadOnly Property BenefitPaymentSeqNum() As DECIMAL`	Returns the benefit payment sequence number loaded for the schedule record.*
ClaimID	`ReadOnly Property ClaimID() As DECIMAL`	Returns the claim identifier associated with the federal benefit schedule.*
ReleasedPaymentCount	`ReadOnly Property ReleasedPaymentCount() As DECIMAL`	Returns the number of payments already released for the schedule record.*
UpdateDate	`ReadOnly Property UpdateDate() As DATE`	Returns the last persisted update date for the record.*
UpdateNum	`ReadOnly Property UpdateNum() As DECIMAL`	Returns the optimistic concurrency counter for the record.*
UpdateUser	`ReadOnly Property UpdateUser() As STRING`	Returns the user ID that last updated the record.*
RemainingPaymentCount	`Property RemainingPaymentCount() As DECIMAL`	Gets or sets the remaining payment count that will be saved for the schedule record.*
NextIssueDate	`ReadOnly Property NextIssueDate() As Date`	Returns the next issue date exposed from the internal `clsSmartDATE` value.*
IsValid	`Overrides ReadOnly Property IsValid() As Boolean`	Returns the BOF validation state for the object.*
IsDirty	`Overrides ReadOnly Property IsDirty() As Boolean`	Returns whether the object currently has pending changes tracked by the BOF base class.*
Save	`Overrides Function Save() As Boolean`	Persists the object through the BOF data portal and returns `True` after the save path completes.*
SetNextIssueDateNull	`Sub SetNextIssueDateNull()`	Clears the stored next issue date value.*
IsNextIssueDateNull	`Function IsNextIssueDateNull() As Boolean`	Returns whether the next issue date is currently empty.*
Equals	`Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean`	Compares two objects as `clsFederalBenefitSchedule` instances.*
Equals	`Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean`	Compares the current instance with another object.*
Equals	`Overloads Function Equals(ByVal inObject As clsFederalBenefitSchedule) As Boolean`	Compares two schedule objects by `ClaimID`.*
GetHashCode	`Overrides Function GetHashCode() As Integer`	Returns a hash code based on `ClaimID`.*
ToString	`Overrides Function ToString() As String`	Returns the `ClaimID` value as the type's string representation.*
NewFederalBenefitSchedule	`Shared Function NewFederalBenefitSchedule(ByVal inDataportal As iDataPortalInfo, inBenefitPaymentSeqNum As DECIMAL, inClaimID As DECIMAL) As clsFederalBenefitSchedule`	Creates a new federal benefit schedule through the BOF data portal.*
GetFederalBenefitSchedule	`Shared Function GetFederalBenefitSchedule(ByVal inDataportal As iDataPortalInfo, inBenefitPaymentSeqNum As DECIMAL, inClaimID As DECIMAL) As clsFederalBenefitSchedule`	Retrieves an existing federal benefit schedule through the BOF data portal.*

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¶

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

Constraints and usage notes¶

Consumers should account for inherited BOF or dependency behavior shown above.

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\clsFederalBenefitSchedule.vb