Skip to content

clsTradingAs

clsTradingAs represents one DBA/trading-as row tied to a policy. It retrieves a single TRADING_AS record by TRADING_SEQ_NUM, exposes the identity, effective, registration, tax, and display-classification fields on that row, and lazily resolves the type description from the TRADING_AS_TYPE_CODE code set when callers need a human-readable label.

Purpose

  • Retrieve one TRADING_AS record by TRADING_SEQ_NUM through an inline SELECT.
  • Expose the DBA name, type code, effective/cancel dates, and related identifiers used in policy displays.
  • Resolve the trading-as type description from the code table on demand so callers can show the descriptive label rather than only the raw code.*

Context

  • Namespace: SAIF.Business.View.Policy
  • Assembly/package: SAIF.Business.View.Policy (embedded)

Public members

Member Signature Purpose
TradingSeqNum Public ReadOnly Property TradingSeqNum() As Decimal Returns the primary key used to identify this DBA row.
TradingASNameEffDate Public ReadOnly Property TradingASNameEffDate() As Date Returns the effective date for this DBA name record.
CreateUser Public ReadOnly Property CreateUser() As String Identifies who created the row.
CreateDate Public ReadOnly Property CreateDate() As Date Gives the row's creation timestamp.
BusSeqNum Public ReadOnly Property BusSeqNum() As Decimal Returns the related business sequence number carried on the row.
PolicyNum Public ReadOnly Property PolicyNum() As Decimal Returns the policy number that owns this DBA name.
FeidNum Public ReadOnly Property FeidNum() As String Returns the FEID stored with the DBA record.
TradingASCancelDate Public ReadOnly Property TradingASCancelDate() As Date Gives the cancellation date when this DBA row has been ended.
TradingAsName Public ReadOnly Property TradingAsName() As String Returns the DBA name text shown to users.
UitrNumber Public ReadOnly Property UitrNumber() As Decimal Returns the UITR number stored with the DBA record.
AffiliateSsn Public ReadOnly Property AffiliateSsn() As String Returns the affiliate SSN stored with the DBA record.
UpdateUser Public ReadOnly Property UpdateUser() As String Identifies who last updated the row.
UpdateDate Public ReadOnly Property UpdateDate() As Date Gives the last-update timestamp recorded on the row.
RegistrationDate Public ReadOnly Property RegistrationDate() As Date Gives the registration date stored for the DBA record.
TradingASTypeCode Public ReadOnly Property TradingASTypeCode() As String Returns the coded DBA type used to classify this name.
TradingAsDescription Public ReadOnly Property TradingAsDescription As String Resolves the current type code to its description through the loaded code collection.
TradingAsDesriptions Public ReadOnly Property TradingAsDesriptions As clsCodeCollection Lazily loads the TRADING_AS_TYPE_CODE code set used to describe DBA type codes.
IsPriorLegal Public ReadOnly Property IsPriorLegal As Boolean Flags rows whose trading-as type code is PL, identifying prior-legal entries.
MyCriteria Friend ReadOnly Property MyCriteria() As Criteria Exposes the criteria object that supplies data-portal context and the key for retrieval.
Equals Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean Compares two boxed DBA objects by trading-sequence identity.
Equals Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean Applies the trading-sequence equality rule to an arbitrary object.
Equals Public Overloads Function Equals(ByVal inObject As clsTradingAs) As Boolean Treats two DBA objects as equal when they carry the same trading sequence number.
GetHashCode Public Overrides Function GetHashCode() As Integer Produces a hash based on the trading sequence key.
ToString Public Overrides Function ToString() As String Returns the trading sequence number as the object's compact string form.
GetTradingAs Public Shared Function GetTradingAs(ByVal inDataportal As iDataPortalInfo, inTradingSeqNum as DECIMAL) As clsTradingAs Retrieves one DBA record through the data portal.
DataPortalInfo Friend Property DataPortalInfo() As iDataPortalInfo Carries data-portal context inside the nested criteria object.
TradingSeqNum Public Property TradingSeqNum as DECIMAL Stores the key passed to the inline TRADING_AS query.
RetrieveSQL Friend ReadOnly Property RetrieveSQL() as String Supplies the inline SELECT over TRADING_AS filtered by TRADING_SEQ_NUM.

Behavioral notes

  • BeforeRetrieve sends :TradingSeqNum to the inline SELECT against TRADING_AS, and AfterRetrieve fills the object from the first result row.
  • TradingAsDesriptions loads a clsCodeCollection only on first use, so callers that only need raw type codes avoid the extra code-table lookup.*
  • The type has no custom business rules; the object functions as a read-only projection of the database row.

Constraints and usage notes

  • The code deliberately documents the public member name TradingAsDesriptions with its source spelling, even though the identifier is misspelled in VB.
  • Persistence operations throw InvalidSQLProperty, so this page reflects the library's read-only contract under BR-VP-027.
  • Inherited members are omitted because clsBusinessBase is external.

Note: Statements marked with * were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with ** could not be confirmed; treat as unknown until verified.

Sources

  • SAIF.Business.View.Policy/clsTradingAs.vb