clsManualClassParagraphUsage¶
Represents an effective-dated paragraph assignment for a manual class. The class is retrieved through BOF criteria objects and exposes the loaded row to rating callers.
Purpose¶
- Represents an effective-dated paragraph assignment for a manual class.
- 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 |
|---|---|---|
| Member | Public Const RETRIEVE_SQL As String = "Select " & "MANUAL_CLASS_PARAGRAPH_USAGE.MANUAL_CLASS_NUM as ManualClassNum, " & "MANUAL_CLASS_PARAGRAPH_USAGE.MARKET_TYPE_CODE as MarketTypeCode, " & "MANUAL_CLASS_PARAGRAPH_USAGE.PARAGRAPH_EFF_DATE as ParagraphEffDate, " & "MANUAL_CLASS_PARAGRAPH_USAGE.PARAGRAPH_NUM as ParagraphNum, " & "MANUAL_CLASS_PARAGRAPH_USAGE.PARAGRAPH_EXP_DATE as ParagraphExpDate, " & "MANUAL_CLASS_PARAGRAPH_USAGE.NEW_OUTSTANDING_CODE as NewOutstandingCode, " & "MANUAL_CLASS_PARAGRAPH_USAGE.CREATE_DATE as CreateDate, " & "MANUAL_CLASS_PARAGRAPH_USAGE.CREATE_USER as CreateUser, " & "MANUAL_CLASS_PARAGRAPH_USAGE.UPDATE_DATE as UpdateDate, " & "MANUAL_CLASS_PARAGRAPH_USAGE.UPDATE_USER as UpdateUser" & " From " & "MANUAL_CLASS_PARAGRAPH_USAGE" |
Base SELECT statement that loads paragraph-usage rows from MANUAL_CLASS_PARAGRAPH_USAGE. |
| ManualClassNum | Public ReadOnly Property ManualClassNum() As String |
Manual class number and usage code to which this paragraph assignment applies. |
| ParagraphEffDate | Public ReadOnly Property ParagraphEffDate() As Date |
Effective date on which this paragraph assignment begins. |
| MarketTypeCode | Public ReadOnly Property MarketTypeCode() As String |
Stored market-type code used to select the correct paragraph assignment. |
| ManualClassParagraph | Public ReadOnly Property ManualClassParagraph() As clsManualClassParagraph |
Lazily loads the referenced clsManualClassParagraph row identified by ParagraphNum. |
| NewOutstandingCode | Public ReadOnly Property NewOutstandingCode() As String |
New or outstanding discriminator carried on the paragraph-assignment row. |
| ParagraphNum | Public Property ParagraphNum() As String |
Paragraph identifier that links this usage row to the text stored in MANUAL_CLASS_PARAGRAPH. |
| ParagraphExpDate | Public Property ParagraphExpDate() As Date |
Optional end date after which this paragraph assignment no longer applies. |
| CreateDate | Public ReadOnly Property CreateDate() As Date |
Audit timestamp when the paragraph-usage row was created. |
| CreateUser | Public ReadOnly Property CreateUser() As String |
Audit user who created the paragraph-usage row. |
| UpdateDate | Public ReadOnly Property UpdateDate() As Date |
Audit timestamp from the most recent update to the paragraph-usage row. |
| UpdateUser | Public ReadOnly Property UpdateUser() As String |
Audit user from the most recent update to the paragraph-usage row. |
| SetParagraphExpDateNull | Public Sub SetParagraphExpDateNull() |
Clears the stored paragraph-expiration date, leaving the usage row open-ended. |
| IsParagraphExpDateNull | Public Function IsParagraphExpDateNull() As Boolean |
Reports whether the paragraph-assignment row has 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 are paragraph-usage rows with the same manual class, effective date, market type, and new/outstanding code. |
| Equals | Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean |
Returns True when the supplied object is a paragraph-usage row with the same manual class, effective date, market type, and new/outstanding code. |
| Equals | Public Overloads Function Equals(ByVal inObject As clsManualClassParagraphUsage) As Boolean |
Treats two paragraph-usage rows as equal when manual class, effective date, market type, and new/outstanding code all match. |
| GetHashCode | Public Overrides Function GetHashCode() As Integer |
Hashes ManualClassNum, the value this type uses as its identity key in keyed collections. |
| NewManualClassParagraphUsage | Public Shared Function NewManualClassParagraphUsage(ByVal inDataportal As IDataPortalInfo, ByVal inManualClassNum As String, ByVal inParagraphEffDate As Date, ByVal inMarketTypeCode As String, ByVal inNewOutstandingCode As String) As clsManualClassParagraphUsage |
Creates a new editable paragraph-usage row keyed by manual class, paragraph effective date, market type, and new/outstanding code. |
| GetManualClassParagraphUsage | Public Shared Function GetManualClassParagraphUsage(ByVal inDataportal As IDataPortalInfo, ByVal inManualClassNum As String, ByVal inParagraphEffDate As Date, ByVal inMarketTypeCode As String, ByVal inMarketTypeCode2 As String, ByVal inNewOutstandingCode As String) As clsManualClassParagraphUsage |
Retrieves the an effective-dated paragraph assignment for a manual class identified by the key values or effective-date criteria supplied by the caller. |
| MarketTypeCode | Public Property MarketTypeCode() As String |
Market-type retrieval key for selecting a paragraph-usage row. |
| NewOutstandingCode | Public Property NewOutstandingCode() As String |
New or outstanding retrieval key for selecting a paragraph-usage row. |
| ParagraphEffDate | Public Property ParagraphEffDate() As Date |
Effective-date retrieval key for selecting a paragraph-usage row. |
| ManualClassNum | Public Property ManualClassNum() As String |
Manual-class retrieval key for selecting a paragraph-usage 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 inManualClassNum As String, ByVal inParagraphEffDate As Date, ByVal inMarketTypeCode As String, ByVal inNewOutstandingCode As String) |
Creates an empty BOF object shell that shared factory methods or retrieval logic can populate with a loaded row. |
| ## 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\clsManualClassParagraphUsage.vb |