clsTerrorismRate

Retrieves the effective terrorism rate for a market type and date. The class is retrieved through BOF criteria objects and exposes the loaded row to rating callers.

Purpose

• Retrieves the effective terrorism rate for a market type and date.
• The class is retrieved through BOF criteria objects and exposes the loaded row to rating callers.

Context

• Namespace: SAIF.Business.Policy.Rating
• Assembly/package: SAIF.Business.Policy.Rating

Public members

Member	Signature	Purpose
MarketTypeCode	Public ReadOnly Property MarketTypeCode() As String	Stored market type code used as part of the terrorism-rate lookup key.
MarketType	Public ReadOnly Property MarketType() As Enums.MarketTypes	Market type enum derived from MarketTypeCode for caller use.
EffectiveDate	Public ReadOnly Property EffectiveDate() As Date	Start date on which this terrorism rate becomes effective.
CreateUser	Public ReadOnly Property CreateUser() As String	User ID that inserted the terrorism rate row.
CreateDate	Public ReadOnly Property CreateDate() As Date	Data-source timestamp when the terrorism rate row was inserted.
UpdateUser	Public ReadOnly Property UpdateUser() As String	User ID recorded on the row's last update.
UpdateDate	Public ReadOnly Property UpdateDate() As Date	Timestamp recorded on the row's last update.
Rate	Public ReadOnly Property Rate() As Decimal	Terrorism rate factor returned for the requested market type and effective date.
ExpirationDate	Public ReadOnly Property ExpirationDate() As Date	End date after which this terrorism rate no longer applies; may be empty.
IsExpirationDateNull	Public Function IsExpirationDateNull() As Boolean	Indicates whether the terrorism rate is open-ended with no expiration date.
Equals	Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean	Returns true only when both arguments have the same market type code and effective date.
Equals	Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean	Returns true only when the supplied object has the same market type code and effective date.
Equals	Public Overloads Function Equals(ByVal inObject As clsTerrorismRate) As Boolean	Compares terrorism-rate rows by MarketTypeCode and EffectiveDate.
GetHashCode	Public Overrides Function GetHashCode() As Integer	Hashes Rate, the value this type uses as its identity key in keyed collections.
ToString	Public Overrides Function ToString() As String	Returns the rate value as text.
GetTerrorismRate	Public Shared Function GetTerrorismRate(ByVal inDataportal As IDataPortalInfo, ByVal inMarketType As Enums.MarketTypes, ByVal inEffectiveDate As Date) As clsTerrorismRate	Retrieves the effective terrorism rate for a market type and date identified by the key values or effective-date criteria supplied by the caller.
MarketType	Public Property MarketType() As Enums.MarketTypes	Requested market type criteria later converted to the database code parameter.
EffectiveDate	Public Property EffectiveDate() As Date	Requested effective date criteria passed into RetrieveSQL.
New	Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo)	Creates an empty BOF object shell that shared factory methods or retrieval logic can populate with a loaded row.
New	Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inMarketType As Enums.MarketTypes, ByVal inEffectiveDate As Date)	Creates a criteria-backed instance seeded with inMarketType, inEffectiveDate so the next retrieval runs in the caller's requested context.
## Inherited public members
Member	Signature	Purpose
---	---	---
Rules	Property Rules As clsRulesManager	Owns the BOF rules manager used to evaluate registered validation logic.†
BeginEdit	Sub BeginEdit()	Opens an n-level edit session for the business object.†
CancelEdit	Sub CancelEdit()	Rolls back the active edit scope.†
ApplyEdit	Sub ApplyEdit()	Commits the active edit scope.†
Error	ReadOnly Property Error As String	Surfaces aggregate broken-rule text through IDataErrorInfo.†
## Behavioral notes
- The object layers convenience logic over the loaded row, such as equality keys, related-row resolution, or validation helpers.
## Constraints and usage notes
- Retrieve the row with the same keys and effective context that the caller will use later, because helper members derive additional data from that loaded state.
> Note: Statements marked with † are derived from dependency library
> documentation via the Legends CLI. They describe inherited behavior from the
> indicated origin library and should be verified if the dependency version changes.
## Sources
- Business\SAIF.Business.Policy.Rating\clsTerrorismRate.vb