---
title: clsRateFileMaster
summary: API reference for clsRateFileMaster.
status: draft
owner: Technical Writer
last_reviewed: 2026-07-31
library: SAIF.Business.Policy.Rating
reference_type: package
---
# clsRateFileMaster
Represents a published rate-file header. The class is retrieved through BOF criteria objects and exposes the loaded row to rating callers.
## Purpose
- Represents a published rate-file header.
- The class is retrieved through BOF criteria objects and exposes the loaded row to rating callers.
## Context
- Namespace: `SAIF.Business.Policy.Rating`
- Assembly/package: `SAIF.Business.Policy.Rating`
## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| RateFileSeqNum | `Public ReadOnly Property RateFileSeqNum() As Decimal` | Published rate file sequence number that uniquely identifies the RATE_FILE_MASTER row and the manual class bases attached to it. |
| RateFileEffDate | `Public Property RateFileEffDate() As Date` | Start date on which this rate file becomes effective for its risk-type/new-or-outstanding combination. |
| NewOutstandingCode | `Public Property NewOutstandingCode() As String` | Code that distinguishes new versus outstanding business when selecting the applicable rate file. |
| RiskTypeCode | `Public Property RiskTypeCode() As String` | Risk-tier code that scopes the rate file to a specific risk type. |
| RateFileExpDate | `Public Property RateFileExpDate() As Date` | Optional date after which this rate file should no longer be treated as in force. |
| NRRateFileSeqNum | `Public Property NRRateFileSeqNum() As Decimal` | Optional NR companion rate-file sequence used in the alternate effective-date lookup. |
| PendingFlag | `Public Property PendingFlag() As String` | Optional flag carried on the master row to mark the rate file as pending. |
| IsValid | `Public Overrides ReadOnly Property IsValid() As Boolean` | Base BOF validation result for the current rate file object state. |
| IsDirty | `Public Overrides ReadOnly Property IsDirty() As Boolean` | Tracks whether the rate file has unsaved changes since load or last save. |
| SetRateFileExpDateNull | `Public Sub SetRateFileExpDateNull()` | Clears the optional expiration date so the rate file has no stored end date. |
| SetNRRateFileSeqNumNull | `Public Sub SetNRRateFileSeqNumNull()` | Clears the optional NR companion rate-file sequence on the master row. |
| SetPendingFlagNull | `Public Sub SetPendingFlagNull()` | Clears the optional pending indicator on the master row. |
| IsRateFileExpDateNull | `Public Function IsRateFileExpDateNull() As Boolean` | Indicates whether the rate file has no expiration date stored. |
| IsNRRateFileSeqNumNull | `Public Function IsNRRateFileSeqNumNull() As Boolean` | Indicates whether no NR companion rate-file sequence is stored. |
| IsPendingFlagNull | `Public Function IsPendingFlagNull() As Boolean` | Indicates whether the pending indicator is unset. |
| Equals | `Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Compares two objects as rate-file masters by delegating to typed equality. |
| Equals | `Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Treats another object as equal only when it is a `clsRateFileMaster` with the same `RateFileSeqNum`. |
| Equals | `Public Overloads Function Equals(ByVal inObject As clsRateFileMaster) As Boolean` | Uses `RateFileSeqNum` as the identity comparison for two rate-file master instances. |
| GetHashCode | `Public Overrides Function GetHashCode() As Integer` | Hashes `RateFileSeqNum`, the value this type uses as its identity key in keyed collections. |
| ToString | `Public Overrides Function ToString() As String` | Uses the rate-file sequence number as the human-readable identifier. |
| NewRateFileMaster | `Public Shared Function NewRateFileMaster(ByVal inDataportal As IDataPortalInfo, ByVal inRateFileEffDate As Date, ByVal inNewOutstandingCode As String, ByVal inRiskTypeCode As String, ByVal inNRRateFileSeqNum As Decimal) As clsRateFileMaster` | Creates a new rate-file master seeded with its effective date, business status code, risk type, and NR companion sequence. |
| GetRateFileMaster | `Public Shared Function GetRateFileMaster(ByVal inDataportal As IDataPortalInfo, ByVal inRateFileSeqNum As Decimal) As clsRateFileMaster` | Retrieves the a published rate-file header identified by the key values or effective-date criteria supplied by the caller. |
| GetRateFileMaster | `Public Shared Function GetRateFileMaster(ByVal inDataportal As IDataPortalInfo, ByVal inRateFileEffDate As Date, ByVal inNewOutstandingCode As String, ByVal inRiskTypeCode As String, ByVal inNRRateFileSeqNum As Decimal) As clsRateFileMaster` | Retrieves the a published rate-file header identified by the key values or effective-date criteria supplied by the caller. |
| CanDeleteRateFileMasterRecord | `Public Shared Function CanDeleteRateFileMasterRecord(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inWCISRateFileSeqNum As Decimal) As Boolean` | Runs the library's pre-delete reference check before allowing the corresponding row to be removed. |
| RateFileSeqNum | `Public Property RateFileSeqNum() As Decimal` | Primary-key criterion used to retrieve, update, or delete a specific rate-file master row. |
| RateFileEffDate | `Public Property RateFileEffDate() As Date` | Effective-date portion of the alternate lookup key for a rate-file master row. |
| NewOutstandingCode | `Public Property NewOutstandingCode() As String` | New-versus-outstanding portion of the alternate lookup key for a rate-file master row. |
| RiskTypeCode | `Public Property RiskTypeCode() As String` | Risk-type portion of the alternate lookup key for a rate-file master row. |
| NRRateFileSeqNum | `Public Property NRRateFileSeqNum() As Decimal` | Optional NR companion sequence portion of the alternate lookup key for a rate-file master row. |
| New | `Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo)` | Creates an empty BOF object shell that shared factory methods or retrieval logic can populate with a loaded row. |
| New | `Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inRateFileEffDate As Date, ByVal inNewOutstandingCode As String, ByVal inRiskTypeCode As String, ByVal inNRRateFileSeqNum As Decimal)` | Creates a criteria-backed instance seeded with `inRateFileEffDate`, `inNewOutstandingCode`, `inRiskTypeCode`, `inNRRateFileSeqNum` so the next retrieval runs in the caller's requested context. |
| New | `Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inRateFileSeqNum As Decimal, ByVal inRateFileEffDate As Date, ByVal inNewOutstandingCode As String, ByVal inRiskTypeCode As String, ByVal inNRRateFileSeqNum As Decimal)` | Creates a criteria-backed instance seeded with `inRateFileSeqNum`, `inRateFileEffDate`, `inNewOutstandingCode`, `inRiskTypeCode`, `inNRRateFileSeqNum` so the next retrieval runs in the caller's requested context. |
## Inherited public members
| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| Rules | `Property Rules As clsRulesManager` | Owns the BOF rules manager used to evaluate registered validation logic.† | `SAIF.Framework.Core` — `clsBusinessBase` |
| BeginEdit | `Sub BeginEdit()` | Opens an n-level edit session for the business object.† | `SAIF.Framework.Core` — `clsBusinessBase` |
| CancelEdit | `Sub CancelEdit()` | Rolls back the active edit scope.† | `SAIF.Framework.Core` — `clsBusinessBase` |
| ApplyEdit | `Sub ApplyEdit()` | Commits the active edit scope.† | `SAIF.Framework.Core` — `clsBusinessBase` |
| Error | `ReadOnly Property Error As String` | Surfaces aggregate broken-rule text through `IDataErrorInfo`.† | `SAIF.Framework.Core` — `clsBusinessBase` |
## Behavioral notes
- The object layers convenience logic over the loaded row, such as equality keys, related-row resolution, or validation helpers.
## Constraints and usage notes
- Retrieve the row with the same keys and effective context that the caller will use later, because helper members derive additional data from that loaded state.
> **Note:** Statements marked with `†` are derived from dependency library
> documentation via the Legends CLI. They describe inherited behavior from the
> indicated origin library and should be verified if the dependency version changes.
## Sources
- `Business\SAIF.Business.Policy.Rating\clsRateFileMaster.vb`