clsAuditor¶

clsAuditor is the BOF business object representing a premium auditor entity used in claim audit-assignment workflows. It manages auditor identity, scheduling flags, vendor association, and reviewer designations persisted to the PA_AUDITOR table.

Purpose¶

Represent a single premium auditor record.
Provide CRUD lifecycle (insert, retrieve, update) via BOF IBusinessCriteria against PA_AUDITOR.
Support audit-assignment logic through scheduling, filter, and reviewer flags.

Context¶

Namespace: SAIF.Business.External.Users*
Assembly/package: SAIF.BOF.Business.External.Users
Base class: clsBusinessBase (from SAIF.BOF.Framework)*

Public members¶

Member	Signature	Purpose
`AssignToAuditorID`	`Public ReadOnly Property AssignToAuditorID() As String`	Gets or sets the assign to auditor id.*
`AuditorAssigneeID`	`Public Property AuditorAssigneeID() As String`	Gets or sets the auditor assignee id.*
`AuditorEmailAddr`	`Public Property AuditorEmailAddr() As String`	Gets or sets the auditor email addr.*
`AuditorID`	`Public ReadOnly Property AuditorID() As String`	`PA_AUDITOR.PA_AUDITOR_ID` — primary key, allocated via SQL-001.*
`AuditorName`	`Public Property AuditorName() As String`	Gets or sets the auditor name.*
`AuditorShortName`	`Public Property AuditorShortName() As String`	Gets or sets the auditor short name.*
`AuditorTerritory`	`Public ReadOnly Property AuditorTerritory() As clsAuditorZipCodeCollection`	Gets or sets the auditor territory.*
`HasTerritory`	`Public ReadOnly Property HasTerritory() As Boolean`	Gets or sets the has territory.*
`IsActive`	`Public ReadOnly Property IsActive() As Boolean`	Gets or sets the is active.*
`IsAssignable`	`Public Property IsAssignable() As Boolean`	Gets or sets the is assignable.*
`IsFeeAuditor`	`Public ReadOnly Property IsFeeAuditor() As Boolean`	Gets or sets the is fee auditor.*
`IsFilterable`	`Public Property IsFilterable() As Boolean`	Gets or sets the is filterable.*
`IsSchedulable`	`Public Property IsSchedulable() As Boolean`	Gets or sets the is schedulable.*
`IsSAIFAuditor`	`Public ReadOnly Property IsSAIFAuditor() As Boolean`	Gets or sets the is saifauditor.*
`IsNCCIAuditor`	`Public ReadOnly Property IsNCCIAuditor() As Boolean`	Gets or sets the is ncciauditor.*
`IsMonthlyMaxReached`	`Public ReadOnly Property IsMonthlyMaxReached() As Boolean`	Gets or sets the is monthly max reached.*
`IsReviewer`	`Public Property IsReviewer() As Boolean`	Gets or sets the is reviewer.*
`IsActiveReviewer`	`Public Property IsActiveReviewer() As Boolean`	Gets or sets the is active reviewer.*
`MonthlyCount`	`Public Property MonthlyCount() As Decimal`	Gets or sets the monthly count.*
`MonthlyMaximumCount`	`Public Property MonthlyMaximumCount() As Decimal`	Gets or sets the monthly maximum count.*
`UserID`	`Public Property UserID() As String`	Gets or sets the user id.*
`VendorNumber`	`Public Property VendorNumber() As String`	Gets or sets the vendor number.*
`IsValid`	`Public Overrides ReadOnly Property IsValid() As Boolean`	Gets or sets the is valid.*
`IsDirty`	`Public Overrides ReadOnly Property IsDirty() As Boolean`	Gets or sets the is dirty.*
`SetAuditorAssigneeIDNull`	`Public Sub SetAuditorAssigneeIDNull()`	Sets auditor assignee idnull.*
`SetAuditorEmailAddrNull`	`Public Sub SetAuditorEmailAddrNull()`	Sets auditor email addr null.*
`SetMonthlyMaximumCountNull`	`Public Sub SetMonthlyMaximumCountNull()`	Sets monthly maximum count null.*
`SetUserIDNull`	`Public Sub SetUserIDNull()`	Sets user idnull.*
`SetVendorNumberNull`	`Public Sub SetVendorNumberNull()`	Sets vendor number null.*
`SetAssignToAuditorIDNull`	`Public Sub SetAssignToAuditorIDNull()`	Sets assign to auditor idnull.*
`IsAuditorAssigneeIDNull`	`Public Function IsAuditorAssigneeIDNull() As Boolean`	Returns whether auditor assignee idnull.*
`IsAuditorEmailAddrNull`	`Public Function IsAuditorEmailAddrNull() As Boolean`	Returns whether auditor email addr null.*
`IsMonthlyMaximumCountNull`	`Public Function IsMonthlyMaximumCountNull() As Boolean`	Returns whether monthly maximum count null.*
`IsUserIDNull`	`Public Function IsUserIDNull() As Boolean`	Returns whether user idnull.*
`IsVendorNumberNull`	`Public Function IsVendorNumberNull() As Boolean`	Returns whether vendor number null.*
`IsAssignToAuditorIDNull`	`Public Function IsAssignToAuditorIDNull() As Boolean`	Returns whether assign to auditor idnull.*
`Equals`	`Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean`	Executes the `Equals` operation.*
`Equals`	`Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean`	Executes the `Equals` operation.*
`Equals`	`Public Overloads Function Equals(ByVal inObject As clsAuditor) As Boolean`	Executes the `Equals` operation.*
`GetHashCode`	`Public Overrides Function GetHashCode() As Integer`	Retrieves hash code.*
`ToString`	`Public Overrides Function ToString() As String`	Executes the `ToString` operation.*
`NewAuditor`	`Public Shared Function NewAuditor(ByVal inDataportal As IDataPortalInfo) As clsAuditor`	Executes the `NewAuditor` operation.*
`GetAuditorByAuditorID`	`Public Shared Function GetAuditorByAuditorID(ByVal inDataportal As IDataPortalInfo, ByVal inAuditorID As String) As clsAuditor`	Retrieves an Auditor for a given Auditor ID.
`GetAuditorByUserID`	`Public Shared Function GetAuditorByUserID(ByVal inDataportal As IDataPortalInfo, ByVal inUserID As String) As clsAuditor`	Retrieves an Auditor for a given User ID.
`GetDefaultAuditorForPolicy`	`Public Shared Function GetDefaultAuditorForPolicy(ByVal inDataportal As IDataPortalInfo, _ ByVal inPolicyNumber As Decimal, _ ByVal inZipCode As String, _ Optional ByVal inAuditTypeCode As String = clsAudit.AUDIT_TYPE_FINAL) As clsAuditor`	Retrieves the default Auditor for the given Policy number and zip code. an auditor object instance.

