Skip to content

clsZipCode

clsZipCode is a standalone BOF read-only business object that retrieves zip-code routing data (audit office code, county, region) from PA_ZIP_CODE and related tables.

Purpose

  • Look up audit office routing and county/region data for a given zip code.*
  • Support the geographic assignment workflow for claim audit routing.*

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
RetrieveSQL Public Const RetrieveSQL As String = " SELECT z.zip_code AS zipcode, " + _ " NVL (z.audit_office_code, c.office_code) AS auditofficecode, " + _ " ao.code_descr AS auditofficename, z.state_code AS statecode, " + _ " z.county_code AS countycode, c.county_name AS countyname, " + _ " c.office_code AS officecode, o.code_descr AS officename, " + _ " o.policy_region_code AS policyregioncode " + _ " FROM pa_zip_code z " + _ " left outer JOIN county c " + _ " ON (z.county_code = c.county_code) " + _ " left outer JOIN office_code o " + _ " ON (c.office_code = o.code) " + _ " left outer JOIN office_code ao " + _ " ON (z.audit_office_code = ao.code) " Represents the retrieve sql constant with value " SELECT z.zip_code AS zipcode, " + _ " NVL (z.audit_office_code, c.office_code) AS auditofficecode, " + _ " ao.code_descr AS auditofficename, z.state_code AS statecode, " + _ " z.county_code AS countycode, c.county_name AS countyname, " + _ " c.office_code AS officecode, o.code_descr AS officename, " + _ " o.policy_region_code AS policyregioncode " + _ " FROM pa_zip_code z " + _ " left outer JOIN county c " + _ " ON (z.county_code = c.county_code) " + _ " left outer JOIN office_code o " + _ " ON (c.office_code = o.code) " + _ " left outer JOIN office_code ao " + _ " ON (z.audit_office_code = ao.code) ".*
AuditOfficeCode Public Property AuditOfficeCode() As String Gets or sets the audit office code.*
AuditOfficeName Public Property AuditOfficeName() As String Gets or sets the audit office name.*
CountyCode Public Property CountyCode() As String Gets or sets the county code.*
CountyName Public Property CountyName() As String Gets or sets the county name.*
IsOregonZipCode Public Property IsOregonZipCode() As Boolean Gets or sets the is oregon zip code.*
OfficeCode Public Property OfficeCode() As String Gets or sets the office code.*
OfficeName Public Property OfficeName() As String Gets or sets the office name.*
PolicyRegionCode Public Property PolicyRegionCode() As String Gets or sets the policy region code.*
StateCode Public Property StateCode() As String Gets or sets the state code.*
ZipCode Public Property ZipCode() As String Gets or sets the zip code.*
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.*
SetAuditOfficeCodeNull Public Sub SetAuditOfficeCodeNull() Sets audit office code null.*
SetCountyCodeNull Public Sub SetCountyCodeNull() Sets county code null.*
SetStateNull Public Sub SetStateNull() Sets state null.*
SetOfficeNameNull Public Sub SetOfficeNameNull() Sets office name null.*
SetAuditOfficeNameNull Public Sub SetAuditOfficeNameNull() Sets audit office name null.*
SetCountyNameNull Public Sub SetCountyNameNull() Sets county name null.*
SetPolicyRegionCodeNull Public Sub SetPolicyRegionCodeNull() Sets policy region code null.*
SetPolicyRegionNameNull Public Sub SetPolicyRegionNameNull() Sets policy region name null.*
IsAuditOfficeCodeNull Public Function IsAuditOfficeCodeNull() As Boolean Returns whether audit office code null.*
IsCountyCodeNull Public Function IsCountyCodeNull() As Boolean Returns whether county code null.*
IsStateNull Public Function IsStateNull() As Boolean Returns whether state null.*
IsOfficeNameNull Public Function IsOfficeNameNull() As Boolean Returns whether office name null.*
IsAuditOfficeNameNull Public Function IsAuditOfficeNameNull() As Boolean Returns whether audit office name null.*
IsCountyNameNull Public Function IsCountyNameNull() As Boolean Returns whether county name null.*
IsPolicyRegionNameNull Public Function IsPolicyRegionNameNull() As Boolean Returns whether policy region name null.*
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 clsZipCode) 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.*
GetZipCode Public Shared Function GetZipCode(ByVal inDataportal As IDataPortalInfo, ByVal inZipCode As String) As clsZipCode Retrieves a single zipcode object for a given zip code.

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

  • Retrieve (SQL-037) is a read-only query with outer joins to COUNTY and OFFICE_CODE.*
  • NVL(z.audit_office_code, c.office_code) falls back to the county office code when no specific audit office is configured for the zip code.*
  • No insert, update, or delete operations are defined on clsZipCode.*

Constraints and usage notes

  • Read-only type; used only for lookup.*

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\clsZipCode.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