GenericInput (pki-javadoc)

java.lang.Object
- com.netscape.cms.profile.common.ProfileInput
- - com.netscape.cms.profile.input.EnrollInput
  - - com.netscape.cms.profile.input.GenericInput

All Implemented Interfaces:

IConfigTemplate
```
public class GenericInput
extends EnrollInput
```
This class implements a generic input.

Version:

$Revision$, $Date$

Field Summary

Fields
Modifier and Type	Field and Description
`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
logger, mConfig, mConfigNames, mProfile, mValueNames

Constructor Summary

Constructors
Constructor and Description

GenericInput()

Constructors
Constructor and Description
`GenericInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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<java.lang.String>`	`getValueNames()` Returns selected value names based on the configuration.
`void`	`init(Profile profile, IConfigStore config)` Initializes this default policy.
`void`	`populate(java.util.Map<java.lang.String,java.lang.String> ctx, IRequest request)` Populates the request with this policy default.

Methods inherited from class com.netscape.cms.profile.input.EnrollInput
addConfigName, addValueName, 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

- 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(Profile profile,
                 IConfigStore config)
          throws EProfileException
```
    Initializes this default policy.
    
    Overrides:
    
    init in class EnrollInput
    
    Throws:
    
    EProfileException
  - getName
```
public java.lang.String getName(java.util.Locale locale)
```
    Retrieves the localizable name of this policy.
    
    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 class EnrollInput
    
    Parameters:
    
    locale - user locale
    
    Returns:
    
    localized input description
  - getValueNames
```
public java.util.Enumeration<java.lang.String> getValueNames()
```
    Returns selected value names based on the configuration.
    
    Overrides:
    
    getValueNames in class EnrollInput
    
    Returns:
    
    a list of property names
  - populate
```
public void populate(java.util.Map<java.lang.String,java.lang.String> ctx,
                     IRequest request)
              throws java.lang.Exception
```
    Populates the request with this policy default.
    
    Specified by:
    
    populate in class EnrollInput
    
    Parameters:
    
    ctx - profile context
    
    request - request
    
    Throws:
    
    java.lang.Exception - 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 class EnrollInput
    
    Parameters:
    
    locale - user locale
    
    name - property name
    
    Returns:
    
    descriptor of the property

Class GenericInput

Field Summary

Fields inherited from class com.netscape.cms.profile.input.EnrollInput

Constructor Summary

Method Summary

Methods inherited from class com.netscape.cms.profile.input.EnrollInput

Methods inherited from class java.lang.Object

Field Detail

CONFIG_NUM

CONFIG_DISPLAY_NAME

CONFIG_PARAM_NAME

CONFIG_ENABLE

DEF_NUM

Constructor Detail

GenericInput

Method Detail

getNum

init

getName

getText

getValueNames

populate

getConfigDescriptor

getValueDescriptor