org.figure8.join.core
Interface Configurable

All Known Subinterfaces:

Notifier, SubscribersNotifier

All Known Implementing Classes:

AntScriptLauncher, AntScriptLauncherJMSAdapter, AntScriptLauncherQuartzAdapter, GoogleTalkNotifier, GoogleTalkNotifierJMSAdapter, GroovyScriptLauncher, GroovyScriptLauncherJMSAdapter, GroovyScriptLauncherQuartzAdapter, JSR223ScriptLauncher, JSR223ScriptLauncherJMSAdapter, JSR223ScriptLauncherQuartzAdapter, MailNotifier, MailNotifierJMSAdapter, RubyScriptLauncher, RubyScriptLauncherJMSAdapter, RubyScriptLauncherQuartzAdapter, ScriptLauncher, ScriptLauncherAdapterSupport, ScriptLauncherJMSAdapter, ScriptLauncherQuartzAdapter, SubscribersNotifierAdapterSupport, SubscribersNotifierJMSAdapter, XMPPNotifier, XMPPNotifierJMSAdapter

public interface Configurable

This is an interface allowing objects and services to self-describe some of them parameters. This is useful when service implementations are configured using an interactive processus (such as a web wizard form ;-))

Version:

$Revision: 1.2 $

Author:

Laurent Broudoux

Method Summary

ParameterDefinition[]	getParameterDefinitions() Get this object parameters definitions as an array
java.util.List	getParameterDefinitionsAsList() Get this object parameters definitions as a list
void	setParameter(ParameterDefinition parameter, java.lang.String parameterValue) Set the value of a parameter using its definitions
void	setParameter(java.lang.String parameterName, java.lang.String parameterValue) Set the value of a parameter using its nama
void	setParameters(java.util.Properties parameters) Convenient methods for setting all attributes values using a single method.

Method Detail

getParameterDefinitionsAsList

java.util.List getParameterDefinitionsAsList()

Get this object parameters definitions as a list

Returns:

A list of ParameterDefinition objects

getParameterDefinitions

ParameterDefinition[] getParameterDefinitions()

Get this object parameters definitions as an array

Returns:

An array of ParameterDefinition objects

setParameter

void setParameter(java.lang.String parameterName,
                  java.lang.String parameterValue)
                  throws InvalidParameterException

Set the value of a parameter using its nama

Parameters:

parameterName - The name of parameter so set value for

parameterValue - The value of the paramater

Throws:

InvalidParameterException - if this parameter is not supported by this object

setParameter

void setParameter(ParameterDefinition parameter,
                  java.lang.String parameterValue)
                  throws InvalidParameterException

Set the value of a parameter using its definitions

Parameters:

parameter - The definition of the paramater to set

parameterValue - The value of the parameter

Throws:

InvalidParameterException - if this parameter is not supported by this object

setParameters

void setParameters(java.util.Properties parameters)
                   throws InvalidParameterException

Convenient methods for setting all attributes values using a single method.

Parameters:

parameters - Properties where keys are parameter names

Throws:

InvalidParameterException - if one of these parameters is not supported by this object