com.netscape.cms.profile.def

Class NoDefault

java.lang.Object

com.netscape.cms.profile.def.NoDefault

All Implemented Interfaces:

IPolicyDefault, IConfigTemplate

public class NoDefault
extends java.lang.Object
implements IPolicyDefault

This class implements no default policy.

Version:

$Revision$, $Date$

Field Summary

Fields

Modifier and Type	Field and Description
protected IConfigStore	mConfig
protected java.util.Vector<java.lang.String>	mNames
protected java.util.Vector<java.lang.String>	mValues
static java.lang.String	PROP_NAME

Constructor Summary

Constructors

Constructor and Description
NoDefault()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfig(java.lang.String name) Retrieves configuration parameter by name.
IDescriptor	getConfigDescriptor(java.util.Locale locale, java.lang.String name) Returns the descriptors of configuration parameter.
java.util.Enumeration<java.lang.String>	getConfigNames() Returns a list of configuration parameter names.
IConfigStore	getConfigStore() Retrieves the configuration store of this default.
java.lang.String	getDefaultConfig(java.lang.String name)
java.lang.String	getName(java.util.Locale locale) Retrieves the localizable name of this policy.
java.lang.String	getText(java.util.Locale locale) Retrieves the localizable description of this policy.
java.lang.String	getValue(java.lang.String name, java.util.Locale locale, IRequest request) Retrieves the value of the given value property by name.
IDescriptor	getValueDescriptor(java.util.Locale locale, java.lang.String name) Retrieves the descriptor of the given property by name.
java.util.Enumeration<java.lang.String>	getValueNames() Retrieves a list of names of the property.
void	init(IProfile profile, IConfigStore config) Initializes this default policy.
void	populate(IRequest request) Populates the request with this policy default.
void	setConfig(java.lang.String name, java.lang.String value) Sets configuration parameter.
void	setValue(java.lang.String name, java.util.Locale locale, IRequest request, java.lang.String value) Sets the value of the given value property by name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROP_NAME

public static final java.lang.String PROP_NAME

See Also:

Constant Field Values

mValues

protected java.util.Vector<java.lang.String> mValues

mNames

protected java.util.Vector<java.lang.String> mNames

mConfig

protected IConfigStore mConfig

Constructor Detail

NoDefault

public NoDefault()

Method Detail

getConfigNames

public java.util.Enumeration<java.lang.String> getConfigNames()

Description copied from interface: IConfigTemplate

Returns a list of configuration parameter names.

Specified by:

getConfigNames in interface IConfigTemplate

Returns:

parameter names

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

Parameters:

locale - user locale

name - configuration parameter name

Returns:

descriptor

setConfig

public void setConfig(java.lang.String name,
                      java.lang.String value)
               throws EPropertyException

Description copied from interface: IConfigTemplate

Sets configuration parameter.

Specified by:

setConfig in interface IConfigTemplate

Parameters:

name - parameter name

value - parameter value

Throws:

EPropertyException - failed to set parameter

getDefaultConfig

public java.lang.String getDefaultConfig(java.lang.String name)

getConfig

public java.lang.String getConfig(java.lang.String name)

Description copied from interface: IConfigTemplate

Retrieves configuration parameter by name.

Specified by:

getConfig in interface IConfigTemplate

Returns:

parameter

init

public void init(IProfile profile,
                 IConfigStore config)
          throws EProfileException

Description copied from interface: IPolicyDefault

Initializes this default policy.

Specified by:

init in interface IPolicyDefault

Parameters:

profile - owner of this default policy

config - configuration store for this default

Throws:

EProfileException - failed to initialize

getConfigStore

public IConfigStore getConfigStore()

Description copied from interface: IPolicyDefault

Retrieves the configuration store of this default.

Specified by:

getConfigStore in interface IPolicyDefault

Returns:

configuration store of this default policy

populate

public void populate(IRequest request)
              throws EProfileException

Populates the request with this policy default.

Specified by:

populate in interface IPolicyDefault

Parameters:

request - request to be populated

Throws:

EProfileException - failed to populate

getValueNames

public java.util.Enumeration<java.lang.String> getValueNames()

Description copied from interface: IPolicyDefault

Retrieves a list of names of the property.

Specified by:

getValueNames in interface IPolicyDefault

Returns:

a list of property names. The values are of type java.lang.String

getValueDescriptor

public IDescriptor getValueDescriptor(java.util.Locale locale,
                                      java.lang.String name)

Description copied from interface: IPolicyDefault

Retrieves the descriptor of the given property by name. The descriptor contains syntax information.

Specified by:

getValueDescriptor in interface IPolicyDefault

Parameters:

locale - locale of the end user

name - name of property

Returns:

descriptor of the property

setValue

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

Description copied from interface: IPolicyDefault

Sets the value of the given value property by name.

Specified by:

setValue in interface IPolicyDefault

Parameters:

name - name of property

locale - locale of the end user

request - request

value - value to be set in the given request

Throws:

EPropertyException - failed to set property

getValue

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

Description copied from interface: IPolicyDefault

Retrieves the value of the given value property by name.

Specified by:

getValue in interface IPolicyDefault

Parameters:

name - name of property

locale - locale of the end user

request - request

getText

public java.lang.String getText(java.util.Locale locale)

Description copied from interface: IPolicyDefault

Retrieves the localizable description of this policy.

Specified by:

getText in interface IPolicyDefault

Parameters:

locale - locale of the end user

Returns:

localized description of this default policy

getName

public java.lang.String getName(java.util.Locale locale)

Description copied from interface: IPolicyDefault

Retrieves the localizable name of this policy.

Specified by:

getName in interface IPolicyDefault

Parameters:

locale - locale of the end user

Returns:

localized name of this default policy