--- title: clsClaimUnit summary: API reference for clsClaimUnit. status: draft owner: SAIF last_reviewed: 2026-07-24 library: SAIF.Business.UnitStat reference_type: package --- # clsClaimUnit Claim-level reporting unit that links a claim to a policy unit and tracks claim-specific reporting state. ## Purpose - Represent the claim-to-policy-unit association used by unit-stat reporting. - Track value-code, active, fatal, closed, denial, and preferred-worker flags. ## Context - Namespace: `SAIF.Business.UnitStat` - Assembly/package: `SAIF.Business.UnitStat` (distributed as NuGet package `SAIF.BOF.Business.UnitStat`) ## Public members | Member | Signature | Purpose | | --- | --- | --- | | `PolicyUnitSeqNum` | `Public Property PolicyUnitSeqNum() As Decimal` | Gets or sets policy unit seq num. | | `ClaimID` | `Public Property ClaimID() As Decimal` | Gets or sets claim id. | | `ActiveUnitFlag` | `Public Property ActiveUnitFlag() As String` | Gets or sets active unit flag. | | `ValueCode` | `Public Property ValueCode() As String` | Gets or sets value code. | | `UpdateUser` | `Public Property UpdateUser() As String` | Gets or sets update user. | | `UpdateDate` | `Public Property UpdateDate() As Date` | Gets or sets update date. | | `UpdateNumber` | `Public Property UpdateNumber() As Decimal` | Gets or sets update number. | | `ReportedFatalFlag` | `Public Property ReportedFatalFlag() As String` | Gets or sets reported fatal flag. | | `ReportedClosedFlag` | `Public Property ReportedClosedFlag() As String` | Gets or sets reported closed flag. | | `PreferredWorkerFlag` | `Public Property PreferredWorkerFlag() As String` | Gets or sets preferred worker flag. | | `FinalDenialDate` | `Public Property FinalDenialDate() As Date` | Gets or sets final denial date. | | `IsActive` | `Public ReadOnly Property IsActive() As Boolean` | Indicates whether active. | | `IsInactive` | `Public ReadOnly Property IsInactive() As Boolean` | Indicates whether inactive. | | `IsPreferredWorker` | `Public ReadOnly Property IsPreferredWorker() As Boolean` | Indicates whether preferred worker. | | `IsDeniedFinal` | `Public ReadOnly Property IsDeniedFinal() As Boolean` | Indicates whether denied final. | | `IsFullyFraudulent` | `Public ReadOnly Property IsFullyFraudulent(clmData As clsClaimData) As Boolean` | Indicates whether fully fraudulent. | | `WasReportedFatal` | `Public ReadOnly Property WasReportedFatal() As Boolean` | Indicates whether reported fatal. | | `WasReportedOpen` | `Public ReadOnly Property WasReportedOpen() As Boolean` | Indicates whether reported open. | | `WasReportedClosed` | `Public ReadOnly Property WasReportedClosed() As Boolean` | Indicates whether reported closed. | | `IsValid` | `Public Overrides ReadOnly Property IsValid() As Boolean` | Indicates whether valid. | | `IsDirty` | `Public Overrides ReadOnly Property IsDirty() As Boolean` | Indicates whether dirty. | | `SetFinalDenialDateNull` | `Public Sub SetFinalDenialDateNull()` | Sets final denial date to the framework null sentinel value. | | `IsFinalDenialDateNull` | `Public Function IsFinalDenialDateNull() As Boolean` | Indicates whether final denial date currently holds the framework null sentinel value. | | `Equals` | `Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Executes the member operation. | | `Equals` | `Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Executes the member operation. | | `Equals` | `Public Overloads Function Equals(ByVal inObject As clsClaimUnit) As Boolean` | Executes the member operation. | | `GetHashCode` | `Public Overrides Function GetHashCode() As Integer` | Retrieves hash code. | | `ToString` | `Public Overrides Function ToString() As String` | Executes the member operation. | | `NewClaimUnit` | `Public Shared Function NewClaimUnit(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal, ByVal inPolicyUnitSeqNum As Decimal) As clsClaimUnit` | Creates a new claim unit instance. | | `GetClaimUnit` | `Public Shared Function GetClaimUnit(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal) As clsClaimUnit` | Retrieves claim unit. | | `GetClaimUnit` | `Public Shared Function GetClaimUnit(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal, ByVal inPolicyUnitSeqNum As Decimal) As clsClaimUnit` | Retrieves claim unit. | | `ClaimID` | `Public Property ClaimID() As Decimal` | Gets or sets claim id. | | `PolicyUnitSeqNum` | `Public Property PolicyUnitSeqNum() As Decimal` | Gets or sets policy unit seq num. | | `RetrieveType` | `Public Property RetrieveType() As RetrieveTypes` | Gets or sets retrieve type. | | `IsRetrieveByClaimID` | `Public ReadOnly Property IsRetrieveByClaimID() As Boolean` | Indicates whether retrieve by claim id. | | `IsRetrieveByClaimUnit` | `Public ReadOnly Property IsRetrieveByClaimUnit() As Boolean` | Indicates whether retrieve by claim unit. | | `New` | `Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo)` | Creates a new instance. | | `New` | `Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inClaimID As Decimal)` | Creates a new instance. | | `New` | `Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inClaimID As Decimal, ByVal inPolicyUnitSeqNum As Decimal)` | Creates a new instance. | ## Inherited public members Members in this section are inherited from `clsBusinessBase` in `SAIF.BOF.Framework`. They are available on this type through inheritance. | Member | Signature | Purpose | Origin | | --- | --- | --- | --- | | `MyGuid` | `ReadOnly Property MyGuid() As String` | Gets the framework GUID assigned to the object. | `SAIF.BOF.Framework — clsBusinessBase` | | `IsNew` | `ReadOnly Property IsNew() As Boolean` | Indicates whether the object has not yet been persisted. | `SAIF.BOF.Framework — clsBusinessBase` | | `IsDeleted` | `ReadOnly Property IsDeleted() As Boolean` | Indicates whether the object is marked for deletion. | `SAIF.BOF.Framework — clsBusinessBase` | | `IsSavable` | `ReadOnly Property IsSavable() As Boolean` | Indicates whether the object is both dirty and valid. | `SAIF.BOF.Framework — clsBusinessBase` | | `BeginEdit` | `Sub BeginEdit()` | Begins an editable-object snapshot. | `SAIF.BOF.Framework — clsBusinessBase` | | `CancelEdit` | `Sub CancelEdit()` | Restores the prior editable-object snapshot and reapplies rules. | `SAIF.BOF.Framework — clsBusinessBase` | | `ApplyEdit` | `Sub ApplyEdit()` | Commits the current editable-object snapshot. | `SAIF.BOF.Framework — clsBusinessBase` | | `Delete` | `Sub Delete()` | Marks the object for deletion. | `SAIF.BOF.Framework — clsBusinessBase` | | `Clone` | `Function Clone() As Object` | Creates a clone of the object. | `SAIF.BOF.Framework — clsBusinessBase` | | `Rules` | `ReadOnly Property Rules() As clsRulesManager` | Gets the rules manager attached to the object. | `SAIF.BOF.Framework — clsBusinessBase` | | `ErrorCount` | `ReadOnly Property ErrorCount() As Integer` | Gets the current validation error count. | `SAIF.BOF.Framework — clsBusinessBase` | | `ErrorMessages` | `ReadOnly Property ErrorMessages() As String()` | Gets the current validation error messages. | `SAIF.BOF.Framework — clsBusinessBase` | | `WarningCount` | `ReadOnly Property WarningCount() As Integer` | Gets the current validation warning count. | `SAIF.BOF.Framework — clsBusinessBase` | | `WarningMessages` | `ReadOnly Property WarningMessages() As String()` | Gets the current validation warning messages. | `SAIF.BOF.Framework — clsBusinessBase` | | `InformationalCount` | `ReadOnly Property InformationalCount() As Integer` | Gets the current informational rule count. | `SAIF.BOF.Framework — clsBusinessBase` | | `InformationalMessages` | `ReadOnly Property InformationalMessages() As String()` | Gets the current informational rule messages. | `SAIF.BOF.Framework — clsBusinessBase` | | `XMLElementName` | `Property XMLElementName() As String` | Gets or sets the XML element name used by framework serialization. | `SAIF.BOF.Framework — clsBusinessBase` | | `GetReportXML` | `Function GetReportXML() As String` | Returns framework report XML for the object. | `SAIF.BOF.Framework — clsBusinessBase` | | `ToXml` | `Function ToXml() As String` | Serializes the object to XML. | `SAIF.BOF.Framework — clsBusinessBase` | ## Behavioral notes - [BR-US-019](../../business-rules.md#br-us-019-a-claim-unit-active-lookup-filters-to-activeunitflag-y) restricts the single-claim retrieval path to active rows. - [BR-US-013](../../business-rules.md#br-us-013-non-compensable-rules-apply-only-to-policy-units-effective-on-or-after-2013-01-01) is part of the non-compensable rule context. ## Constraints and usage notes - Factory methods support both claim-only and claim-plus-policy-unit retrieval paths. ## Sources - `Business\SAIF.Business.UnitStat\clsClaimUnit.vb` - `Legacy\BusinessObjectFramework\clsBusinessBase.vb`