com.ibm.bpe.api
Interface ClientSetting
All Superinterfaces:
java.lang.Cloneable, java.io.Serializable
All known subinterfaces:
- public interface ClientSetting
- extends java.io.Serializable, java.lang.Cloneable
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
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getClientType()
Returns the type of the client for which this setting is defined.
|
|
getCustomSetting(java.lang.String name)
Returns the value of the specified custom setting.
|
|
getCustomSettingNames()
Returns the names of all defined custom settings.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
See Also:
Method Detail
getClientType
- java.lang.String getClientType( )
Returns the type of the client for which this setting is defined.
Returns:
String - The client type.
getCustomSetting
- 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
- java.util.List getCustomSettingNames( )
Returns the names of all defined custom settings.
Returns:
List - The names of all defined custom settings.