1 files changed, 117 insertions, 0 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/profile/IProfileOutput.java b/pki/base/common/src/com/netscape/certsrv/profile/IProfileOutput.java
new file mode 100644
index 000000000..ad9484648
--- /dev/null
+++ b/pki/base/common/src/com/netscape/certsrv/profile/IProfileOutput.java
@@ -0,0 +1,117 @@
+// --- BEGIN COPYRIGHT BLOCK ---
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; version 2 of the License.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, write to the Free Software Foundation, Inc.,
+// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+//
+// (C) 2007 Red Hat, Inc.
+// All rights reserved.
+// --- END COPYRIGHT BLOCK ---
+package com.netscape.certsrv.profile;
+
+import java.util.*;
+import com.netscape.certsrv.base.*;
+import com.netscape.certsrv.property.*;
+import com.netscape.certsrv.request.*;
+
+/**
+ * This interface represents a output policy which
+ * provides information on how to build the result
+ * page for the enrollment.
+ * 
+ * @version $Revision$, $Date$
+ */
+public interface IProfileOutput extends IConfigTemplate {
+
+    /**
+     * Initializes this default policy.
+     *
+     * @param profile owner of this policy
+     * @param config configuration store
+     * @exception EProfileException failed to initialize
+     */
+    public void init(IProfile profile, IConfigStore config)
+        throws EProfileException;
+
+    /**
+     * Retrieves configuration store.
+     *
+     * @return configuration store
+     */
+    public IConfigStore getConfigStore();
+
+    /**
+     * Populates the request with this policy default.
+     *
+     * @param ctx profile context
+     * @param request request
+     * @exception EProfileException failed to populate
+     */
+    public void populate(IProfileContext ctx, IRequest request)
+        throws EProfileException;
+
+    /**
+     * Retrieves the localizable name of this policy.
+     *
+     * @param locale user locale
+     * @return output policy name
+     */
+    public String getName(Locale locale);
+
+    /**
+     * Retrieves the localizable description of this policy.
+     *
+     * @param locale user locale
+     * @return output policy description
+     */
+    public String getText(Locale locale);
+
+    /**
+     * Retrieves a list of names of the value parameter.
+     *
+     * @return a list of property names
+     */
+    public Enumeration getValueNames();
+
+    /**
+     * Retrieves the descriptor of the given value 
+     * parameter by name.
+     *
+     * @param locale user locale
+     * @param name property name
+     * @return property descriptor
+     */
+    public IDescriptor getValueDescriptor(Locale locale, String name);
+
+    /**
+     * Retrieves the value of the given value parameter by name.
+     *
+     * @param name property name
+     * @param locale user locale
+     * @param request request
+     * @return property value
+     * @exception EProfileException failed to retrieve value
+     */
+    public String getValue(String name, Locale locale, IRequest request)
+        throws EProfileException;
+
+    /**
+     * Sets the value of the given value parameter by name.
+     *
+     * @param name property name
+     * @param locale user locale
+     * @param request request
+     * @param value property value
+     * @exception EProfileException failed to retrieve value
+     */
+    public void setValue(String name, Locale locale, IRequest request, 
+        String value) throws EPropertyException;
+}