From 058bacb4456af33e95e2034593ccc19e6d4b5f83 Mon Sep 17 00:00:00 2001
From: chasegawa <chasegawa@unicon.net>
Date: Mon, 28 Jun 2021 11:53:45 -0700
Subject: [PATCH] SHIBUI-1980

adding comment/documentation
---
 .../admin/ui/domain/IRelyingPartyOverrideProperty.java       | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/IRelyingPartyOverrideProperty.java b/backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/IRelyingPartyOverrideProperty.java
index ee2e7fba8..076fce7dd 100644
--- a/backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/IRelyingPartyOverrideProperty.java
+++ b/backend/src/main/java/edu/internet2/tier/shibboleth/admin/ui/domain/IRelyingPartyOverrideProperty.java
@@ -33,6 +33,11 @@ public interface IRelyingPartyOverrideProperty {
 
     public String getPersistValue();
     
+    /**
+     * When the override actually is used in the UI, the "type" list is fairly limited, so each implementing class
+     * should adjust the real value so the UI gets a value it expects. For actual file configured overrides, this 
+     * means doing nothing, but UI defined attributes have to do some work.
+     */
     public String getTypeForUI();
 
     public void setAttributeFriendlyName(String attributeFriendlyName);