clsAddressInfo¶
clsAddressInfo provides the address business object used by the customer-contact library.
Purpose¶
- Address business object used by the customer-contact library.
Context¶
- Namespace:
SAIF.Business.CustomerContact - Assembly/package:
SAIF.BOF.Business.CustomerContact
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| AddressID | Public ReadOnly Property AddressID() As Decimal |
Returns or sets the address identifier exposed by this type. |
| AddressCode | Public Property AddressCode() As String |
Returns or sets the address classification code. |
| AddressType | Public ReadOnly Property AddressType As String |
Returns the descriptive text for the current address code. |
| ForeignPostalCode | Public Property ForeignPostalCode() As String |
Returns or sets the classification code exposed by this type. |
| CreateDate | Public ReadOnly Property CreateDate() As Date |
Returns the date value exposed by this type. |
| CreateUser | Public ReadOnly Property CreateUser() As String |
Returns the user field exposed by this type. |
| UpdateUser | Public ReadOnly Property UpdateUser() As String |
Returns the user field exposed by this type. |
| UpdateDate | Public ReadOnly Property UpdateDate() As Date |
Returns the date value exposed by this type. |
| GetID | Public Overrides Function GetID() As Decimal |
Exposes behavior declared directly on this type. |
| SetAddressLine1Null | Public Sub SetAddressLine1Null() |
Clears the AddressLine1 value and marks the object dirty. |
| SetAddressLine2Null | Public Sub SetAddressLine2Null() |
Clears the AddressLine2 value and marks the object dirty. |
| SetAddressLine3Null | Public Sub SetAddressLine3Null() |
Clears the AddressLine3 value and marks the object dirty. |
| SetAddressLine4Null | Public Sub SetAddressLine4Null() |
Clears the AddressLine4 value and marks the object dirty. |
| SetCityNull | Public Sub SetCityNull() |
Clears the City value and marks the object dirty. |
| SetStatecodeNull | Public Sub SetStatecodeNull() |
Clears the Statecode value and marks the object dirty. |
| SetZipCodeNull | Public Sub SetZipCodeNull() |
Clears the ZipCode value and marks the object dirty. |
| SetZipCodeExtensionNull | Public Sub SetZipCodeExtensionNull() |
Clears the ZipCodeExtension value and marks the object dirty. |
| SetCountryCodeNull | Public Sub SetCountryCodeNull() |
Clears the CountryCode value and marks the object dirty. |
| SetForeignPostalCodeNull | Public Sub SetForeignPostalCodeNull() |
Clears the ForeignPostalCode value and marks the object dirty. |
| SetCountyCodeNull | Public Sub SetCountyCodeNull() |
Clears the CountyCode value and marks the object dirty. |
| SetLocationNameNull | Public Sub SetLocationNameNull() |
Clears the LocationName value and marks the object dirty. |
| IsAddressLine1Null | Public Function IsAddressLine1Null() As Boolean |
Returns whether the AddressLine1 value is empty. |
| IsAddressLine2Null | Public Function IsAddressLine2Null() As Boolean |
Returns whether the AddressLine2 value is empty. |
| IsAddressLine3Null | Public Function IsAddressLine3Null() As Boolean |
Returns whether the AddressLine3 value is empty. |
| IsAddressLine4Null | Public Function IsAddressLine4Null() As Boolean |
Returns whether the AddressLine4 value is empty. |
| IsCityNull | Public Function IsCityNull() As Boolean |
Returns whether the City value is empty. |
| IsStateCodeNull | Public Function IsStateCodeNull() As Boolean |
Returns whether the StateCode value is empty. |
| IsZipCodeNull | Public Function IsZipCodeNull() As Boolean |
Returns whether the ZipCode value is empty. |
| IsZipCodeExtensionNull | Public Function IsZipCodeExtensionNull() As Boolean |
Returns whether the ZipCodeExtension value is empty. |
| IsCountryCodeNull | Public Function IsCountryCodeNull() As Boolean |
Returns whether the CountryCode value is empty. |
| IsForeignPostalCodeNull | Public Function IsForeignPostalCodeNull() As Boolean |
Returns whether the ForeignPostalCode value is empty. |
| IsCountyCodeNull | Public Function IsCountyCodeNull() As Boolean |
Returns whether the CountyCode value is empty. |
| IsLocationNameNull | Public Function IsLocationNameNull() As Boolean |
Returns whether the LocationName value is empty. |
| Equals | Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean |
Compares objects using this type's identity field(s). |
| Equals | Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean |
Compares objects using this type's identity field(s). |
| Equals | Public Overloads Function Equals(ByVal inObject As clsAddressInfo) As Boolean |
Compares objects using this type's identity field(s). |
| GetHashCode | Public Overrides Function GetHashCode() As Integer |
Returns a hash code derived from the type's identifier. |
| ToString | Public Overrides Function ToString() As String |
Returns a compact string representation for this type. |
| GetAddress | Public Shared Function GetAddress(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inAddressID As Decimal) As clsAddressInfo |
Retrieves an existing business object through the BOF data portal. |
| NewAddress | Public Shared Function NewAddress(ByVal inDataPortalInfo As IDataPortalInfo) As clsAddressInfo |
Creates a new business object through the BOF data portal. |
Behavioral notes¶
- Factory methods route creation and retrieval through the BOF data portal.
- The null helper methods clear individual fields and mark the object dirty.
Constraints and usage notes¶
- Use the BOF factory methods with IDataPortalInfo instead of depending on direct construction.
Sources¶
Business\SAIF.Business.CustomerContact\clsAddressInfo.vb