Skip to content

clsAudit

clsAudit centralizes audit type constants, nested audit-classification enums, and conversion helpers used by the external-users library when it interprets stored audit codes.

Purpose

  • Expose canonical audit-type code constants used by external-user audit workflows.
  • Convert between persisted audit-type strings and the library's AuditTypes enum.

Context

  • Namespace: SAIF.Business.External.Users*
  • Assembly/package: SAIF.BOF.Business.External.Users

Public members

Member Signature Purpose
AUDIT_TYPE_FINAL Public Const AUDIT_TYPE_FINAL As String = "FINL" Represents the audit type final constant with value "FINL".*
AUDIT_TYPE_PROSPECTIVE Public Const AUDIT_TYPE_PROSPECTIVE As String = "PROS" Represents the audit type prospective constant with value "PROS".*
AUDIT_TYPE_PRELIMINARY Public Const AUDIT_TYPE_PRELIMINARY As String = "PRLM" Represents the audit type preliminary constant with value "PRLM".*
AUDIT_TYPE_NEW Public Const AUDIT_TYPE_NEW As String = "NEW" Represents the audit type new constant with value "NEW".*
AUDIT_TYPE_NCCITEST Public Const AUDIT_TYPE_NCCITEST As String = "TEST" Represents the audit type nccitest constant with value "TEST".*
AUDIT_TYPE_INTERIM Public Const AUDIT_TYPE_INTERIM As String = "INT" Represents the audit type interim constant with value "INT".*
AUDIT_TYPE_UNSPECIFIED Public Const AUDIT_TYPE_UNSPECIFIED As String = "" Represents the audit type unspecified constant with value "".*
AuditRetrievalTypes Public Enum AuditRetrievalTypes Exposes the nested AuditRetrievalTypes type used by clsAudit.*
AuditTypes Public Enum AuditTypes Exposes the nested AuditTypes type used by clsAudit.*
ConvertAuditType Public Shared Function ConvertAuditType(ByVal inAuditType As String) As AuditTypes Converts audit type.*
ConvertAuditType Public Shared Function ConvertAuditType(ByVal inAuditType As AuditTypes) As String Converts audit type.*

Behavioral notes

  • ConvertAuditType(String) normalizes the inbound code with ToUpper before mapping it to AuditTypes.
  • ConvertAuditType(AuditTypes) returns AUDIT_TYPE_UNSPECIFIED when the supplied enum value does not map to a defined outbound code.

Constraints and usage notes

  • The type is a helper class only; it does not participate in BOF persistence or inherit framework lifecycle members.
  • AUDIT_TYPE_UNSPECIFIED is the fallback for unsupported or blank audit types.

Note: Statements marked with * were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts.

Sources

  • Business\SAIF.Business.External.Users\clsAudit.vb