ProfileInput (pki-javadoc)

java.lang.Object
- com.netscape.cms.profile.common.ProfileInput

All Implemented Interfaces:

IConfigTemplate

Direct Known Subclasses:

EnrollInput
```
public abstract class ProfileInput
extends java.lang.Object
implements IConfigTemplate
```
This interface represents a input policy which provides information on how to create the end-user enrollment page.

Version:

$Revision$, $Date$

Constructor Summary

Constructors
Constructor and Description

ProfileInput()

Constructors
Constructor and Description
`ProfileInput()`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract IConfigStore`	`getConfigStore()` Returns configuration store.
`abstract java.lang.String`	`getName(java.util.Locale locale)` Retrieves the localizable name of this policy.
`abstract java.lang.String`	`getText(java.util.Locale locale)` Retrieves the localizable description of this policy.
`abstract java.lang.String`	`getValue(java.lang.String name, java.util.Locale locale, IRequest request)` Retrieves value from the request.
`abstract IDescriptor`	`getValueDescriptor(java.util.Locale locale, java.lang.String name)` Retrieves the descriptor of the given value property by name.
`abstract java.util.Enumeration<java.lang.String>`	`getValueNames()` Retrieves a list of names of the property.
`abstract void`	`populate(java.util.Map<java.lang.String,java.lang.String> ctx, IRequest request)` Populates the request with this policy default.
`abstract void`	`setValue(java.lang.String name, java.util.Locale locale, IRequest request, java.lang.String value)` 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 Detail
- ProfileInput
```
public ProfileInput()
```

Method Detail

getConfigStore
```
public abstract IConfigStore getConfigStore()
```
Returns configuration store.

Returns:

configuration store

populate

public abstract 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.

Parameters:: ctx - profile context; request - request
Throws:: java.lang.Exception - failed to populate

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

Parameters:

locale - user locale

Returns:

localized input name

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

Parameters:

locale - user locale

Returns:

localized input description

getValueNames
```
public abstract java.util.Enumeration<java.lang.String> getValueNames()
```
Retrieves a list of names of the property.

Returns:

a list of property names

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

Parameters:

locale - user locale

name - property name

Returns:

descriptor of the property

getValue

public abstract java.lang.String getValue(java.lang.String name,
                                          java.util.Locale locale,
                                          IRequest request)
                                   throws EProfileException

Retrieves value from the request.

Parameters:: name - property name; locale - user locale; request - request
Throws:: EProfileException - failed to get value

setValue

public abstract void setValue(java.lang.String name,
                              java.util.Locale locale,
                              IRequest request,
                              java.lang.String value)
                       throws EPropertyException

Sets the value of the given property by name.

Parameters:: name - property name; locale - user locale; request - request; value - value
Throws:: EPropertyException

Class ProfileInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.netscape.certsrv.property.IConfigTemplate

Constructor Detail

ProfileInput

Method Detail

getConfigStore

populate

getName

getText

getValueNames

getValueDescriptor

getValue

setValue