clsSearchResults

API reference for clsSearchResults.

Purpose

• Nested result-row type returned by clsProviderSearch.searchForProvider(), representing a single matched provider/location row from the dynamic search join.
• Instances are aggregated into a ReadOnlyCollection(Of clsSearchResults) returned to the caller; the type itself performs no independent data access.

Context

• Namespace: SAIF.Business.View.Provider
• Assembly/package: SAIF.BOF.Business.View.Provider

Public members

Member	Signature	Purpose
ProvLocSeqNum	ReadOnly Property ProvLocSeqNum() As Integer	Returns the matched provider location's surrogate key (PROVIDER_LOCATION_SEQ_NUM).
FullName	ReadOnly Property FullName() As String	Returns the computed display name for the matched row (business name or "Last, First Middle" depending on BusinessFlag).
SortName	ReadOnly Property SortName() As String	Returns the sortable form of the matched name used to order results.
PhysAdddressLine1	ReadOnly Property PhysAdddressLine1() As String	Returns the first line of the matched location's physical address.
PhysCity	ReadOnly Property PhysCity() As String	Returns the matched location's physical address city.
PhysState	ReadOnly Property PhysState() As String	Returns the matched location's physical address state code.
PhysZipCode	ReadOnly Property PhysZipCode() As String	Returns the matched location's physical address ZIP code.
PhoneNumber	ReadOnly Property PhoneNumber() As String	Returns the formatted phone number (area.exchange.line) for the matched location.
PrimaryLocationFlag	ReadOnly Property PrimaryLocationFlag() As String	Returns the raw PRIMARY_LOCATION_FLAG value for the matched location.
BusinessFlag	ReadOnly Property BusinessFlag() As String	Returns the raw BUSINESS_FLAG value, determining whether FullName renders as a business or person name.
TypeDescr	ReadOnly Property TypeDescr() As String	Returns the provider type description (PROVIDER_TYPE_CODE.CODE_DESCR) for the matched location.
New(inDPI)	Sub New(ByVal inDPI As IDataPortalInfo)	Constructs an empty result row, storing the supplied data portal info for internal use.

Behavioral notes

• All public members are populated by directly assigning the corresponding Friend backing fields (e.g. m_ProvLocSeqNum, m_FullName) from within clsProviderSearch.searchForProvider() as it reads each row of the dynamic search query — there is no Load/Fill method on this class itself.
• This type performs no independent data access or retrieval of its own; it is purely a read-only row/DTO populated by its owning clsProviderSearch.

Constraints and usage notes

• Instances are constructed only through the public New(inDPI) constructor, invoked exclusively by clsProviderSearch.searchForProvider(); there is no shared Get... retrieval function.

Inherited members (from clsBusinessBase)

This type inherits the following public surface from clsBusinessBase (Legacy\BusinessObjectFramework\clsBusinessBase.vb), in addition to the members listed above:

Member	Signature	Purpose
MyGuid	ReadOnly Property MyGuid() As String	Returns the internal GUID that uniquely identifies this in-memory object instance.
IsNew	ReadOnly Property IsNew() As Boolean	Indicates whether the object has not yet been persisted.
IsDeleted	ReadOnly Property IsDeleted() As Boolean	Indicates whether the object is marked for deletion.
IsDirty	Overridable ReadOnly Property IsDirty() As Boolean	Indicates whether the object (or a child) has unsaved changes.
IsValid	Overridable ReadOnly Property IsValid() As Boolean	Indicates whether the object currently has no broken validation rules.
ValidateOnDelete	Property ValidateOnDelete As Boolean	Controls whether validation rules run before a delete operation.
Rules	ReadOnly Property Rules() As clsRulesManager	Returns the rules manager that tracks broken rules for this object.
ErrorCount	ReadOnly Property ErrorCount() As Integer	Returns the number of broken error-severity rules.
ErrorMessages	ReadOnly Property ErrorMessages() As String()	Returns the text of all broken error-severity rules.
WarningCount	ReadOnly Property WarningCount() As Integer	Returns the number of broken warning-severity rules.
WarningMessages	ReadOnly Property WarningMessages() As String()	Returns the text of all broken warning-severity rules.
InformationalCount	ReadOnly Property InformationalCount() As Integer	Returns the number of broken informational-severity rules.
InformationalMessages	ReadOnly Property InformationalMessages() As String()	Returns the text of all broken informational-severity rules.
BeginEdit	Sub BeginEdit()	Begins an editable transaction, snapshotting current field values.
CancelEdit	Sub CancelEdit()	Rolls back field values to the last BeginEdit snapshot.
ApplyEdit	Sub ApplyEdit()	Commits the current edit transaction, discarding the rollback snapshot.
Delete	Sub Delete()	Marks the object for deletion on the next save.
Save	Overridable Function Save() As Boolean	Persists the object (insert, update, or delete) through the BOF data portal, if valid.
SaveChild	Overridable Function SaveChild() As Boolean	Persists the object as a child of a parent object/collection.
Clone	Function Clone() As Object	Returns a deep copy of the object.
XMLElementName	Property XMLElementName() As String	Gets or sets the XML element name used when serializing this object.
GetDataset	Sub GetDataset(ByRef inDS As DataSet)	Populates a DataSet with the object's field values.
GetDataset (named table)	Sub GetDataset(ByRef inDS As DataSet, ByVal inTableName As String)	Populates a DataSet table with the given name with the object's field values.
GetReportXML	Function GetReportXML(ByVal inElementName As String) As String	Returns an XML fragment representing the object using the supplied element name.
GetReportXML (default name)	Function GetReportXML() As String	Returns an XML fragment representing the object using the default XML element name.
ToXml	Function ToXml() As String	Serializes the object to XML using the default element name.
ToXml (named tag)	Function ToXml(ByVal inTagName As String) As String	Serializes the object to XML using the supplied tag name.
PreviousLinkItem / NextLinkItem	ReadOnly Property PreviousLinkItem() As ILinkItem / ReadOnly Property NextLinkItem() As ILinkItem	Returns the adjacent linked-list item for collection traversal.
SetValueOnChange	Function SetValueOnChange(Of T)(ByRef inFieldValue As T, ByVal inSetValue As T, Optional ByVal inMarkDirty As Boolean = True) As Boolean	Sets a backing field only when the value changes, optionally marking the object dirty.

Sources

• Business\SAIF.Business.View.Provider\clsProviderSearch.vb