Inherited public members¶

Members in this section are inherited from BOF framework base types whose package/source files are present in this repository.

Additional data-binding members inherited through clsBindableBase could not be verified because that source file is not present in this repository.**

Member	Signature	Purpose	Origin
`MyGuid`	`Public ReadOnly Property MyGuid() As String`	Gets or sets the my guid.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`IsNew`	`Public ReadOnly Property IsNew() As Boolean`	Gets or sets the is new.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`IsDeleted`	`Public ReadOnly Property IsDeleted() As Boolean`	Gets or sets the is deleted.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`IsDirty`	`Public Overridable ReadOnly Property IsDirty() As Boolean`	Gets or sets the is dirty.*	`SAIF.BOF.Framework` — `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. Enter the original Value Enter the new Value Enter False if you do not wish to mark the object as dirty. This is the equivalent of using the equality operator (=) on all structures.	`SAIF.BOF.Framework` — `clsBusinessBase`
`IsSavable`	`Public Overridable ReadOnly Property IsSavable() As Boolean`	Gets or sets the is savable.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`PreviousLinkItem`	`Public ReadOnly Property PreviousLinkItem() As ILinkItem Implements ILinkItem.PreviousLinkItem`	Gets or sets the previous link item.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`NextLinkItem`	`Public ReadOnly Property NextLinkItem() As ILinkItem Implements ILinkItem.NextLinkItem`	Gets or sets the next link item.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`SetPreviousLink`	`Public Sub SetPreviousLink(ByRef inLinkItem As ILinkItem) Implements ILinkItem.SetPreviousLink`	Sets the Previous Item in Linked List.	`SAIF.BOF.Framework` — `clsBusinessBase`
`SetNextLink`	`Public Sub SetNextLink(ByRef inLinkItem As ILinkItem) Implements ILinkItem.SetNextLink`	Sets the Next Item in a Linked List.	`SAIF.BOF.Framework` — `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. A Valid Business Object.	`SAIF.BOF.Framework` — `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. A Valid Business Object.	`SAIF.BOF.Framework` — `clsBusinessBase`
`RemoveLinks`	`Public Sub RemoveLinks() Implements ILinkItem.RemoveLinks`	Removes this item from a linked list. Updates the members of the List on both sides of the item and then sets his internal next and previous link items to nothing.	`SAIF.BOF.Framework` — `clsBusinessBase`
`BeginEdit`	`Public Sub BeginEdit()`	Starts a nested edit on the object. When this method is called the object takes a snapshot of its current state (the values of its variables). This snapshot can be restored by calling BusinessBase.CancelEdit or committed by calling BusinessBase.ApplyEdit. This is a nested operation. Each call to BeginEdit adds a new snapshot of the object's state to a stack. You should ensure that for each call to BeginEdit there is a corresponding call to either CancelEdit or ApplyEdit to remove that snapshot from the stack.	`SAIF.BOF.Framework` — `clsBusinessBase`
`CancelEdit`	`Public Sub CancelEdit()`	Cancels the current edit process, restoring the object's state to its previous values. Calling this method causes the most recently taken snapshot of the object's state to be restored. This resets the object's values to the point of the last BusinessBase.BeginEditcall. [jimmil] 10/05/2006 Created.	`SAIF.BOF.Framework` — `clsBusinessBase`
`ApplyEdit`	`Public Sub ApplyEdit()`	Commits the current edit process. Calling this method causes the most recently taken snapshot of the object's state to be discarded, thus committing any changes made to the object's state since the last BusinessBase.BeginEdit call.	`SAIF.BOF.Framework` — `clsBusinessBase`
`Delete`	`Public Sub Delete()`	Marks the object for deletion. The object will be deleted as part of the next save operation. The Object Framework supports both immediate and deferred deletion of objects. This method is part of the support for deferred deletion, where an object can be marked for deletion, but isn't actually deleted until the object is saved to the database. This method is called by the UI developer to mark the object for deletion. To 'undelete' an object, use BusinessBase.BeginEdit before calling the Delete method. You can then use CancelEdit later to reset the object's state to its original values. This will include resetting the deleted flag to False.	`SAIF.BOF.Framework` — `clsBusinessBase`
`Clone`	`Public Function Clone() As Object _ Implements ICloneable.Clone`	Returns a new object containing the exact data of the original object. It should be noted that the cloned object does not have access to the Data Access Layer.	`SAIF.BOF.Framework` — `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.	`SAIF.BOF.Framework` — `clsBusinessBase`
`Rules`	`Public ReadOnly Property Rules() As clsRulesManager`	Gets or sets the rules.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`IsValid`	`Public Overridable ReadOnly Property IsValid() As Boolean`	Gets or sets the is valid.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`ErrorCount`	`Public ReadOnly Property ErrorCount() As Integer`	Gets or sets the error count.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`ErrorMessages`	`Public ReadOnly Property ErrorMessages() As String()`	Gets or sets the error messages.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`WarningCount`	`Public ReadOnly Property WarningCount() As Integer`	Gets or sets the warning count.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`WarningMessages`	`Public ReadOnly Property WarningMessages() As String()`	Gets or sets the warning messages.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`InformationalCount`	`Public ReadOnly Property InformationalCount() As Integer`	Gets or sets the informational count.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`InformationalMessages`	`Public ReadOnly Property InformationalMessages() As String()`	Gets or sets the informational messages.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`Save`	`Public Overridable Function Save() As Boolean`	Saves the object to the database. Calling this method starts the save operation, causing the object to be inserted, updated or deleted within the database based on the object's current state. If BusinessBase.IsDeleted is True the object will be deleted. Otherwise, if BusinessBase.IsNew is True the object will be inserted. Otherwise the object's data will be updated in the database. All this is contingent on BusinessBase.IsDirty. If this value is False, no data operation occurs. It is also contingent on BusinessBase.IsValid. If this value is False an exception will be thrown to indicate that the UI attempted to save an invalid object. It is important to note that this method returns a new version of the business object that contains any data updated during the save operation. You MUST update all object references to use this new version of the business object in order to have access to the correct object data. You can override this method to add your own custom behaviors to the save operation. For instance, you may add some security checks to make sure the user can save the object. If all security checks pass, you would then invoke the base Save method via MyBase.Save().	`SAIF.BOF.Framework` — `clsBusinessBase`
`SaveChild`	`Public Overridable Function SaveChild() As Boolean`	Saves the child object to the database. Calling this method starts the save operation, causing the object to be inserted, updated or deleted within the database based on the object's current state. If BusinessBase.IsDeleted is True the object will be deleted. Otherwise, if BusinessBase.IsNew is True the object will be inserted. Otherwise the object's data will be updated in the database. All this is contingent on BusinessBase.IsDirty. If this value is False, no data operation occurs. It is also contingent on BusinessBase.IsValid. If this value is False an exception will be thrown to indicate that the UI attempted to save an invalid object. It is important to note that this method returns a new version of the business object that contains any data updated during the save operation. You MUST update all object references to use this new version of the business object in order to have access to the correct object data. You can override this method to add your own custom behaviors to the save operation. For instance, you may add some security checks to make sure the user can save the object. If all security checks pass, you would then invoke the base Save method via MyBase.SaveChild().	`SAIF.BOF.Framework` — `clsBusinessBase`
`XMLElementName`	`Public Property XMLElementName() As String`	Returns the Value used as the TagName when generating XML.	`SAIF.BOF.Framework` — `clsBusinessBase`
`GetDataset`	`Public Sub GetDataset(ByRef inDS As DataSet)`	Performs the `GetDataset` action.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`GetDataset`	`Public Sub GetDataset(ByRef inDS As DataSet, ByVal inTableName As String)`	Performs the `GetDataset` action.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`GetReportXML`	`Public Function GetReportXML(ByVal inElementName As String) As String`	Retrieves report xml.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`GetReportXML`	`Public Function GetReportXML() As String`	Retrieves report xml.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`ToXml`	`Public Function ToXml() As String`	Executes the `ToXml` operation.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`ToXml`	`Public Function ToXml(ByVal inTagName As String) As String`	Executes the `ToXml` operation.*	`SAIF.BOF.Framework` — `clsBusinessBase`
`DumpState`	`Public Sub DumpState()`	Writes the object's field data into the debugger output window in VS.NET. [jimmil] 10/04/2006 Created.	`SAIF.BOF.Framework` — `clsUndoableBase`
`AllowCache`	`Public Property AllowCache() As Boolean Implements IBusinessObject.AllowCache`	Gets or sets the allow cache.*	`SAIF.BOF.Framework` — `clsUndoableBase`

Behavioral notes¶

Auditor ID is not sequence-generated; SQL-001 retrieves MAX(PA_AUDITOR_ID) + 1 as the next ID.*
INSERT binds 13 parameters to PA_AUDITOR (SQL-003); UPDATE binds the same 13 (SQL-043).*
Retrieve supports lookup by AuditorID OR matching user_id via SQL-011.*

Constraints and usage notes¶

No delete operation is defined on individual clsAuditor records.*
The PA_AUDITOR table schema owner is unqualified.**

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.External.Users\clsAuditor.vb
Legacy\BusinessObjectFramework\clsBusinessBase.vb
Legacy\BusinessObjectFramework\clsUndoableBase.vb
Services\SAIF.Services.Printing.Remote\packages\SAIF.BOF.Framework.2.0.22103.3\src\SAIF.BOF.Framework.Core\V1\BaseItems\clsBusinessBase.vb
Services\SAIF.Services.Printing.Remote\packages\SAIF.BOF.Framework.2.0.22103.3\src\SAIF.BOF.Framework.Core\V1\BaseItems\clsUndoableBase.vb