clsProviderTaxID

Business object for provider tax IDs and mailing-address data.

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
TaxID	ReadOnly Property TaxID As String	Stores the tax ID value.
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.
UpdateNum	ReadOnly Property UpdateNum As Decimal	Returns the update num value recorded on the object.
UpdateUser	ReadOnly Property UpdateUser As String	Returns the update user value recorded on the object.
TaxIDDisplayDescr	Property TaxIDDisplayDescr As String	Stores the tax ID display descr value.
ProviderSeqNum	Property ProviderSeqNum As Decimal	Stores the provider sequence number value.
RegisteredName	Property RegisteredName As String	Stores the registered name value.
RegisteredNameUpperCase	ReadOnly Property RegisteredNameUpperCase As String	Exposes the registered name upper case value on this type.
EffDate	Property EffDate As Date	Stores the eff date value.
Report1099Flag	Property Report1099Flag As String	Stores the report 1099 flag.
PrimaryTaxIDFlag	Property PrimaryTaxIDFlag As String	Stores the primary tax id flag.
ForeignAddressFlag	Property ForeignAddressFlag As String	Stores the foreign address flag.
ExpDate	Property ExpDate As Date	Stores the exp date value.
W9SentDate	Property W9SentDate As Date	Stores the 9 sent date value.
W9ReceivedDate	Property W9ReceivedDate As Date	Stores the 9 received date value.
CityName	Property CityName As String	Stores the city name value.
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.
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.
AddressLine3	Property AddressLine3 As String	Exposes the address line 3 value on this type.
AddressLine4	Property AddressLine4 As String	Exposes the address line 4 value on this type.
CountryCode	Property CountryCode As String	Stores the country code value.
HasPayment	ReadOnly Property HasPayment As Boolean	Indicates whether payment.
DuplicateTIN	ReadOnly Property DuplicateTIN As Boolean	Exposes the duplicate TIN value on this type.
IsValidStateCode	ReadOnly Property IsValidStateCode As Boolean	Indicates whether valid state code.
NewProviderTaxID	Shared Function NewProviderTaxID(ByVal inDataportal As IDataPortalInfo, ByVal inProviderSeqNum As Decimal) As clsProviderTaxID	Creates a new provider tax id instance through the BOF data portal.
GetProviderTaxID	Shared Function GetProviderTaxID(ByVal inDataportal As IDataPortalInfo, ByVal inTaxID As String) As clsProviderTaxID	Retrieves provider tax id 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\clsProviderTaxID.vb