﻿---
title: clsPremiumPolicyLocation
summary: API reference for clsPremiumPolicyLocation.
status: draft
owner: Technical Writer
last_reviewed: 2026-07-31
library: SAIF.Business.Policy.Premium
reference_type: package
---

# clsPremiumPolicyLocation

Inherits `clsAddress`; represents a policy location used in premium reporting; provides address fields, location code, business sequence number, county data, and derived helpers (`CountyName`, `LocationTypeDescription`, `AuditContacts`) for premium summary reports. Retrieved by `GetPremiumPolicyLocation` using the location sequence number.*

## Purpose
- Provides policy location data (address, location code, county, business sequence number) for premium summary reporting, retrieved by location sequence number from Oracle.*
- Consumed by premium reporting and audit workflows that need policy location details to produce location-level premium summary documents.*

## Context
- Namespace: `SAIF.Business.Policy.Premium.Reporting`
- Assembly/package: `SAIF.Business.Policy.Premium`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| LocationSequenceNumber | `Public ReadOnly Property LocationSequenceNumber() As Decimal` | The Oracle sequence number uniquely identifying this policy location.* |
| PolicyNumber | `Public ReadOnly Property PolicyNumber() As Decimal` | The numeric policy number identifying the policy to which this record belongs. |
| EffectiveDate | `Public ReadOnly Property EffectiveDate() As Date` | The date from which this record is effective. |
| LocationCode | `Public ReadOnly Property LocationCode() As String` | The location code classifying this policy location's type.* |
| CreateUser | `Public ReadOnly Property CreateUser() As String` | The username of the account that created this record. |
| CreateDate | `Public ReadOnly Property CreateDate() As Date` | The timestamp at which this record was created in the Oracle database. |
| IsPrimaryLocation | `Public ReadOnly Property IsPrimaryLocation() As Boolean` | Returns True when this location is the primary policy location.* |
| BusinessSequenceNumber | `Public ReadOnly Property BusinessSequenceNumber() As Decimal` | The business sequence number linking this location to its insured business entity.* |
| ParentLocationSequenceNumber | `Public ReadOnly Property ParentLocationSequenceNumber() As Decimal` | The sequence number of the parent location for hierarchical location structures.* |
| ExpirationDate | `Public ReadOnly Property ExpirationDate() As Date` | The date on which this record expires; null indicates no expiration.* |
| CountyCode | `Public ReadOnly Property CountyCode() As String` | The county code for this policy location's physical address.* |
| SicCode | `Public ReadOnly Property SicCode() As String` | The Standard Industrial Classification (SIC) code for the business at this location.* |
| IsOKToSendMail | `Public ReadOnly Property IsOKToSendMail() As Boolean` | Returns True when the location is flagged to receive mailed documents.* |
| IsWaiverLocation | `Public ReadOnly Property IsWaiverLocation() As Boolean` | Returns True when this location is designated as a waiver location.* |
| UpdateUser | `Public ReadOnly Property UpdateUser() As String` | The username of the account that last modified this record.* |
| UpdateDate | `Public ReadOnly Property UpdateDate() As Date` | The timestamp of the most recent update to this record.* |
| Email | `Public ReadOnly Property Email() As String` | The email address associated with this policy location.* |
| EmployeeCount | `Public ReadOnly Property EmployeeCount() As Decimal` | The number of employees at this policy location.* |
| CellPhoneNumber | `Public ReadOnly Property CellPhoneNumber() As String` | The cell phone number associated with this policy location.* |
| Counties | `Public ReadOnly Property Counties() As clsCodeCollection` | The collection of county code reference entries available for this location.* |
| CountyName | `Public ReadOnly Property CountyName() As String` | The resolved county name derived from `CountyCode`.* |
| LocationCodes | `Public ReadOnly Property LocationCodes() As clsCodeCollection` | The collection of location code reference entries available for this location.* |
| LocationTypeDescription | `Public ReadOnly Property LocationTypeDescription() As String` | The human-readable description of this location's type.* |
| AuditContacts | `Public ReadOnly Property AuditContacts() As String` | The formatted audit contact string for this policy location.* |
| IsValid | `Public Overrides ReadOnly Property IsValid() As Boolean` | Returns True when all registered business rules pass; delegates to the framework rule engine. |
| IsDirty | `Public Overrides ReadOnly Property IsDirty() As Boolean` | Returns True when one or more tracked properties have been modified since the last save or MarkOld() call. |
| IsBusinessSequenceNumberNull | `Public Function IsBusinessSequenceNumberNull() As Boolean` | Tests whether `BusinessSequenceNumber` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsParentLocationSequenceNumberNull | `Public Function IsParentLocationSequenceNumberNull() As Boolean` | Tests whether `ParentLocationSequenceNumber` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsExpirationDateNull | `Public Function IsExpirationDateNull() As Boolean` | Tests whether `ExpirationDate` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsNameNull | `Public Function IsNameNull() As Boolean` | Tests whether `Name` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsAddressLine1Null | `Public Function IsAddressLine1Null() As Boolean` | Tests whether `AddressLine1` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsAddressLine2Null | `Public Function IsAddressLine2Null() As Boolean` | Tests whether `AddressLine2` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsCityNull | `Public Function IsCityNull() As Boolean` | Tests whether `City` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsCountryCodeNull | `Public Function IsCountryCodeNull() As Boolean` | Tests whether `CountryCode` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsCountyCodeNull | `Public Function IsCountyCodeNull() As Boolean` | Tests whether `CountyCode` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsPhoneNumberNull | `Public Function IsPhoneNumberNull() As Boolean` | Tests whether `PhoneNumber` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsFaxNull | `Public Function IsFaxNull() As Boolean` | Tests whether `Fax` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsStateCodeNull | `Public Function IsStateCodeNull() As Boolean` | Tests whether `StateCode` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsZipCodeNull | `Public Function IsZipCodeNull() As Boolean` | Tests whether `ZipCode` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsZipCodeExtensionNull | `Public Function IsZipCodeExtensionNull() As Boolean` | Tests whether `ZipCodeExtension` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsMailFlagNull | `Public Function IsMailFlagNull() As Boolean` | Tests whether `MailFlag` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsUpdateUserNull | `Public Function IsUpdateUserNull() As Boolean` | Tests whether `UpdateUser` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsUpdateDateNull | `Public Function IsUpdateDateNull() As Boolean` | Tests whether `UpdateDate` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsEmailNull | `Public Function IsEmailNull() As Boolean` | Tests whether `Email` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsEmployeeCountNull | `Public Function IsEmployeeCountNull() As Boolean` | Tests whether `EmployeeCount` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsAddressLine3Null | `Public Function IsAddressLine3Null() As Boolean` | Tests whether `AddressLine3` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsCellPhoneNumberNull | `Public Function IsCellPhoneNumberNull() As Boolean` | Tests whether `CellPhoneNumber` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| Equals | `Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Static overload: compares two Object references for equality using value-equality semantics.* |
| Equals | `Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Compares this instance with another `Object` instance for value equality.* |
| Equals | `Public Overloads Function Equals(ByVal inObject As clsPremiumPolicyLocation) As Boolean` | Compares this instance with another `clsPremiumPolicyLocation` instance for value equality.* |
| GetHashCode | `Public Overrides Function GetHashCode() As Integer` | Returns a hash code consistent with the value-equality implementation. |
| ToString | `Public Overrides Function ToString() As String` | Returns a string representation of this instance, typically for diagnostics.* |
| GetPremiumPolicyLocation | `Public Shared Function GetPremiumPolicyLocation(ByVal inDataportal As IDataPortalInfo, ByVal inLocationSequenceNumber As Decimal) As clsPremiumPolicyLocation` | Loads a cls premium policy location that matches the supplied lookup criteria. |
## Behavioral notes
- Source file: `Business\SAIF.Business.Policy.Premium\Reporting\clsPremiumPolicyLocation.vb`.
- This type inherits `clsAddress`, but that framework base class was not resolvable in indexed dependency documentation; inherited address-specific members are not restated here.**

## Constraints and usage notes
- This type inherits `clsAddress`, which was not resolvable in indexed dependency documentation; inherited address-specific members are not documented here.** Retrieved by location sequence number only.*


> **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.Policy.Premium\Reporting\clsPremiumPolicyLocation.vb`