Package com.netscape.cms.profile.common
Class ProfileOutput
java.lang.Object
com.netscape.cms.profile.common.ProfileOutput
- All Implemented Interfaces:
IConfigTemplate
- Direct Known Subclasses:
EnrollOutput
This interface represents a output policy which
provides information on how to build the result
page for the enrollment.
- Version:
- $Revision$, $Date$
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract ConfigStore
Retrieves configuration store.abstract String
Retrieves the localizable name of this policy.abstract String
Retrieves the localizable description of this policy.abstract String
Retrieves the value of the given value parameter by name.abstract IDescriptor
getValueDescriptor
(Locale locale, String name) Retrieves the descriptor of the given value parameter by name.abstract Enumeration<String>
Retrieves a list of names of the value parameter.abstract void
init
(ConfigStore config) Initializes this default policy.abstract void
Populates the request with this policy default.abstract void
Sets the value of the given value parameter 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
-
ProfileOutput
public ProfileOutput()
-
-
Method Details
-
init
Initializes this default policy.- Parameters:
config
- configuration store- Throws:
EProfileException
- failed to initialize
-
getConfigStore
Retrieves configuration store.- Returns:
- configuration store
-
populate
Populates the request with this policy default.- Parameters:
ctx
- profile contextrequest
- request- Throws:
EProfileException
- failed to populate
-
getName
Retrieves the localizable name of this policy.- Parameters:
locale
- user locale- Returns:
- output policy name
-
getText
Retrieves the localizable description of this policy.- Parameters:
locale
- user locale- Returns:
- output policy description
-
getValueNames
Retrieves a list of names of the value parameter.- Returns:
- a list of property names
-
getValueDescriptor
Retrieves the descriptor of the given value parameter by name.- Parameters:
locale
- user localename
- property name- Returns:
- property descriptor
-
getValue
public abstract String getValue(String name, Locale locale, Request request) throws EProfileException Retrieves the value of the given value parameter by name.- Parameters:
name
- property namelocale
- user localerequest
- request- Returns:
- property value
- Throws:
EProfileException
- failed to retrieve value
-
setValue
public abstract void setValue(String name, Locale locale, Request request, String value) throws EPropertyException Sets the value of the given value parameter by name.- Parameters:
name
- property namelocale
- user localerequest
- requestvalue
- property value- Throws:
EPropertyException
-