com.ibm.task.api

Interface ClientSetting

All Superinterfaces:
java.lang.Cloneable, java.io.Serializable
All known subinterfaces:
PageflowClientSetting, PortalClientSetting, WebClientSetting

  1. public interface ClientSetting
  2. extends java.io.Serializable, java.lang.Cloneable
Interface that supports the definition of user specific client settings.

Client settings can be attached to a task in order to overwrite Human Task Manager provided task instance property pages.

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
  1. static
  2. java.lang.String
COPYRIGHT

Method Summary

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

Field Detail

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

Method Detail

getClientType

  1. java.lang.String getClientType( )
Returns the type of the client for which this setting is defined.
Returns:
String - The client type.

getCustomSetting

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

  1. java.util.List getCustomSettingNames( )
Returns the names of all defined custom settings.
Returns:
List - The names of all defined custom settings.