Skip to content

clsRatingPlanCode

Represents a rating-plan code row. The class supports callers by turning stored codes into the enum, description, or related lookup values used in business logic.

Purpose

  • Represents a rating-plan code row.
  • The class supports callers by turning stored codes into the enum, description, or related lookup values used in business logic.

Context

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

Public members

Member Signature Purpose
Code Public Property Code() As String Rating plan code loaded from RATING_PLAN_CODE.CODE.
Description Public Property Description() As String Description text for the rating plan code row.
Equals Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean Returns True only when both objects are rating plan code rows with the same Code.
Equals Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean Returns True only when the supplied object is a rating plan code row with the same Code.
Equals Public Overloads Function Equals(ByVal inObject As clsRatingPlanCode) As Boolean Compares rating plan code rows by Code.
GetHashCode Public Overrides Function GetHashCode() As Integer Hashes Code, the value this type uses as its identity key in keyed collections.
GetRatingPlanCode Public Shared Function GetRatingPlanCode(ByVal inDataportal As IDataPortalInfo, ByVal inCode As String) As clsRatingPlanCode Retrieves the a rating-plan code row identified by the key values or effective-date criteria supplied by the caller.
Code Public Property Code() As String Criteria value used to retrieve a specific rating plan code row.
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 inCode As String) Creates a criteria-backed instance seeded with inCode 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
- Most callers retrieve the row through a shared factory and then use its derived enum or related-lookup helpers rather than working directly with raw codes.
## Constraints and usage notes
- Use the shared factory instead of constructing the type directly so the criteria object and BOF validation rules are populated consistently.
> 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\clsRatingPlanCode.vb