com.ibm.task.api
Interface CustomClientSettings
All Superinterfaces:
java.lang.Cloneable, java.io.Serializable
- public interface CustomClientSettings
- extends java.io.Serializable, java.lang.Cloneable
Since:
5.1
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Method Summary
Modifier and Type | Method and Description |
---|---|
getClientSetting(java.lang.String type)
Returns the client settings for the specified client type.
|
|
|
getClientSettings()
Returns a list of all client settings.
|
|
getClientTypes()
Returns a list of all known client types.
|
getPageflowClientSetting(java.lang.String type)
Returns the pageflow client settings.
|
|
|
getPageflowClientSettings()
Returns a list of all defined portal client settings.
|
|
getPageflowClientTypes()
Returns a list of all portal client types.
|
getPortalClientSetting(java.lang.String type)
Returns the portal client settings of the specified portal client type.
|
|
|
getPortalClientSettings()
Returns a list of all portal client settings.
|
|
getPortalClientTypes()
Returns a list of all portal client types.
|
getWebClientSetting()
Deprecated. Use
getWebClientSetting(String) instead.
|
|
getWebClientSetting(java.lang.String type)
Returns the web client settings for the specified web client type.
|
|
|
getWebClientSettings()
Returns a list of all web client settings.
|
|
getWebClientTypes()
Returns a list of all web client types.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
See Also:
Method Detail
getClientSetting
- ClientSetting getClientSetting( java.lang.String type)
Returns the client settings for the specified client type.
Returns null when the specified type is not found or when there is no client setting.
Parameters:
type
- The type of the client for which the setting is to be returned. Returns:
ClientSetting -
The client settings of the specified type.
Since:
5.1
getClientTypes
- java.util.List getClientTypes()
Returns a list of all known client types.
Returns:
List -
The names of all known client types, that is, returns a list of String objects.
Since:
5.1
getClientSettings
- java.util.List getClientSettings( )
Returns a list of all client settings.
Returns:
List -
A list of ClientSetting objects.
Since:
5.1
getWebClientSetting
- 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.
Since:
5.1
getWebClientSetting
- WebClientSetting getWebClientSetting( java.lang.String type)
Returns the web client settings for the specified web client type.
Returns null when the specified web client type is not found or when there are no web client settings.
Parameters:
type
- The type of the client for which the web client settings are to be returned. Returns:
WebClientSetting -
The web client settings.
Since:
6.0
getWebClientTypes
- 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.
Since:
6.0
getWebClientSettings
- java.util.List getWebClientSettings( )
Returns a list of all web client settings.
Returns:
List -
A list of WebClientSetting objects.
Since:
6.0
getPortalClientSetting
- PortalClientSetting getPortalClientSetting( java.lang.String type)
Returns the portal client settings of the specified portal client type.
Returns null when the specified type is not found or 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.
Since:
6.0
getPortalClientTypes
- 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.
Since:
6.0
getPortalClientSettings
- java.util.List getPortalClientSettings( )
Returns a list of all portal client settings.
Returns:
List -
A list of PortalClientSetting objects.
Since:
6.0
getPageflowClientSetting
- 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
- 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
- java.util.List getPageflowClientSettings( )
Returns a list of all defined portal client settings.
Returns:
List -
A list of PortalClientSetting objects.