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

# clsImgsys

`clsImgsys` is a BOF business object for `IMGSYS` imaging system records. It manages the TOWID record that IMAGE rows reference, as well as batch state fields (BATID, IDXFL, DELCD) and associated metadata.

## Purpose
- Creates, retrieves, updates, and deletes IMGSYS rows that own the TOWID imaging reference key.
- Generates TOWID via the `tower.TOWER_SEQ` Oracle sequence.

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

## Public members

| Member | Signature | Purpose |
| --- | --- | --- |
| `Batid` | `Public Property Batid() As String` | Gets or sets the batch identifier stored on the IMGSYS row.* |
| `Crtrid` | `Public Property Crtrid() As String` | Gets or sets the creator user ID captured for the IMGSYS row.* |
| `Delcd` | `Public Property Delcd() As String` | Gets or sets the IMGSYS delete code used for soft-delete state.* |
| `Idxfl` | `Public Property Idxfl() As String` | Gets or sets the indexing-status flag stored on the IMGSYS row.* |
| `Ifnds` | `Public Property Ifnds() As Decimal` | Gets or sets the IFNDS value associated with the imaging-system record.* |
| `Ifnid` | `Public Property Ifnid() As Decimal` | Gets or sets the IFNID value associated with the imaging-system record.* |
| `Npages` | `Public Property Npages() As Decimal` | Gets or sets the page count stored for the imaging-system record.* |
| `Scandt` | `Public ReadOnly Property Scandt() As Date` | Returns the scan date stored for the IMGSYS row.* |
| `Slevel` | `Public Property Slevel() As Decimal` | Gets or sets the security level stored for the IMGSYS row.* |
| `Towid` | `Public ReadOnly Property Towid() As Decimal` | Returns the TOWID primary key generated for the IMGSYS row. |
| `Updrid` | `Public Property Updrid() As String` | Gets or sets the last-updater user ID stored for the IMGSYS row.* |
| `Updtts` | `Public ReadOnly Property Updtts() As Date` | Returns the last-update timestamp stored for the IMGSYS row.* |
| `MyCriteria` | `Public ReadOnly Property MyCriteria() As Criteria` | Returns the nested criteria object used to assemble SQL and portal requests.* |
| `SetBatidNull` | `Public Sub SetBatidNull()` | Sets `Batid` to `DBNull` for persistence.* |
| `SetDelcdNull` | `Public Sub SetDelcdNull()` | Sets `Delcd` to `DBNull` for persistence.* |
| `SetSlevelNull` | `Public Sub SetSlevelNull()` | Sets `Slevel` to `DBNull` for persistence.* |
| `SetupdridNull` | `Public Sub SetupdridNull()` | Sets `Updrid` to `DBNull` for persistence.* |
| `SetupdttsNull` | `Public Sub SetupdttsNull()` | Sets `Updtts` to `DBNull` for persistence.* |
| `SetidxflNull` | `Public Sub SetidxflNull()` | Sets `Idxfl` to `DBNull` for persistence.* |
| `IsBatidNull` | `Public Function IsBatidNull() As Boolean` | Returns whether `Batid` currently holds `DBNull`.* |
| `IsDelcdNull` | `Public Function IsDelcdNull() As Boolean` | Returns whether `Delcd` currently holds `DBNull`.* |
| `IsSlevelNull` | `Public Function IsSlevelNull() As Boolean` | Returns whether `Slevel` currently holds `DBNull`.* |
| `IsUpdrIdNull` | `Public Function IsUpdrIdNull() As Boolean` | Returns whether `Updrid` currently holds `DBNull`.* |
| `IsUpdttsNull` | `Public Function IsUpdttsNull() As Boolean` | Returns whether `Updtts` currently holds `DBNull`.* |
| `IsIdxflNull` | `Public Function IsIdxflNull() As Boolean` | Returns whether `Idxfl` currently holds `DBNull`.* |
| `Equals` | `Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Compares two `clsImgsys` instances for value equality. |
| `Equals` | `Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Compares this instance to another object for value equality. |
| `Equals` | `Public Overloads Function Equals(ByVal inObject As clsImgsys) As Boolean` | Compares this instance to another `clsImgsys` by TOWID. |
| `GetHashCode` | `Public Overrides Function GetHashCode() As Integer` | Returns a hash code derived from the IMGSYS key state.* |
| `ToString` | `Public Overrides Function ToString() As String` | Returns the IMGSYS record's key/display state as a string.* |
| `NewImgsys` | `Public Shared Function NewImgsys(ByVal inDataportal As IDataPortalInfo) As clsImgsys` | Factory method that creates a new `clsImgsys` instance. |
| `NewImgsys` | `Public Shared Function NewImgsys(ByVal inDataportal As IDataPortalInfo, ByVal inCreateUser As String) As clsImgsys` | Factory method that creates a new `clsImgsys` instance with an explicit creator ID. |
| `GetImgsys` | `Public Shared Function GetImgsys(ByVal inDataportal As IDataPortalInfo, ByVal inTowid As Decimal) As clsImgsys` | Retrieves an IMGSYS row by `Towid`. |
| `HasIFNDS` | `Public Function HasIFNDS(ByVal target As Object, ByVal e As clsRuleArgs) As Boolean` | Business-rule helper that validates whether the IFNDS value is populated when required.* |
| `HasIFNID` | `Public Function HasIFNID(ByVal target As Object, ByVal e As clsRuleArgs) As Boolean` | Business-rule helper that validates whether the IFNID value is populated when required.* |
| `HasBatchId` | `Public Function HasBatchId(ByVal target As Object, ByVal e As clsRuleArgs) As Boolean` | Business-rule helper that validates whether a batch ID is present when required.* |
| `HasNPages` | `Public Function HasNPages(ByVal target As Object, ByVal e As clsRuleArgs) As Boolean` | Business-rule helper that validates whether a page count is present when required.* |
| `Save` | `Public Overrides Function Save() As Boolean` | Persists the current object through the BOF data-portal save pipeline. |
| `SaveChild` | `Public Overrides Function SaveChild() As Boolean` | Persists the current child object through the BOF child-save pipeline. |
| `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` |

> **Note:** Statements marked with `*` are inferred from code behavior rather than explicit documentation or comments.

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