com.ibm.bpe.api

Interface CustomClientSettings

All Superinterfaces:
java.lang.Cloneable, java.io.Serializable

  1. public interface CustomClientSettings
  2. extends java.io.Serializable, java.lang.Cloneable
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

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT

Method Summary

Modifier and Type Method and Description
  1. ClientSetting
getClientSetting(java.lang.String type)
Returns the client settings for the specified client type.
  1. java.util.List
getClientSettings()
Returns a list of all defined client settings.
  1. java.util.List
getClientTypes()
Returns a list of all known client types.
  1. PageflowClientSetting
getPageflowClientSetting(java.lang.String type)
Returns the pageflow client settings.
  1. java.util.List
getPageflowClientSettings()
Returns a list of all defined portal client settings.
  1. java.util.List
getPageflowClientTypes()
Returns a list of all portal client types.
  1. PortalClientSetting
getPortalClientSetting(java.lang.String type)
Returns the portal client settings.
  1. java.util.List
getPortalClientSettings()
Returns a list of all defined portal client settings.
  1. java.util.List
getPortalClientTypes()
Returns a list of all portal client types.
  1. WebClientSetting
getWebClientSetting()
Deprecated. Use getWebClientSetting(String) instead.
  1. WebClientSetting
getWebClientSetting(java.lang.String type)
Returns the web client settings.
  1. java.util.List
getWebClientSettings()
Returns a list of all defined web client settings.
  1. java.util.List
getWebClientTypes()
Returns a list of all web client types.

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

Method Detail

getClientSetting

  1. 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

  1. java.util.List getClientTypes()
Returns a list of all known client types.
Returns:
List - The names of all known client types.

getClientSettings

  1. java.util.List getClientSettings( )
Returns a list of all defined client settings.
Returns:
List - A list of client settings.

getWebClientSetting

  1. WebClientSetting getWebClientSetting( )
Deprecated. Use getWebClientSetting(String) instead.
Returns the web client settings. Returns null when there are no web client settings.
Returns:
WebClientSetting - The web client settings.

getWebClientSetting

  1. WebClientSetting getWebClientSetting( java.lang.String type)
Returns the web client settings. Returns null when there are no web client settings.
Parameters:
type - The type of the client for which the setting is to be returned.
Returns:
WebClientSetting - The web client settings.

getWebClientTypes

  1. java.util.List getWebClientTypes( )
Returns a list of all web client types.
Returns:
List - The names of all known web client types, that is, returns a list of String objects.

getWebClientSettings

  1. java.util.List getWebClientSettings( )
Returns a list of all defined web client settings.
Returns:
List - A list of WebClientSetting objects.

getPortalClientSetting

  1. PortalClientSetting getPortalClientSetting( java.lang.String type)
Returns the portal client settings. Returns null when there are no portal client settings.
Parameters:
type - The type of the client for which the setting is to be returned.
Returns:
PortalClientSetting - The portal client settings.

getPortalClientTypes

  1. java.util.List getPortalClientTypes( )
Returns a list of all portal client types.
Returns:
List - The names of all known portal client types, that is, returns a list of String objects.

getPortalClientSettings

  1. java.util.List getPortalClientSettings( )
Returns a list of all defined portal client settings.
Returns:
List - A list of PortalClientSetting objects.

getPageflowClientSetting

  1. PageflowClientSetting getPageflowClientSetting( java.lang.String type)
Returns the pageflow client settings. Returns null when there are no pageflow client settings.
Parameters:
type - The type of the client for which the setting is to be returned.
Returns:
PageflowClientSetting - The pageflow client settings.

getPageflowClientTypes

  1. java.util.List getPageflowClientTypes( )
Returns a list of all portal client types.
Returns:
List - The names of all known portal client types, that is, returns a list of String objects.

getPageflowClientSettings

  1. java.util.List getPageflowClientSettings( )
Returns a list of all defined portal client settings.
Returns:
List - A list of PortalClientSetting objects.