---
title: clsImage
summary: API reference for clsImage.
status: draft
owner: <owner>
last_reviewed: 2026-07-24
library: SAIF.Business.Imaging
reference_type: package
---

# clsImage

`clsImage` is the core image record entity class representing a stored or indexed document image. It holds the metadata properties of a single image row and is used alongside `clsImageCollection` for collection-level retrieval*.

## Purpose
- Represents a single document image record with its classification codes, claim/policy association, display settings, and audit fields.
- Populated by collection and index queries through the BOF `Fill()` pattern*.

## Context
- Namespace: `SAIF.Business.Imaging`
- Assembly/package: `SAIF.BOF.Business.Imaging`

## Public members

| Member | Signature | Purpose |
| --- | --- | --- |
| `m_ImageIdx` | `Public m_ImageIdx As New clsImageIdx` | Exposes the embedded `New clsImageIdx` helper used by `clsImage`.* |
| `m_ImgSys` | `Public m_ImgSys As New clsImgsys` | Exposes the embedded `New clsImgsys` helper used by `clsImage`.* |
| `m_ImageCache` | `Public m_ImageCache As New clsImageCache` | Exposes the embedded `New clsImageCache` helper used by `clsImage`.* |
| `AssociateToEAIPPeriod` | `Public Property AssociateToEAIPPeriod() As Boolean` | Gets or sets associate to eaip period.* |
| `Batid` | `Public Property Batid() As String` | Gets or sets batid.* |
| `ClaimID` | `Public Property ClaimID() As Decimal` | Gets or sets claim id.* |
| `BillAlertAdd` | `Public ReadOnly Property BillAlertAdd() As Boolean` | Returns bill alert add.* |
| `BillAlertRemove` | `Public ReadOnly Property BillAlertRemove() As Boolean` | Returns bill alert remove.* |
| `ClaimNum` | `Public Property ClaimNum() As String` | Gets or sets claim num.* |
| `CommentText` | `Public Property CommentText() As String` | Gets or sets comment text.* |
| `CacheStatus` | `Public ReadOnly Property CacheStatus As String` | Returns cache status.* |
| `CreateDate` | `Public ReadOnly Property CreateDate() As Date` | Returns create date.* |
| `CreateUser` | `Public ReadOnly Property CreateUser() As String` | Returns create user.* |
| `Crtrid` | `Public ReadOnly Property Crtrid() As String` | Returns crtrid.* |
| `Delcd` | `Public Property Delcd() As String` | Gets or sets delcd.* |
| `DiscoveryFlag` | `Public Property DiscoveryFlag() As String` | Gets or sets discovery flag.* |
| `DisplayField1` | `Public Property DisplayField1() As String` | Gets or sets display field1.* |
| `DisplayField2` | `Public Property DisplayField2() As String` | Gets or sets display field2.* |
| `DisplayField3` | `Public Property DisplayField3() As String` | Gets or sets display field3.* |
| `DisplaySortNum` | `Public Property DisplaySortNum() As Decimal` | Gets or sets display sort num.* |
| `DocumentDate` | `Public Property DocumentDate() As Date` | Gets or sets document date.* |
| `DocumentDateDays` | `Public Property DocumentDateDays() As Integer` | Gets or sets document date days.* |
| `EAIPPeriodSeq` | `Public Property EAIPPeriodSeq() As Decimal` | Gets or sets eaip period seq.* |
| `EAIPPeriodDate` | `Public Property EAIPPeriodDate() As Date` | Gets or sets eaip period date.* |
| `EAIPMode` | `Public Property EAIPMode() As Boolean` | Gets or sets eaip mode.* |
| `FullIfndsIfnid` | `Public ReadOnly Property FullIfndsIfnid() As String` | Returns full ifnds ifnid.* |
| `Idxfl` | `Public Property Idxfl() As String` | Gets or sets idxfl.* |
| `Ifnds` | `Public Property Ifnds() As Decimal` | Gets or sets ifnds.* |
| `Ifnid` | `Public Property Ifnid() As Decimal` | Gets or sets ifnid.* |
| `ImageCategoryCode` | `Public Property ImageCategoryCode() As String` | Gets or sets image category code.* |
| `ImageCategoryDescr` | `Public ReadOnly Property ImageCategoryDescr() As String` | Returns image category descr.* |
| `ImageCategoryExternalDescr` | `Public ReadOnly Property ImageCategoryExternalDescr() As String` | Returns image category external descr.* |
| `ImageDeleteCode` | `Public Property ImageDeleteCode() As String` | Gets or sets image delete code.* |
| `ImageDeleteFlag` | `Public Property ImageDeleteFlag() As Boolean` | Gets or sets image delete flag.* |
| `ImageDocumentTypeCode` | `Public Property ImageDocumentTypeCode() As String` | Gets or sets image document type code.* |
| `ImageDocumentTypeDescr` | `Public ReadOnly Property ImageDocumentTypeDescr() As String` | Returns image document type descr.* |
| `ImageDocumentTypeExternalDescr` | `Public ReadOnly Property ImageDocumentTypeExternalDescr() As String` | Returns image document type external descr.* |
| `ImageDocumentNameDescr` | `Public ReadOnly Property ImageDocumentNameDescr As String` | Returns image document name descr.* |
| `ImageDocumentNameCode` | `Public Property ImageDocumentNameCode As String` | Gets or sets image document name code.* |
| `ImageFileCode` | `Public Property ImageFileCode() As String` | Gets or sets image file code.* |
| `ImageSeqNum` | `Public Property ImageSeqNum() As Decimal` | Gets or sets image seq num.* |
| `MaskedCreateUser` | `Public ReadOnly Property MaskedCreateUser() As String` | Returns masked create user.* |
| `Npages` | `Public Property Npages() As Decimal` | Gets or sets npages.* |
| `PolicyNum` | `Public Property PolicyNum() As Decimal` | Gets or sets policy num.* |
| `ReceivedDate` | `Public Property ReceivedDate() As Date` | Gets or sets received date.* |
| `Scandt` | `Public ReadOnly Property Scandt() As Date` | Returns scandt.* |
| `SecurityLevelNum` | `Public Property SecurityLevelNum() As Decimal` | Gets or sets security level num.* |
| `Slevel` | `Public Property Slevel() As Decimal` | Gets or sets slevel.* |
| `Towid` | `Public Property Towid() As Decimal` | Gets or sets towid.* |
| `UpdateDate` | `Public ReadOnly Property UpdateDate() As Date` | Returns update date.* |
| `UpdateUser` | `Public ReadOnly Property UpdateUser() As String` | Returns update user.* |
| `Updrid` | `Public ReadOnly Property Updrid() As String` | Returns updrid.* |
| `UpdtTs` | `Public ReadOnly Property UpdtTs() As Date` | Returns updt ts.* |
| `ExternalViewCode` | `Public Property ExternalViewCode As String` | Gets or sets external view code.* |
| `ExternalViewUpdateDate` | `Public Property ExternalViewUpdateDate As Date` | Gets or sets external view update date.* |
| `SystemGeneratedFlag` | `Public Property SystemGeneratedFlag As Boolean` | Gets or sets system generated flag.* |
| `CanBulkUpdateExternalViewToShow` | `Public ReadOnly Property CanBulkUpdateExternalViewToShow As Boolean` | Returns can bulk update external view to show.* |
| `CanDelete` | `Public Property CanDelete As Boolean` | Gets or sets can delete.* |
| `AgencyId` | `Public Property AgencyId() As Decimal` | Gets or sets agency id.* |
| `ProducerId` | `Public Property ProducerId() As Decimal` | Gets or sets producer id.* |
| `GroupAssociationCode` | `Public Property GroupAssociationCode() As String` | Gets or sets group association code.* |
| `ImageDocumentTypeList` | `Public ReadOnly Property ImageDocumentTypeList As clsImageDocumentTypeCodeCollection` | Returns image document type list.* |
| `CanBulkUpdateExternalViewToHide` | `Public ReadOnly Property CanBulkUpdateExternalViewToHide As Boolean` | Returns can bulk update external view to hide.* |
| `MyCriteria` | `Public ReadOnly Property MyCriteria() As Criteria` | Returns the nested criteria object used to assemble SQL and portal requests.* |
| `IsValid` | `Public Overrides ReadOnly Property IsValid() As Boolean` | Returns is valid.* |
| `IsDirty` | `Public Overrides ReadOnly Property IsDirty() As Boolean` | Returns is dirty.* |
| `IsSavable` | `Public Overrides ReadOnly Property IsSavable() As Boolean` | Returns is savable.* |
| `Equals` | `Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Compares this instance to another instance for value equality. |
| `Equals` | `Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Compares this instance to another instance for value equality. |
| `Equals` | `Public Overloads Function Equals(ByVal inObject As clsImage) As Boolean` | Compares this instance to another instance for value equality. |
| `GetHashCode` | `Public Overrides Function GetHashCode() As Integer` | Retrieves hash code for the requested criteria or key values.* |
| `ToString` | `Public Overrides Function ToString() As String` | Returns the object's display/key value as a string.* |
| `NewImage` | `Public Shared Function NewImage(ByVal inDataportal As IDataPortalInfo) As clsImage` | Create new ImageObject. |
| `NewImage` | `Public Shared Function NewImage(ByVal inDataportal As IDataPortalInfo, ByVal inCreateUser As String) As clsImage` | Create new ImageObject. Use when you want to manually set the CreateUser. This is mainly for batch applications. |
| `NewImage` | `Public Shared Function NewImage(ByVal inDataportal As IDataPortalInfo, ByVal inImageSeqNum As Decimal, ByVal inCreateUser As String) As clsImage` | Create a new image object. Use only when you want to set the ImageSeqNum manually. Use primarily by AutoImportService. |
| `GetImage` | `Public Shared Function GetImage(ByVal inDataportal As IDataPortalInfo, ByVal inImageSeqNum As Decimal) As clsImage` | Retrieves image for the requested criteria or key values.* |
| `Save` | `Public Overrides Function Save() As Boolean` | Persists the current object or collection through the BOF data-portal save pipeline. |
| `SaveChild` | `Public Overrides Function SaveChild() As Boolean` | Persists the current child object or child collection through the BOF child-save pipeline. |
| `GetIFNByTowId` | `Public Shared Function GetIFNByTowId(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inTowID As Decimal) As String` | Retrieves ifn by tow id for the requested criteria or key values.* |
| `GetIFNByImageSeqNum` | `Public Shared Function GetIFNByImageSeqNum(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inImageSeqNum As Decimal) As String` | Retrieves ifn by image seq num for the requested criteria or key values.* |
| `ReInititialData` | `Public Sub ReInititialData()` | Performs the re inititial data operation.* |
| `Copy` | `Public Shadows Function Copy() As clsImage` | Creates a duplicate Address (New, but not dirty). |
| `Criteria` | `Public Class Criteria` | Nested criteria type that stores SQL text and request state for BOF data-portal operations.* |

