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

# clsWageCalcPeriodEarnings

`clsWageCalcPeriodEarnings` represents earnings for a wage-calculation period and exposes copy, earnings type descr valid, and hourly wage rate valid used in wage and job calculations.*

## Purpose
- Captures copy, earnings type descr valid, and hourly wage rate valid for wage and job calculations.*
- Helps track whether the calculation record is ready for use or needs review.*

## Context
- Namespace: `WageAndJob`
- Assembly/package: `SAIF.Business.Claim.Payment`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `IsValid` | `Public Overrides ReadOnly Property IsValid() As Boolean` | Returns is valid. |
| `IsDirty` | `Public Overrides ReadOnly Property IsDirty() As Boolean` | Returns is dirty. |
| `Copy` | `Public Shadows Function Copy() As clsWageCalcPeriodEarnings` | 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 clsWageCalcPeriodEarnings) 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. |
| `NewWageCalcPeriodEarnings` | `Public Shared Function NewWageCalcPeriodEarnings(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal, ByVal inEarningsTypeSubNum As Decimal, ByVal inTimelossCalculationSubNum As Decimal, ByVal inWageCalcPeriodSubNum As Decimal) As clsWageCalcPeriodEarnings` | Executes the `NewWageCalcPeriodEarnings` operation. |
| `GetWageCalcPeriodEarnings` | `Public Shared Function GetWageCalcPeriodEarnings(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal, ByVal inEarningsTypeSubNum As Decimal, ByVal inTimelossCalculationSubNum As Decimal, ByVal inWageCalcPeriodSubNum As Decimal) As clsWageCalcPeriodEarnings` | Retrieves the `GetWageCalcPeriodEarnings` operation. |
| `EarningsTypeDescrValid` | `Public Function EarningsTypeDescrValid(ByVal target As Object, ByVal e As clsRuleArgs) As Boolean` | Exposes the public member. |
| `HourlyWageRateValid` | `Public Function HourlyWageRateValid(ByVal target As Object, ByVal e As clsRuleArgs) As Boolean` | Exposes the public member. |
| `ClaimID` | `Public Property ClaimID As Decimal` | Gets or sets claim i d. |
| `EarningsTypeSubNum` | `Public Property EarningsTypeSubNum() As Decimal` | Gets or sets earnings type sub num. |
| `TimelossCalculationSubNum` | `Public Property TimelossCalculationSubNum As Decimal` | Gets or sets timeloss calculation sub num. |
| `WageCalcPeriodSubNum` | `Public Property WageCalcPeriodSubNum As Decimal` | Gets or sets wage calc period sub num. |
| `New` | `Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo)` | Executes the `New` operation. |
| `New` | `Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inClaimID As Decimal, ByVal inEarningsTypeSubNum As Decimal, ByVal inTimelossCalculationSubNum As Decimal, ByVal inWageCalcPeriodSubNum As Decimal)` | Executes the `New` 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` |
| `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 `clsBusinessBase` 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\Wage and Job\clsWageCalcPeriodEarnings.vb`
- `Legacy\BusinessObjectFramework\clsBusinessBase.vb`