---
title: clsWorkerClaimBenefitSchedule
summary: API reference for clsWorkerClaimBenefitSchedule.
status: draft
owner: SAIF Doc Gen
last_reviewed: 2026-07-28
library: SAIF.Business.Claim.Maintenance
reference_type: package
---

# clsWorkerClaimBenefitSchedule

`clsWorkerClaimBenefitSchedule` represents the schedule metadata for a claim benefit payment, including next issue date, remaining payment count, and update audit fields.

## Purpose
- Store the scheduling fields associated with a specific claim benefit payment.
- Expose next-issue, remaining-count, and audit information used when maintaining benefit schedules.

## Context

- Namespace: `SAIF.Business.Claim.Maintenance`
- Assembly/package: `SAIF.Business.Claim.Maintenance`

## Public members

| Member | Signature | Purpose |
| --- | --- | --- |
| `NextIssueDate` | `Public Readonly Property NextIssueDate() As DATE` | Gets or sets next issue date. |
| `UpdateDate` | `Public Readonly Property UpdateDate() As STRING` | Gets or sets update date. |
| `UpdateNum` | `Public Readonly Property UpdateNum() As DECIMAL` | Gets or sets update num. |
| `UpdateUser` | `Public Readonly Property UpdateUser() As STRING` | Gets or sets update user. |
| `BenefitPaymentSubNum` | `Public Property BenefitPaymentSubNum() As Decimal` | Gets or sets benefit payment sub num. |
| `ClaimID` | `Public Property	ClaimID() As	DECIMAL` | Gets or sets claim i d. |
| `RemainingPaymentCount` | `Public Property	RemainingPaymentCount() As	DECIMAL` | Gets or sets remaining payment count. |
| `MyCriteria` | `Public ReadOnly	Property MyCriteria() As Criteria` | Returns my criteria. |
| `IsValid` | `Public Overrides ReadOnly Property IsValid() As	Boolean` | Returns is valid. |
| `IsSavable` | `Public Overrides ReadOnly Property IsSavable() As Boolean` | Returns is savable. |
| `IsNextIssueDateNull` | `Public Function	IsNextIssueDateNull() as Boolean` | Exposes the public member. |
| `Equals` | `Public Overloads Shared	Function Equals(ByVal objA As Object, ByVal	objB As	Object)	As Boolean` | Exposes the public member. |
| `Equals` | `Public Overloads Overrides Function	Equals(ByVal inObject As Object) As	Boolean` | Exposes the public member. |
| `Equals` | `Public Overloads Function Equals(ByVal inObject	As clsWorkerClaimBenefitSchedule)	As Boolean` | Exposes the public member. |
| `GetHashCode` | `Public Overrides Function GetHashCode()	As Integer` | Retrieves the `GetHashCode` operation. |
| `ToString` | `Public Overrides Function ToString() As	String` | Exposes the public member. |
| `NewWorkerClaimBenefitSchedule` | `Public Shared Function NewWorkerClaimBenefitSchedule(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal, ByVal inBenefitPaymentSeqNum As Decimal) As clsWorkerClaimBenefitSchedule` | Executes the `NewWorkerClaimBenefitSchedule` operation. |
| `GetWorkerClaimBenefitSchedule` | `Public Shared Function GetWorkerClaimBenefitSchedule(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal, ByVal inBenefitPaymentSeqNum As Decimal) As clsWorkerClaimBenefitSchedule` | Retrieves the `GetWorkerClaimBenefitSchedule` operation. |
| `Save` | `Public Overrides Function Save() As Boolean` | Executes the `Save` operation. |

## Inherited public members

| 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` |
| `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 `clsBusinessBase` inheritance path used by `SAIF.Business.Claim.Maintenance`.

## Constraints and usage notes

- Consumers should rely on the public members and BOF lifecycle patterns visible in the source file.

> **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.Maintenance\clsWorkerClaimBenefitSchedule.vb`
- `Legacy\BusinessObjectFramework\clsBusinessBase.vb`