diff options
Diffstat (limited to 'base/common/src/com/netscape/certsrv/profile/IProfileInput.java')
-rw-r--r-- | base/common/src/com/netscape/certsrv/profile/IProfileInput.java | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/base/common/src/com/netscape/certsrv/profile/IProfileInput.java b/base/common/src/com/netscape/certsrv/profile/IProfileInput.java new file mode 100644 index 000000000..4ef598698 --- /dev/null +++ b/base/common/src/com/netscape/certsrv/profile/IProfileInput.java @@ -0,0 +1,120 @@ +// --- 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.Enumeration; +import java.util.Locale; + +import com.netscape.certsrv.base.IConfigStore; +import com.netscape.certsrv.property.EPropertyException; +import com.netscape.certsrv.property.IConfigTemplate; +import com.netscape.certsrv.property.IDescriptor; +import com.netscape.certsrv.request.IRequest; + +/** + * This interface represents a input policy which + * provides information on how to create the + * end-user enrollment page. + * + * @version $Revision$, $Date$ + */ +public interface IProfileInput extends IConfigTemplate { + + /** + * Initializes this default policy. + * + * @param profile owner of this input + * @param config configuration store + * @exception EProfileException failed to initialize + */ + public void init(IProfile profile, IConfigStore config) + throws EProfileException; + + /** + * Returns 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 localized input name + */ + public String getName(Locale locale); + + /** + * Retrieves the localizable description of this policy. + * + * @param locale user locale + * @return localized input description + */ + public String getText(Locale locale); + + /** + * Retrieves a list of names of the property. + * + * @return a list of property names + */ + public Enumeration<String> getValueNames(); + + /** + * Retrieves the descriptor of the given value + * property by name. + * + * @param locale user locale + * @param name property name + * @return descriptor of the property + */ + public IDescriptor getValueDescriptor(Locale locale, String name); + + /** + * Retrieves value from the request. + * + * @param name property name + * @param locale user locale + * @param request request + * @exception EProfileException failed to get value + */ + public String getValue(String name, Locale locale, IRequest request) + throws EProfileException; + + /** + * Sets the value of the given property by name. + * + * @param name property name + * @param locale user locale + * @param request request + * @param value value + * @exception EProfileException failed to get value + */ + public void setValue(String name, Locale locale, IRequest request, + String value) throws EPropertyException; +} |