clsProviderLocation

Business object for provider locations and related child collections.

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
ProviderLocationSeqNum	ReadOnly Property ProviderLocationSeqNum As Decimal	Stores the provider location sequence number value.
ProviderLocationID	ReadOnly Property ProviderLocationID As Decimal	Returns the provider location sequence number through the legacy compatibility alias.
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.
UpdateUserAndDate	ReadOnly Property UpdateUserAndDate As String	Returns the update user and date value recorded on the object.
ProviderSeqNum	Property ProviderSeqNum As Decimal	Stores the provider sequence number value.
ProviderID	ReadOnly Property ProviderID As Decimal	Returns the provider sequence number through the legacy compatibility alias.
ProviderTypeCode	Property ProviderTypeCode As String	Stores the provider type code value.
ProviderType	ReadOnly Property ProviderType As String	Returns the provider type description resolved from the provider type code.
BusinessFlag	Property BusinessFlag As String	Stores the business flag.
CriticalAccessHospitalFlag	Property CriticalAccessHospitalFlag As String	Stores the critical access hospital flag.
ApprovedFlag	Property ApprovedFlag As String	Stores the approved flag.
PrimaryLocationFlag	Property PrimaryLocationFlag As String	Stores the primary location flag.
IsPrimaryLocation	ReadOnly Property IsPrimaryLocation As Boolean	Indicates whether primary location.
PossibleFraudFlag	Property PossibleFraudFlag As String	Stores the possible fraud flag.
IneligibilityFlag	Property IneligibilityFlag As String	Stores the ineligibility flag.
RecentActivityFlag	Property RecentActivityFlag As String	Stores the recent activity flag.
FormattedName	ReadOnly Property FormattedName As String	Stores the formatted name value.
BusinessName	Property BusinessName As String	Stores the business name value.
BusinessNameUpperCase	Property BusinessNameUpperCase As String	Exposes the business name upper case value on this type.
LastName	Property LastName As String	Stores the last name value.
LastNameUpperCase	Property LastNameUpperCase As String	Exposes the last name upper case value on this type.
FirstName	Property FirstName As String	Stores the first name value.
MiddleName	Property MiddleName As String	Stores the middle name value.
ApprovedUser	Property ApprovedUser As String	Exposes the approved user value on this type.
WebSiteAddress	Property WebSiteAddress As String	Exposes the web site address value on this type.
EmailAddress	Property EmailAddress As String	Exposes the email address value on this type.
PayeeName	Property PayeeName As String	Stores the payee name value.
Provider	ReadOnly Property Provider As clsProvider	Exposes the provider value on this type.
PhoneNumber	ReadOnly Property PhoneNumber As clsPhone	Stores the phone number value.
PhoneAreaCode	Property PhoneAreaCode As String	Stores the phone area code value.
PhoneFormatted	Property PhoneFormatted As String	Exposes the phone formatted value on this type.
PhoneExtensionFormatted	Property PhoneExtensionFormatted As String	Exposes the phone extension formatted value on this type.
PhoneData	ReadOnly Property PhoneData As String	Exposes the phone data value on this type.
FaxNumber	Property FaxNumber As String	Stores the fax number value.
HasFaxNumber	ReadOnly Property HasFaxNumber As Boolean	Indicates whether fax number.
TollFreePhoneNumber	Property TollFreePhoneNumber As String	Stores the toll free phone number value.
HasTollFreePhoneNumber	ReadOnly Property HasTollFreePhoneNumber As Boolean	Indicates whether toll free phone number.
TollFreeFaxNumber	Property TollFreeFaxNumber As String	Stores the toll free fax number value.
HasTollFreeFaxNumber	ReadOnly Property HasTollFreeFaxNumber As Boolean	Indicates whether toll free fax number.
PhoneDataFormat	ReadOnly Property PhoneDataFormat(inPhone As clsPhone) As String	Exposes the phone data format value on this type.
PhoneNumbersAsHTML	ReadOnly Property PhoneNumbersAsHTML As String	Exposes the phone numbers as html value on this type.
FaxNumberAsHTML	ReadOnly Property FaxNumberAsHTML As String	Exposes the fax number as html value on this type.
Addresses	ReadOnly Property Addresses As clsProviderAddressCollection	Returns the related addresses collection.
ProviderEFT	ReadOnly Property ProviderEFT As clsProviderEFT	Exposes the provider EFT value on this type.
UserProviderEFT	ReadOnly Property UserProviderEFT As clsUser	Exposes the user provider EFT value on this type.
ProviderEOB	ReadOnly Property ProviderEOB As clsProviderEOB	Exposes the provider eob value on this type.
UserProviderEOB	ReadOnly Property UserProviderEOB As clsUser	Exposes the user provider eob value on this type.
CurrentOrLastEffectivePhysicalAddress	ReadOnly Property CurrentOrLastEffectivePhysicalAddress As String	Exposes the current or last effective physical address value on this type.
CurrentPhysicalAddress	ReadOnly Property CurrentPhysicalAddress As String	Exposes the current physical address value on this type.
CurrentCorrespondenceAddress	ReadOnly Property CurrentCorrespondenceAddress As String	Exposes the current correspondence address value on this type.
Contacts	ReadOnly Property Contacts As clsProviderContactCollection	Returns the related contacts collection.
Identities	ReadOnly Property Identities As clsProviderIdentityCollection	Returns the related identities collection.
IneligibilityPeriods	ReadOnly Property IneligibilityPeriods As clsProviderIneligibilityPeriodCollection	Returns the related ineligibility periods collection.
MCOMemberships	ReadOnly Property MCOMemberships As clsProviderMCOMembershipCollection	Returns the related mco memberships collection.
Notes	ReadOnly Property Notes As clsNoteCollection	Returns the related notes collection.
Relationships	ReadOnly Property Relationships As clsProviderRelationshipCollection	Returns the related relationships collection.
NotExpiriedRelationships	ReadOnly Property NotExpiriedRelationships As IEnumerable(Of clsProviderRelationship)	Exposes the not expiried relationships value on this type.
Services	ReadOnly Property Services As clsProviderServiceCollection	Returns the related services collection.
PrimaryService	ReadOnly Property PrimaryService As clsProviderService	Exposes the primary service value on this type.
ServiceContracts	ReadOnly Property ServiceContracts As clsProviderServiceContractCollection	Returns the related service contracts collection.
HasPayment	ReadOnly Property HasPayment As Boolean	Indicates whether payment.
HasAudit	ReadOnly Property HasAudit As Boolean	Indicates whether audit.
HasNote	ReadOnly Property HasNote As Boolean	Indicates whether note.
HasTin	ReadOnly Property HasTin As Boolean	Indicates whether tin.
NewProviderLocation	Shared Function NewProviderLocation(inDataportal As IDataPortalInfo) As clsProviderLocation	Creates a new provider location instance through the BOF data portal.
NewProviderLocation	Shared Function NewProviderLocation(inDataportal As IDataPortalInfo, inProviderSeqNum As Decimal) As clsProviderLocation	Creates a new provider location instance through the BOF data portal.
GetProviderLocation	Shared Function GetProviderLocation(inDataportal As IDataPortalInfo, inProviderLocationSeqNum As Decimal) As clsProviderLocation	Retrieves provider location 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\clsProviderLocation.vb