com.adobe.idp.dsc.registry.infomodel
Interface ConfigParameter

public interface ConfigParameter

A ConfigParameter object stores information about configuration values. When adding certain endpoints, you must set configuration values. Configuration values are required when adding either Email or Watched Folder endpoints. Configuration values are set programmatically using the LiveCycle ES API or are specified by an administrator using Adobe Administrative Console. For information about setting configuration values for a Watched Folder endpoint, see Adding Watched Folder Endpoints in the LiveCycle SDK Help. Likewise for information about setting configuration values for an Email endpoint, see Adding Email Endpoints in the LiveCycle SDK Help.

Method Summary

java.util.Map	getAttributes() Retrieves a set of attributes that are specific to the component that invokes this service.
java.lang.String	getDescription() Retrieves the description of a configuration value.
java.lang.String	getHint() Retrieves text that describes the purpose of this configuration value.
java.lang.String	getName() Retrieves the name of a configuration value.
PropertyEditor	getPropertyEditor() Retrieves a PropertyEditor object that optionally references a PropertyEditorComponent object to use for editing and viewing this configuration value.
java.lang.String	getTextValue() Retrieves the value of this configuration value.
java.lang.String	getTitle() Retrieves the name of this configuration value.
java.lang.String	getType() Retrieves the configuration value data type.
boolean	isRequired() Determines whether this configuration value is required.

Method Detail

getName

java.lang.String getName()

Retrieves the name of a configuration value. This value must be unique.

Returns:

A string value that specifies the name of the configuration value.

getDescription

java.lang.String getDescription()

Retrieves the description of a configuration value.

Returns:

A string value that specifies the description of the configuration value.

getType

java.lang.String getType()

Retrieves the configuration value data type.

Returns:

A string value that specifies the configuration value data type.

isRequired

boolean isRequired()

Determines whether this configuration value is required.

Returns:

The value true if this configuration parameter is required.

getAttributes

java.util.Map getAttributes()

Retrieves a set of attributes that are specific to the component that invokes this service.

Returns:

A set of attributes specific to the component that invokes this service.

getTextValue

java.lang.String getTextValue()

Retrieves the value of this configuration value.

Returns:

A string value that represents the configuration value.

getPropertyEditor

PropertyEditor getPropertyEditor()

Retrieves a PropertyEditor object that optionally references a PropertyEditorComponent object to use for editing and viewing this configuration value.

Returns:

A PropertyEditor object that is used to edit or view this configuration parameter value.

getTitle

java.lang.String getTitle()

Retrieves the name of this configuration value.

Returns:

A string value that specifies the configuration value name.

getHint

java.lang.String getHint()

Retrieves text that describes the purpose of this configuration value.

Returns:

A string value that specifies the purpose of this configuration value.