Skip to content

IPolicyHeaderSettings

IPolicyHeaderSettings defines the settings object consumed by the policy-header flow. It carries the selected association type, the association types the caller may see, environment-sensitive visibility flags, and test-information services used by the standard header implementation.

Purpose

  • Describe the security-filtered, environment-aware state required to render the policy header.
  • Give consuming applications a contract they can replace or extend without rewriting the rest of the header pipeline.

Context

  • Namespace: SAIF.Application.Policy.PolicyHeader
  • Assembly/package: SAIF.Application.Policy

Public members

Member Signature Purpose
AssociationTypeTargets ReadOnly Property AssociationTypeTargets As IEnumerable(Of IPolicyAssociationType) Limits which association types the header is allowed to present.
ValidatedAssociationTypes ReadOnly Property ValidatedAssociationTypes As IEnumerable(Of IPolicyAssociationType) Exposes the association types the current principal may see.
SecurityPrincipal ReadOnly Property SecurityPrincipal As clsSecurityPrincipal Exposes the principal whose identity and permissions drive header behavior.
DisplayPolicySelector ReadOnly Property DisplayPolicySelector As Boolean Indicates whether the header should show the policy selector.
DisplayTotalsItem ReadOnly Property DisplayTotalsItem As Boolean Indicates whether totals-specific header UI should be shown.
DemoMode ReadOnly Property DemoMode As Boolean Indicates whether policyholder-identifying values should be masked.
BackgroundCSSName ReadOnly Property BackgroundCSSName As String Supplies the CSS background name used by the standard header.
SelectedAssociationType Property SelectedAssociationType As IPolicyAssociationType Carries the association type currently selected by the user or default-selection flow.
IsTotalsSelected Property IsTotalsSelected As Boolean Carries whether totals are currently selected in the header experience.
IsTestInformationViewable ReadOnly Property IsTestInformationViewable As Boolean Indicates whether diagnostic test information may be shown.
TestInformation ReadOnly Property TestInformation As IApplicationTestInformationProvider Supplies diagnostic user and database details when test information is allowed.

Behavioral notes

  • The contract separates caller selection state from security-filtered visibility state.

Constraints and usage notes

  • Implementations are expected to cooperate with IPolicyHeaderDataProvider consumers, especially around association selection and test-information visibility.

Sources

  • Application\SAIF.Application.Policy\PolicyAppManager.vb