com.netscape.cms.profile.input
Class GenericInput

java.lang.Object
  extended by com.netscape.cms.profile.input.EnrollInput
      extended by com.netscape.cms.profile.input.GenericInput
All Implemented Interfaces:
IProfileInput, IConfigTemplate

public class GenericInput
extends EnrollInput
implements IProfileInput

This class implements a generic input.

Version:
$Revision: 1211 $, $Date: 2010-08-18 10:15:37 -0700 (Wed, 18 Aug 2010) $

Field Summary
static java.lang.String CONFIG_DISPLAY_NAME
           
static java.lang.String CONFIG_ENABLE
           
static java.lang.String CONFIG_NUM
           
static java.lang.String CONFIG_PARAM_NAME
           
static int DEF_NUM
           
 
Fields inherited from class com.netscape.cms.profile.input.EnrollInput
mConfig, mConfigNames, mProfile, mSignedAuditLogger, mValueNames
 
Constructor Summary
GenericInput()
           
 
Method Summary
 IDescriptor getConfigDescriptor(java.util.Locale locale, java.lang.String name)
          Returns the descriptors of configuration parameter.
 java.lang.String getName(java.util.Locale locale)
          Retrieves the localizable name of this policy.
protected  int getNum()
           
 java.lang.String getText(java.util.Locale locale)
          Retrieves the localizable description of this policy.
 IDescriptor getValueDescriptor(java.util.Locale locale, java.lang.String name)
          Retrieves the descriptor of the given value parameter by name.
 java.util.Enumeration getValueNames()
          Returns selected value names based on the configuration.
 void init(IProfile profile, IConfigStore config)
          Initializes this default policy.
 void populate(IProfileContext ctx, IRequest request)
          Populates the request with this policy default.
 
Methods inherited from class com.netscape.cms.profile.input.EnrollInput
addConfigName, addValueName, audit, auditSubjectID, getConfig, getConfigNames, getConfigStore, getDefaultConfig, getLocale, getValue, setConfig, setValue, verifyPOP
 
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.profile.IProfileInput
getConfigStore, getValue, setValue
 
Methods inherited from interface com.netscape.certsrv.property.IConfigTemplate
getConfig, getConfigNames, setConfig
 

Field Detail

CONFIG_NUM

public static final java.lang.String CONFIG_NUM
See Also:
Constant Field Values

CONFIG_DISPLAY_NAME

public static final java.lang.String CONFIG_DISPLAY_NAME
See Also:
Constant Field Values

CONFIG_PARAM_NAME

public static final java.lang.String CONFIG_PARAM_NAME
See Also:
Constant Field Values

CONFIG_ENABLE

public static final java.lang.String CONFIG_ENABLE
See Also:
Constant Field Values

DEF_NUM

public static final int DEF_NUM
See Also:
Constant Field Values
Constructor Detail

GenericInput

public GenericInput()
Method Detail

getNum

protected int getNum()

init

public void init(IProfile profile,
                 IConfigStore config)
          throws EProfileException
Initializes this default policy.

Specified by:
init in interface IProfileInput
Overrides:
init in class EnrollInput
Parameters:
profile - owner of this input
config - configuration store
Throws:
EProfileException - failed to initialize

getName

public java.lang.String getName(java.util.Locale locale)
Retrieves the localizable name of this policy.

Specified by:
getName in interface IProfileInput
Specified by:
getName in class EnrollInput
Parameters:
locale - user locale
Returns:
localized input name

getText

public java.lang.String getText(java.util.Locale locale)
Retrieves the localizable description of this policy.

Specified by:
getText in interface IProfileInput
Specified by:
getText in class EnrollInput
Parameters:
locale - user locale
Returns:
localized input description

getValueNames

public java.util.Enumeration getValueNames()
Returns selected value names based on the configuration.

Specified by:
getValueNames in interface IProfileInput
Overrides:
getValueNames in class EnrollInput
Returns:
a list of property names

populate

public void populate(IProfileContext ctx,
                     IRequest request)
              throws EProfileException
Populates the request with this policy default.

Specified by:
populate in interface IProfileInput
Specified by:
populate in class EnrollInput
Parameters:
ctx - profile context
request - request
Throws:
EProfileException - failed to populate

getConfigDescriptor

public IDescriptor getConfigDescriptor(java.util.Locale locale,
                                       java.lang.String name)
Description copied from interface: IConfigTemplate
Returns the descriptors of configuration parameter.

Specified by:
getConfigDescriptor in interface IConfigTemplate
Overrides:
getConfigDescriptor in class EnrollInput
Parameters:
locale - user locale
name - configuration parameter name
Returns:
descriptor

getValueDescriptor

public IDescriptor getValueDescriptor(java.util.Locale locale,
                                      java.lang.String name)
Retrieves the descriptor of the given value parameter by name.

Specified by:
getValueDescriptor in interface IProfileInput
Specified by:
getValueDescriptor in class EnrollInput
Parameters:
locale - user locale
name - property name
Returns:
descriptor of the property