Skip to content

clsEmailAddressInfo

clsEmailAddressInfo provides the email-address business object used by the customer-contact library.

Purpose

  • Email-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
EmailAddressID Public ReadOnly Property EmailAddressID() As Decimal Returns or sets the email-address identifier exposed by this type.
EmailCode Public Property EmailCode() As String Returns or sets the email classification code.
EmailTypeDescription Public ReadOnly Property EmailTypeDescription As String Returns the descriptive text for the current email code.
IsValidated Public Property IsValidated As Boolean Returns or sets the boolean state exposed by this type.
UpdateDate Public ReadOnly Property UpdateDate As Date Returns the date value exposed by this type.
UpdateUser Public ReadOnly Property UpdateUser As String Returns the user field exposed by this type.
SetEmailCodeNull Public Sub SetEmailCodeNull() Clears the EmailCode value and marks the object dirty.
SetEmailAddressNull Public Sub SetEmailAddressNull() Clears the EmailAddress value and marks the object dirty.
IsEmailCodeNull Public Function IsEmailCodeNull() As Boolean Returns whether the EmailCode value is empty.
IsEmailAddressNull Public Function IsEmailAddressNull() As Boolean Returns whether the EmailAddress 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 clsEmailAddressInfo) 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.
NewEmailAddress Public Shared Function NewEmailAddress(ByVal inDataportal As IDataPortalInfo) As clsEmailAddressInfo Creates a new business object through the BOF data portal.
GetEmailAddress Public Shared Function GetEmailAddress(ByVal inDataportal As IDataPortalInfo, ByVal inEmailAddressID As Decimal) As clsEmailAddressInfo Retrieves an existing business object through the BOF data portal.
EmailSyntaxValidation Public Property EmailSyntaxValidation As ValidationLevel Returns or sets the validation level used for email syntax validation.
EmailAddressValidation Public Property EmailAddressValidation As ValidationLevel Returns or sets the validation level used for email-address validation.

Behavioral notes

  • Factory methods route creation and retrieval through the BOF data portal.

Constraints and usage notes

  • Set the classification code and email value before saving a usable address record.

Sources

  • Business\SAIF.Business.CustomerContact\clsEmailAddressInfo.vb