com.tibco.bw.plugin.config
Interface ConfigProps


public interface ConfigProps

The BW activity configuration model, which is represented as a bag of typed properties. Each activity advertises the set of properties that are available and for each property its associated type.

This interface is also used to represent configuration properties of complex types as well as configuration properties of shared resources.


Method Summary
 boolean getPropertyValueAsBoolean(byte property)
          Retrieve the value of a configuration property that is of type boolean.
 ConfigProps getPropertyValueAsConfigProps(byte property)
          Retrieve the value of a configuration property that is of type ConfigProps.
 java.util.List<ConfigProps> getPropertyValueAsConfigPropsList(byte property)
          Retrieve the value of a configuration property that is of type List.
 java.util.List<Param> getPropertyValueAsParamList(byte property)
          Retrieve the value of a configuration properties that is of type Param.
 java.lang.String getPropertyValueAsString(byte property)
          Retrieve the value of a configuration property that is of type String.
 

Method Detail

getPropertyValueAsString


java.lang.String getPropertyValueAsString(byte property)
Retrieve the value of a configuration property that is of type String.

This method should not be called for a configuration property of a different type. If this method is called for a configuration property of a different type an IllegalArgumentException is thrown.

Parameters:
property - The configuration property
Returns:
The value of the configuration property

getPropertyValueAsBoolean


boolean getPropertyValueAsBoolean(byte property)
Retrieve the value of a configuration property that is of type boolean.

This method should not be called for a configuration property of a different type. If this method is called for a configuration property of a different type an IllegalArgumentException is thrown.

Parameters:
property - The configuration property
Returns:
The value of the configuration property

getPropertyValueAsConfigProps


ConfigProps getPropertyValueAsConfigProps(byte property)
Retrieve the value of a configuration property that is of type ConfigProps. When used as a property type, ConfigProps represents either a complex type or the type of a shared configuration resource.

This method should not be called for a configuration property of a different type. If this method is called for a configuration property of a different type an IllegalArgumentException is thrown.

Parameters:
property - The configuration property
Returns:
The value of the configuration property

getPropertyValueAsConfigPropsList


java.util.List<ConfigProps> getPropertyValueAsConfigPropsList(byte property)
Retrieve the value of a configuration property that is of type List.

This method should not be called for a configuration property of a different type. If this method is called for a configuration property of a different type an IllegalArgumentException is thrown.

Parameters:
property - The configuration property
Returns:
The value of the configuration property
See Also:
ConfigProps

getPropertyValueAsParamList


java.util.List<Param> getPropertyValueAsParamList(byte property)
Retrieve the value of a configuration properties that is of type Param.

This method should not be called for a configuration property of a different type. If this method is called for a configuration property of a different type an IllegalArgumentException is thrown.

Parameters:
property - The configuration property
Returns:
The value of the configuration property
See Also:
Param


Copyright @ 2010, TIBCO Softwares (Inc). All right reserved