com.ibm.bpe.api
Interface ClientSetting

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
WebClientSetting

public interface ClientSetting
extends java.io.Serializable

Interface that supports the definition of user specific client settings.

Client settings can be attached to a process in order to overwrite Process Choreographer provided process template or process instance property pages. Client settings can also be attached to process receive and reply activities to display user specific start and completion pages of processes.

A client setting specifies the type of the client for which it is to be used and a number of custom settings in the form of type name and value pairs.

A client setting can look like following:
<wpc:webClientSettings clientType="Default">
 <wpc:customSetting name="approval" value="yes"/>
</wpc:webClientSettings>

Since:
5.1
See Also:
Serializable

Method Summary
 java.lang.String getClientType()
          Returns the type of the client for which this setting is defined.
 java.lang.String getCustomSetting(java.lang.String name)
          Returns the value of the specified custom setting.
 java.util.List getCustomSettingNames()
          Returns the names of all defined custom settings.
 

Method Detail

getClientType

public java.lang.String getClientType()
Returns the type of the client for which this setting is defined.

Returns:
String - The client type.

getCustomSetting

public java.lang.String getCustomSetting(java.lang.String name)
Returns the value of the specified custom setting. Null is returned when the specified custom setting cannot be found.

Parameters:
name - The name of the custom setting whose value is to be returned.
Returns:
String - The value of the specified custom setting.

getCustomSettingNames

public java.util.List getCustomSettingNames()
Returns the names of all defined custom settings.

Returns:
List - The names of all defined custom settings.