clsManualClassBaseCollection¶
Enumerates published manual class rows for a rate file or selection criteria. Its factory methods load manual classes by period or rate-file criteria, then expose the in-memory filters callers use after load.
Purpose¶
- Enumerates published manual class rows for a rate file or selection criteria.
- Its factory methods load manual classes by period or rate-file criteria, then expose the in-memory filters callers use after load.
Context¶
- Namespace:
SAIF.Business.Policy.Rating - Assembly/package:
SAIF.Business.Policy.Rating
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| RateFileSeqNum | Public ReadOnly Property RateFileSeqNum() As Decimal |
Rate-file sequence number the collection retrieval is scoped to. |
| GetMunicipalClasses | Public ReadOnly Property GetMunicipalClasses() As clsManualClassBaseCollection |
Returns a new collection containing only rows whose IsMunicipalClass flag is True. |
| GetNonMunicipalClasses | Public ReadOnly Property GetNonMunicipalClasses() As clsManualClassBaseCollection |
Returns a new collection containing only rows whose IsMunicipalClass flag is False. |
| GetByClassNumber | Public ReadOnly Property GetByClassNumber(ByVal inPartialManualClassNumber As String) As clsManualClassBaseCollection |
Returns rows whose manual-class-and-usage key starts with the supplied class-number text. |
| GetByClassDescription | Public ReadOnly Property GetByClassDescription(ByVal inPartialDescription As String) As clsManualClassBaseCollection |
Returns rows whose description text contains the supplied search fragment. |
| CurrentItem | Public Shadows ReadOnly Property CurrentItem() As clsManualClassBase |
Returns the collection element at the current BOF traversal position. |
| GetRateFileSeqNum | Public Shared Function GetRateFileSeqNum(ByRef inDataPortalInfo As IDataPortalInfo, ByVal inPeriodRatinginfo As iPeriodRatingInfo) As Decimal |
Calls PK73193_submission.get_rate_file_seq_num to resolve the active rate-file sequence number for the supplied period-rating context. |
| Add | Public Shadows Function Add(ByVal inManualClass As clsManualClassBase) As Integer |
Appends a manual-class row to the collection being assembled or filtered. |
| Contains | Public Overloads Function Contains(ByVal inManualClassBase As clsManualClassBase) As Boolean |
Checks whether an equal manual-class row is already present in the collection. |
| Contains | Public Overloads Function Contains(ByVal inManualClassNumberAndUsageCode As String) As Boolean |
Checks whether the collection already contains the supplied class-number-plus-usage key. |
| GetManualClassBaseCollection | Public Shared Function GetManualClassBaseCollection(ByVal inDataportal As IDataPortalInfo, ByVal inPeriodRatingInfo As iPeriodRatingInfo) As clsManualClassBaseCollection |
Retrieves published manual class rows for a rate file or selection criteria using the key, date, or period criteria supplied by this overload. |
| GetManualClassBaseCollection | Public Shared Function GetManualClassBaseCollection(ByVal inDataportal As IDataPortalInfo, ByVal inRateFileSeqNum As Decimal, ByVal inManualClassNumber As String, Optional ByVal inPeriodRatingInfo As iPeriodRatingInfo = Nothing, Optional ByVal inDefaultClassesOnly As Boolean = False) As clsManualClassBaseCollection |
Retrieves published manual class rows for a rate file or selection criteria using the key, date, or period criteria supplied by this overload. |
| GetManualClassBaseCollection | Public Shared Function GetManualClassBaseCollection(ByVal inDataportal As IDataPortalInfo, ByVal inRateFileSeqNum As Decimal, Optional ByVal inPeriodRatingInfo As iPeriodRatingInfo = Nothing, Optional ByVal inDefaultClassesOnly As Boolean = False, Optional ByVal inAllClasses As Boolean = False) As clsManualClassBaseCollection |
Retrieves published manual class rows for a rate file or selection criteria using the key, date, or period criteria supplied by this overload. |
| GetAssociatedManualClassBaseCollection | Public Shared Function GetAssociatedManualClassBaseCollection(ByVal inDataportal As IDataPortalInfo, ByVal inParentManualClassNumber As String, ByVal inPeriodRatingInfo As iPeriodRatingInfo) As clsManualClassBaseCollection |
Retrieves published manual class rows for a rate file or selection criteria using the key, date, or period criteria supplied by this overload. |
| NewAssociatedManualClassBaseCollection | Public Shared Function NewAssociatedManualClassBaseCollection(ByVal inDataportal As IDataPortalInfo, ByVal inParentManualClassNumber As String, ByVal inPeriodRatingInfo As iPeriodRatingInfo) As clsManualClassBaseCollection |
Creates a new editable collection seeded with parent-class and period-rating context for associated manual classes. |
| DeleteManualClassBasebyRateFileSeqNum | Public Shared Function DeleteManualClassBasebyRateFileSeqNum(ByVal inDataportal As IDataPortalInfo, ByVal inWCISRateFileSeqNum As Decimal) As Boolean |
Deletes all MANUAL_CLASS_BASE rows for the supplied WCIS rate-file sequence number and returns False instead of surfacing an exception on failure. |
| ParentManualClassNumber | Public Property ParentManualClassNumber() As String |
Parent manual class number used to switch retrieval into associated-class mode via MANUAL_CLASS_ASSOCIATION. |
| PeriodRatingInfo | Public Property PeriodRatingInfo() As iPeriodRatingInfo |
Rating-period context copied onto retrieved manual-class rows and used to derive the applicable rate-file sequence number when needed. |
| DefaultClassesOnly | Public Property DefaultClassesOnly() As Boolean |
Controls whether retrieval joins MANUAL_CLASS_DETAIL and restricts results to each class default usage code. |
| GetAllClasses | Public Property GetAllClasses() As Boolean |
Controls whether retrieval returns every matching class row instead of staying constrained to the default-class subset. |
| ManualClassNumber | Public Property ManualClassNumber() As String |
Optional four-digit class-number filter appended to retrieval SQL. |
| ## Inherited public members | ||
| Member | Signature | Purpose |
| --- | --- | --- |
| First | Sub First() |
Moves collection traversal to the first item.† |
| Last | Sub Last() |
Moves collection traversal to the last item.† |
| Next | Sub Next() |
Advances collection traversal to the next item.† |
| Previous | Sub Previous() |
Moves collection traversal to the previous item.† |
| Error | ReadOnly Property Error As String |
Surfaces collection-level broken-rule text through IDataErrorInfo.† |
| ## Behavioral notes | ||
| - After BOF retrieval, the collection can narrow the rows by municipal flag, default-class rules, associated-class context, class prefix, or description text. | ||
| ## Constraints and usage notes | ||
| - Factory methods are the normal entry point; direct construction mainly exists so BOF retrieval can seed criteria objects before loading rows. | ||
> 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\clsManualClassBaseCollection.vb |