--- title: clsAuditCollection summary: API reference for clsAuditCollection. status: draft owner: Technical Writer last_reviewed: 2026-07-31 library: SAIF.Business.Policy.Audit.Premium reference_type: package --- # clsAuditCollection Typed BOF collection of premium audits used to load, filter, sort, and batch-save audits for selection, assignment, synchronization, and reporting workflows. ## Purpose - Typed BOF collection of premium audits used to load, filter, sort, and batch-save audits for selection, assignment, synchronization, and reporting workflows. ## Context - Namespace: `SAIF.Business.Policy.Audit.Premium` - Assembly/package: `SAIF.BOF.Business.Policy.Audit.Premium` ## Public members | Member | Signature | Purpose | | --- | --- | --- | | MarketType | `Public ReadOnly Property MarketType(ByVal inMarketType As Enums.MarketTypes) As clsAuditCollection` | Returns only the audits whose derived market type matches the requested value. | | DeselectedAudits | `Public ReadOnly Property DeselectedAudits() As clsAuditCollection` | Returns the audits already marked as deselected by selection testing. | | SelectedAudits | `Public ReadOnly Property SelectedAudits() As clsAuditCollection` | Returns the audits already selected for premium-audit processing. | | AuditsSortedBySeq | `Public ReadOnly Property AuditsSortedBySeq() As clsAuditCollection` | Returns the same collection sorted descending by audit sequence number. | | NewAuditsNotSelected | `Public ReadOnly Property NewAuditsNotSelected() As clsAuditCollection` | Returns newly created candidate audits that were not selected and can be discarded after testing. | | SelectableAudits | `Public ReadOnly Property SelectableAudits() As clsAuditCollection` | Returns audits that remain neither selected nor deselected and still satisfy automated-selection eligibility checks. | | LateAudits | `Public ReadOnly Property LateAudits() As clsAuditCollection` | Returns audits whose submitted date falls after the due date. | | CurrentItem | `Public Shadows ReadOnly Property CurrentItem() As clsAudit` | Returns the collection's current item strongly typed as `Audit`. | | SelectionCategories | `Public ReadOnly Property SelectionCategories() As clsAuditSelectionCategoryCodeCollection` | Lazily loads selection-category codes used to label audits in the collection. | | Statuses | `Public ReadOnly Property Statuses() As clsStatusCollection` | Lazily loads audit status codes used to interpret collection items. | | PremiumAuditTypes | `Public ReadOnly Property PremiumAuditTypes() As clsPremiumAuditTypeCodeCollection` | Lazily loads premium-audit type codes used to interpret collection items. | | MyCriteria | `Public ReadOnly Property MyCriteria() As Criteria` | Exposes the criteria object currently driving data-portal retrieval for this type. | | Save | `Public Overrides Function Save() As Boolean` | Persists pending changes in the collection and its tracked child objects through the BOF data portal. | | Add | `Public Shadows Function Add(ByVal inclsAudit As clsAudit) As Integer` | Adds the supplied business object to the collection and returns its index. | | Contains | `Public Overloads Function Contains(ByVal inclsAudit As clsAudit) As Boolean` | Returns `True` when the collection already contains the supplied business object. | | Contains | `Public Overloads Function Contains(ByVal inAuditSeqNum As Decimal) As Boolean` | Returns `True` when the collection already contains an item with the supplied sequence/key value. | | ContainsDeleted | `Public Overloads Function ContainsDeleted(ByVal inclsAudit As clsAudit) As Boolean` | Returns `True` when the deleted-items list already contains the supplied business object. | | ContainsDeleted | `Public Overloads Function ContainsDeleted(ByVal inAuditSeqNum As Decimal) As Boolean` | Returns `True` when the deleted-items list already contains an item with the supplied sequence/key value. | | SetCurrent | `Public Overloads Sub SetCurrent(ByVal inAuditSeqNum As Decimal)` | Selects the item identified by the supplied sequence/key value as the collection's current item. | | SetCurrent | `Public Overloads Sub SetCurrent(ByVal inAudit As clsAudit)` | Selects the supplied business object as the collection's current item. | | NewAuditCollection | `Public Shared Function NewAuditCollection(ByVal inDataportal As IDataPortalInfo) As clsAuditCollection` | Creates a new unsaved audit collection initialized with the data-portal context needed for validation and save operations. | | NewAuditsForSelection | `Public Shared Function NewAuditsForSelection(ByVal inDataportal As IDataPortalInfo,` | Builds unsaved candidate audits for the supplied policy period so selection rules can run against them.* | | GetAllAudits | `Public Shared Function GetAllAudits(ByVal inDataportal As IDataPortalInfo) As clsAuditCollection` | Loads the full set of audits available to this query.* | | GetAuditsByCriteria | `Public Shared Function GetAuditsByCriteria(ByVal inDataportal As IDataPortalInfo, ByVal inCriteria As Criteria) As clsAuditCollection` | Loads audits by criteria through the BOF data portal using the supplied keys and criteria. | | GetAuditsForFEIN | `Public Shared Function GetAuditsForFEIN(ByVal inDataportal As IDataPortalInfo, ByVal inFEIN As String) As clsAuditCollection` | Loads audits for fein through the BOF data portal using the supplied keys and criteria. | | GetAuditsForAuditablePeriod | `Public Shared Function GetAuditsForAuditablePeriod(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNumberList As List(Of Decimal), ByVal inAuditStartDate As Date, ByVal inAuditEndDate As Date, ByVal inAuditTypeCode As String, ByVal inHasSAIFPolicyAccess As Boolean) As clsAuditCollection` | Loads audits for auditable period through the BOF data portal using the supplied keys and criteria. | | GetAuditsForAuditablePeriod | `Public Shared Function GetAuditsForAuditablePeriod(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNum As Decimal, ByVal inAuditStartDate As Date, ByVal inAuditEndDate As Date, ByVal inAuditTypeCode As String, ByVal inHasSAIFPolicyAccess As Boolean) As clsAuditCollection` | Loads audits for auditable period through the BOF data portal using the supplied keys and criteria. | | GetAuditsForPolicy | `Public Shared Function GetAuditsForPolicy(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNum As Decimal, ByVal inHasSAIFPolicyAccess As Boolean) As clsAuditCollection` | Loads audits for policy through the BOF data portal using the supplied keys and criteria. | | GetAuditsForSynchronization | `Public Shared Function GetAuditsForSynchronization(ByVal inDataportal As IDataPortalInfo) As clsAuditCollection` | Loads audits for synchronization through the BOF data portal using the supplied keys and criteria. | | GetCyclicalAudits | `Public Shared Function GetCyclicalAudits(ByVal inDataportal As IDataPortalInfo, ByVal inEndDate As Date) As clsAuditCollection` | Loads cyclical audits through the BOF data portal using the supplied keys and criteria. | | GetUnassignedOffCycleAudits | `Public Shared Function GetUnassignedOffCycleAudits(ByVal inDataportal As IDataPortalInfo) As clsAuditCollection` | Loads unassigned off cycle audits through the BOF data portal using the supplied keys and criteria. | | GetUnassignedRenewalAudits | `Public Shared Function GetUnassignedRenewalAudits(ByVal inDataportal As IDataPortalInfo) As clsAuditCollection` | Loads unassigned renewal audits through the BOF data portal using the supplied keys and criteria. | | GetUnCompletedAudits | `Public Shared Function GetUnCompletedAudits(ByVal inDataportal As IDataPortalInfo) As clsAuditCollection` | Loads un completed audits through the BOF data portal using the supplied keys and criteria. | | CanAuditorAccessPolicy | `Public Shared Function CanAuditorAccessPolicy(ByVal inDataportal As IDataPortalInfo,` | Checks whether the supplied auditor has permission to access the requested policy. | | LateReport | `Public ReadOnly Property LateReport() As clsReportSpecification` | Returns the report specification used to render the late report output.* | | SubmittedReport | `Public ReadOnly Property SubmittedReport() As clsReportSpecification` | Returns the report specification used to render the submitted report output.* | ## Behavioral notes - This type is part of the premium-audit library's public surface. ## Constraints and usage notes > **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 - `Business\SAIF.Business.Policy.Audit.Premium\clsAuditCollection.vb`