Package com.netscape.cms.profile.common
Class ProfileInput
java.lang.Object
com.netscape.cms.profile.common.ProfileInput
- All Implemented Interfaces:
IConfigTemplate
- Direct Known Subclasses:
EnrollInput
This interface represents a input policy which
provides information on how to create the
end-user enrollment page.
- Version:
- $Revision$, $Date$
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract ConfigStore
Returns configuration store.abstract String
Retrieves the localizable name of this policy.abstract String
Retrieves the localizable description of this policy.abstract String
Retrieves value from the request.abstract IDescriptor
getValueDescriptor
(Locale locale, String name) Retrieves the descriptor of the given value property by name.abstract Enumeration<String>
Retrieves a list of names of the property.abstract void
Populates the request with this policy default.abstract void
Sets the value of the given property by name.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.netscape.certsrv.property.IConfigTemplate
getConfig, getConfigDescriptor, getConfigNames, setConfig
-
Constructor Details
-
ProfileInput
public ProfileInput()
-
-
Method Details
-
getConfigStore
Returns configuration store.- Returns:
- configuration store
-
populate
Populates the request with this policy default.- Parameters:
ctx
- profile contextrequest
- request- Throws:
Exception
- failed to populate
-
getName
Retrieves the localizable name of this policy.- Parameters:
locale
- user locale- Returns:
- localized input name
-
getText
Retrieves the localizable description of this policy.- Parameters:
locale
- user locale- Returns:
- localized input description
-
getValueNames
Retrieves a list of names of the property.- Returns:
- a list of property names
-
getValueDescriptor
Retrieves the descriptor of the given value property by name.- Parameters:
locale
- user localename
- property name- Returns:
- descriptor of the property
-
getValue
public abstract String getValue(String name, Locale locale, Request request) throws EProfileException Retrieves value from the request.- Parameters:
name
- property namelocale
- user localerequest
- request- Throws:
EProfileException
- failed to get value
-
setValue
public abstract void setValue(String name, Locale locale, Request request, String value) throws EPropertyException Sets the value of the given property by name.- Parameters:
name
- property namelocale
- user localerequest
- requestvalue
- value- Throws:
EPropertyException
-