SHIBUI-1980

adding comment/documentation
TIER · Jun 28, 2021 · 058bacb · 058bacb
1 parent d350b3b
commit 058bacb
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/...ain/java/edu/internet2/tier/shibboleth/admin/ui/domain/IRelyingPartyOverrideProperty.java b/...ain/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);