com.ibm.bpe.api
Interface CustomClientSettings

All Superinterfaces:
java.io.Serializable

public interface CustomClientSettings
extends java.io.Serializable

CustomClientSettings defines the interface for all client and Web client settings that are associated with a process template, process instance, or activity instance.

Since:
5.1

Method Summary
 ClientSetting getClientSetting(java.lang.String type)
          Returns the client settings for the specified client type.
 java.util.List getClientSettings()
          Returns a list of all defined client settings.
 java.util.List getClientTypes()
          Returns a list of all known client types.
 WebClientSetting getWebClientSetting()
          Returns the Web client settings.
 

Method Detail

getClientSetting

public ClientSetting getClientSetting(java.lang.String type)
Returns the client settings for the specified client type. Returns null when the specified type is not found.

Parameters:
type - The type of the client for which the setting is to be returned.
Returns:
ClientSetting - The client settings of the specified type.

getClientTypes

public java.util.List getClientTypes()
Returns a list of all known client types.

Returns:
List - The names of all known client types.

getClientSettings

public java.util.List getClientSettings()
Returns a list of all defined client settings.

Returns:
List - A list of client settings.

getWebClientSetting

public WebClientSetting getWebClientSetting()
Returns the Web client settings. Returns null when there are no Web client settings.

Returns:
WebClientSetting - The Web client settings.