clsProviderAddress

Business object for provider location addresses.

Purpose

• Represent persisted provider-domain data within the BOF object model.

Context

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

Public members

Member	Signature	Purpose
ProviderAddressSeqNum	ReadOnly Property ProviderAddressSeqNum As Decimal	Stores the provider address sequence number value.
UpdateUser	ReadOnly Property UpdateUser As String	Returns the update user value recorded on the object.
UpdateNum	ReadOnly Property UpdateNum As Decimal	Returns the update num value recorded on the object.
UpdateDate	ReadOnly Property UpdateDate As Date	Returns the update date value recorded on the object.
ProviderLocationSeqNum	Property ProviderLocationSeqNum As Decimal	Stores the provider location sequence number value.
ProviderAddressCode	Property ProviderAddressCode As String	Stores the provider address code value.
AddressType	ReadOnly Property AddressType As String	Exposes the address type value on this type.
EffDate	Property EffDate As Date	Stores the eff date value.
ExpDate	Property ExpDate As Date	Stores the exp date value.
ForeignAddressFlag	Property ForeignAddressFlag As String	Stores the foreign address flag.
AddressLine1	Property AddressLine1 As String	Exposes the address line 1 value on this type.
AddressLine2	Property AddressLine2 As String	Exposes the address line 2 value on this type.
AddressLine3	Property AddressLine3 As String	Exposes the address line 3 value on this type.
CityName	Property CityName As String	Stores the city name value.
StateCode	Property StateCode As String	Stores the state code value.
ZipCode	Property ZipCode As Nullable(Of Decimal)	Stores the zip code value.
ZipCodeAsString	Property ZipCodeAsString As String	Exposes the zip code as string value on this type.
ZipCodeExt	Property ZipCodeExt As String	Exposes the zip code ext value on this type.
CountryCode	Property CountryCode As String	Stores the country code value.
IsEffective	ReadOnly Property IsEffective As Boolean	Indicates whether effective.
FormattedAddress	ReadOnly Property FormattedAddress As String	Exposes the formatted address value on this type.
FormattedAddressAsHTML	ReadOnly Property FormattedAddressAsHTML As String	Exposes the formatted address as html value on this type.
ProviderLocation	ReadOnly Property ProviderLocation As clsProviderLocation	Exposes the provider location value on this type.
RegisterPropertiesForTracking	Overrides Sub RegisterPropertiesForTracking	Exposes register properties for tracking behavior on this type.
NewProviderAddress	Shared Function NewProviderAddress(ByVal inDataportal As IDataPortalInfo, ByVal inProviderLocationSeqNum As Decimal) As clsProviderAddress	Creates a new provider address instance through the BOF data portal.
GetProviderAddress	Shared Function GetProviderAddress(ByVal inDataportal As IDataPortalInfo, ByVal inProviderAddressSeqNum As Decimal) As clsProviderAddress	Retrieves provider address through the BOF data portal.

Behavioral notes

• This type participates in the provider-domain BOF object model and data-portal lifecycle.

Constraints and usage notes

• Use the BOF factory, retrieval, and save patterns associated with this library when changing persisted state.

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.Provider\clsProviderAddress.vb