org.palo.api.parameters
Interface ParameterReceiver


public interface ParameterReceiver

A ParameterReceiver can be used to receive arbitrary parameters from any ParameterProvider. How these parameters are interpreted is up to the specific implementation of the receiver. For an example, have a look at the org.palo.viewapi.uimodels.folders package.

Version:
$Id: ParameterReceiver.html,v 1.3 2009/07/09 11:01:47 ArndHouben Exp $

Method Summary
 void addParameterValue(java.lang.String parameterName, java.lang.Object parameterValue)
          Adds the specified value to the current value of the specified parameter;
 java.lang.Object getDefaultValue(java.lang.String parameterName)
          Returns the default value for the given parameter or null, if no such parameter exists.
 java.lang.String[] getParameterNames()
          Returns all parameter names understood by this receiver.
 java.lang.Object getParameterValue(java.lang.String parameterName)
          Returns the value for the given parameter or null, if no such parameter is set.
 boolean isParameterized()
          Returns true if the current instance of the object is parameterized, false otherwise.
 void setParameter(java.lang.String parameterName, java.lang.Object parameterValue)
          Sets the specified parameter to the specified value.
 void setParameterNames(java.lang.String[] parameterNames)
          Sets all parameter names that can be interpreted by this receiver.
 

Method Detail

getParameterNames

java.lang.String[] getParameterNames()
Returns all parameter names understood by this receiver.

Returns:
all parameter names understood by this receiver.

setParameterNames

void setParameterNames(java.lang.String[] parameterNames)
Sets all parameter names that can be interpreted by this receiver.

Parameters:
parameterNames - the new set of parameter names understood by this receiver.

getParameterValue

java.lang.Object getParameterValue(java.lang.String parameterName)
Returns the value for the given parameter or null, if no such parameter is set.

Parameters:
parameterName - the name of the parameter of which the value is to be returned.
Returns:
the value for the given parameter or null.

getDefaultValue

java.lang.Object getDefaultValue(java.lang.String parameterName)
Returns the default value for the given parameter or null, if no such parameter exists.

Parameters:
parameterName - the name of the parameter of which the default value is to be returned.
Returns:
the default value for the given parameter or null.

setParameter

void setParameter(java.lang.String parameterName,
                  java.lang.Object parameterValue)
Sets the specified parameter to the specified value.

Parameters:
parameterName - the name of the parameter to set.
parameterValue - the value of the parameter to set.

addParameterValue

void addParameterValue(java.lang.String parameterName,
                       java.lang.Object parameterValue)
Adds the specified value to the current value of the specified parameter;

Parameters:
parameterName - the name of the parameter to set.
parameterValue - the value of the parameter to set.

isParameterized

boolean isParameterized()
Returns true if the current instance of the object is parameterized, false otherwise.

Returns:
true if the object is parameterized, false otherwise.