## Inherited public members

Members in this section are inherited from `clsBusinessBase` and are available on this type through the standard BOF base-class contract.

| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| `MyGuid` | `Public ReadOnly Property MyGuid() As String` | Returns the unique GUID for this object. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `IsNew` | `Public ReadOnly Property IsNew() As Boolean` | Returns True if this is a new object, False if it is a pre-existing object. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `IsDeleted` | `Public ReadOnly Property IsDeleted() As Boolean` | Returns True if this object is marked for deletion. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `IsDirty` | `Public Overridable ReadOnly Property IsDirty() As Boolean` | Returns True if this object's data has been changed. | `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` | Takes two values and compares them using the Equals function. If the values are different, it sets the inFieldValue = inSetValue, calls MarkDirty(), and returns True. Otherwise returns false. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `IsSavable` | `Public Overridable ReadOnly Property IsSavable() As Boolean` | Returns True if this object is both dirty and valid. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `PreviousLinkItem` | `Public ReadOnly Property PreviousLinkItem() As ILinkItem Implements ILinkItem.PreviousLinkItem` | Gets the Previous Item linked to this one. If this is the first item or not a member of a linked list, the value is nothing. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `NextLinkItem` | `Public ReadOnly Property NextLinkItem() As ILinkItem Implements ILinkItem.NextLinkItem` | Gets the Next Item linked to this one. If this item is the last or not a member of a linked list, the value is nothing. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `SetPreviousLink` | `Public Sub SetPreviousLink(ByRef inLinkItem As ILinkItem) Implements ILinkItem.SetPreviousLink` | Sets the Previous Item in Linked List | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `SetNextLink` | `Public Sub SetNextLink(ByRef inLinkItem As ILinkItem) Implements ILinkItem.SetNextLink` | Sets the Next Item in a Linked List. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `InsertLinkAfter` | `Public Sub InsertLinkAfter(ByRef inLinkItem As ILinkItem) Implements ILinkItem.InsertLinkAfter` | Inserts the item being passed in into the linked list after the current item. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `InsertLinkBefore` | `Public Sub InsertLinkBefore(ByRef inLinkItem As ILinkItem) Implements ILinkItem.InsertLinkBefore` | Inserts the item being passed in into the linked list prior to the current item. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `RemoveLinks` | `Public Sub RemoveLinks() Implements ILinkItem.RemoveLinks` | Removes this item from a linked list. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `BeginEdit` | `Public Sub BeginEdit()` | Starts a nested edit on the object. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `CancelEdit` | `Public Sub CancelEdit()` | Cancels the current edit process, restoring the object's state to its previous values. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `ApplyEdit` | `Public Sub ApplyEdit()` | Commits the current edit process. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `Delete` | `Public Sub Delete()` | Marks the object for deletion. The object will be deleted as part of the next save operation. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `Clone` | `Public Function Clone() As Object Implements ICloneable.Clone` | Returns a new object containing the exact data of the original object. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `ValidateOnDelete` | `Public Property ValidateOnDelete() As Boolean` | Gets or Sets whether Business Rules are Validated on a Deleted Object. By Default this property is set to False. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `Rules` | `Public ReadOnly Property Rules() As clsRulesManager` | Provides Access to the Objects Rules Manager | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `IsValid` | `Public Overridable ReadOnly Property IsValid() As Boolean` | The IsValid routine Checks all Rules and then returns true if the error count is zero. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `ErrorCount` | `Public ReadOnly Property ErrorCount() As Integer` | Returns the number of errors generated by the Object. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `ErrorMessages` | `Public ReadOnly Property ErrorMessages() As String()` | Returns a string array of Error Messages generated by the Object. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `WarningCount` | `Public ReadOnly Property WarningCount() As Integer` | Returns the Number of Warnings generated by the object. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `WarningMessages` | `Public ReadOnly Property WarningMessages() As String()` | Returns a string array of Warning Messages generated by the Object. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `InformationalCount` | `Public ReadOnly Property InformationalCount() As Integer` | Returns the number of errors generated by the Object. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `InformationalMessages` | `Public ReadOnly Property InformationalMessages() As String()` | Returns a string array of Warning Messages generated by the Object. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `Save` | `Public Overridable Function Save() As Boolean` | Saves the object to the database. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `SaveChild` | `Public Overridable Function SaveChild() As Boolean` | Saves the child object to the database. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `XMLElementName` | `Public Property XMLElementName() As String` | Returns the Value used as the TagName when generating XML. | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `GetDataset` | `Public Sub GetDataset(ByRef inDS As DataSet)` | Retrieves dataset for the requested criteria or key values.* | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `GetDataset` | `Public Sub GetDataset(ByRef inDS As DataSet, ByVal inTableName As String)` | Retrieves dataset for the requested criteria or key values.* | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `GetReportXML` | `Public Function GetReportXML(ByVal inElementName As String) As String` | Retrieves report xml for the requested criteria or key values.* | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `GetReportXML` | `Public Function GetReportXML() As String` | Retrieves report xml for the requested criteria or key values.* | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `ToXml` | `Public Function ToXml() As String` | Returns to xml.* | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `ToXml` | `Public Function ToXml(ByVal inTagName As String) As String` | Returns to xml.* | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |

## Behavioral notes
- `clsImage` is a BOF entity class; its public properties correspond to columns returned by the image collection and index queries (e.g., IMAGE_SEQ_NUM, IMAGE_CATEGORY_CODE, IMAGE_DOCUMENT_TYPE_CODE)*.
- This class does not contain its own `IBusinessCriteria` implementation; persistence is managed by `clsImageIdx` and `clsImageCollection`*.

## Constraints and usage notes


> **Note:** Statements marked with `*` were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts.

## Sources
- `Business\SAIF.Business.Imaging\clsImage.vb`
- `Legacy\BusinessObjectFramework\clsBusinessBase.vb`