WebCenter Interaction API  
 

IPTServerConfigSettings Members

IPTServerConfigSettings overview

Public Instance Methods

public methodGetSettingAsBoolean Returns the specified global Plumtree setting as a boolean. If the setting is not recognized, will throw PT_RESULTCODES.PT_E_INVALIDARG. If the setting is recognized, but is not a boolean, will throw a XPFormatException.
public methodGetSettingAsDouble Returns the specified global Plumtree setting as a double. If the setting is not recognized, will throw PT_RESULTCODES.PT_E_INVALIDARG. If the setting is recognized, but is not a double, will throw a XPFormatException.
public methodGetSettingAsInt Returns the specified global Plumtree setting as an int. If the setting is not recognized, will throw PT_RESULTCODES.PT_E_INVALIDARG. If the setting is recognized, but is not an integer, will throw a XPFormatException.
public methodGetSettingAsObject Returns the specified global Plumtree setting as an Object. If the setting is not recognized, will throw PT_RESULTCODES.PT_E_INVALIDARG. NOTE: Generally, clients should call the "type safe" GetSetting calls (GetSettingAsInt, GetSettingAsString, GetSettingAsXPDateTime, GetSettingAsDouble.) The type safe calls assure that the caller gets the correct type of return value.
public methodGetSettingAsString Returns the specified global Plumtree setting as a String. If the setting is not recognized, will throw PT_RESULTCODES.PT_E_INVALIDARG. If the setting is recognized, but is not a string, will return a string representation of the setting.
public methodGetSettingAsXPDateTime Returns the specified global Plumtree setting as a XPDateTime. If the setting is not recognized, will throw PT_RESULTCODES.PT_E_INVALIDARG. If the setting is recognized, but is not a datetime, will throw a ClassCastException.
public methodGetSettingsOverloaded. This function is deprecated. Callers should call GetSettings (int[] iaSettingIDs) instead.
public methodSetSettingOverloaded. Sets the specified global Plumtree setting. Note that setting changes generally do not take effect until the Plumtree process is restarted.

See Also

IPTServerConfigSettings Interface | com.plumtree.server Namespace | PT_SERVER_CONFIG_SETTINGNAME