com.plumtree.server
Interface IPTAdminSettings

public interface IPTAdminSettings

This interface is used to retrieve and set the Administrative settings on a Gadget. Administrative settings apply to every instance of a Gadget, regardless of the page on which it appears or who views it. For instance, consider a Gadget that connects to a back-end database to retrieve human resources information. The exact information retrieved will differ from user to user, but the connectivity information for the Gadget should be the same no matter where the Gadget is viewed. This connectivity information would be an example of an Administrative setting.

Author:

michaels

See Also:

IPTGadget

Method Summary

void	AddAdminGadgetSetting(java.lang.String bstrAdminGadgetSetting, double vValue) Sets a named Administrative setting for the Gadget, replacing any existing value for the setting.
void	AddAdminGadgetSetting(java.lang.String bstrAdminGadgetSetting, int vValue) Sets a named Administrative setting for the Gadget, replacing any existing value for the setting.
void	AddAdminGadgetSetting(java.lang.String bstrAdminGadgetSetting, java.lang.Object vValue) Sets a named Administrative setting for the Gadget, replacing any existing value for the setting.
void	AddAdminGadgetSetting(java.lang.String bstrAdminGadgetSetting, java.lang.String vValue) Sets a named Administrative setting for the Gadget, replacing any existing value for the setting.
void	AddAdminGadgetSetting(java.lang.String bstrAdminGadgetSetting, com.plumtree.openfoundation.util.XPDateTime vValue) Sets a named Administrative setting for the Gadget, replacing any existing value for the setting.
java.lang.Object[][]	LookupAdminGadgetSettings(java.lang.Object vsaSettings) Deprecated.
java.lang.Object[][]	LookupAdminGadgetSettings(java.lang.String vsaSettings) Retrieve the indicated Administrative setting for the Gadget.
java.lang.Object[][]	LookupAdminGadgetSettings(java.lang.String[] vsaSettings) Retrieve the indicated Administrative setting for the Gadget.
void	RemoveAdminGadgetSetting(java.lang.String bstrAdminGadgetSetting) Remove the indicated Administrative setting for the Gadget.

Method Detail

AddAdminGadgetSetting

void AddAdminGadgetSetting(java.lang.String bstrAdminGadgetSetting,
                           java.lang.String vValue)

Sets a named Administrative setting for the Gadget, replacing any existing value for the setting.

Parameters:

bstrAdminGadgetSetting - the name of the setting to be set

vValue - the value of the setting

AddAdminGadgetSetting

void AddAdminGadgetSetting(java.lang.String bstrAdminGadgetSetting,
                           int vValue)

Sets a named Administrative setting for the Gadget, replacing any existing value for the setting.

Parameters:

bstrAdminGadgetSetting - the name of the setting to be set

vValue - the value of the setting

AddAdminGadgetSetting

void AddAdminGadgetSetting(java.lang.String bstrAdminGadgetSetting,
                           double vValue)

Sets a named Administrative setting for the Gadget, replacing any existing value for the setting.

Parameters:

bstrAdminGadgetSetting - the name of the setting to be set

vValue - the value of the setting

AddAdminGadgetSetting

void AddAdminGadgetSetting(java.lang.String bstrAdminGadgetSetting,
                           com.plumtree.openfoundation.util.XPDateTime vValue)

Sets a named Administrative setting for the Gadget, replacing any existing value for the setting.

Parameters:

bstrAdminGadgetSetting - the name of the setting to be set

vValue - the value of the setting

AddAdminGadgetSetting

void AddAdminGadgetSetting(java.lang.String bstrAdminGadgetSetting,
                           java.lang.Object vValue)

Sets a named Administrative setting for the Gadget, replacing any existing value for the setting.

Parameters:

bstrAdminGadgetSetting - the name of the setting to be set

vValue - the value of the setting

RemoveAdminGadgetSetting

void RemoveAdminGadgetSetting(java.lang.String bstrAdminGadgetSetting)

Remove the indicated Administrative setting for the Gadget.

Parameters:

bstrAdminGadgetSetting - the name of the setting to be removed

LookupAdminGadgetSettings

java.lang.Object[][] LookupAdminGadgetSettings(java.lang.String vsaSettings)

Retrieve the indicated Administrative setting for the Gadget. This is a convenience wrapper for the version of LookupAdminGadgetSettings that takes in a String[] argument.

Parameters:

vsaSettings - the name of the setting to be retrieved, or null to retrieve all settings

Returns:

a 2D array with 2 columns. The first column contains the name of the setting retrieved, and the second column contains the value of the setting, or null if the setting isn't found. The return value will include 1 row.

See Also:

(String[])

LookupAdminGadgetSettings

java.lang.Object[][] LookupAdminGadgetSettings(java.lang.String[] vsaSettings)

Retrieve the indicated Administrative setting for the Gadget.

Parameters:

vsaSettings - an array of strings containing the names of the settings to be retrieved, or null to retrieve all settings

Returns:

a 2D array with 2 columns. The first column contains the name of the setting retrieved, and the second column contains the value of the setting, or null if the setting isn't found. The return value will include 1 row for each item in the vsaSettings argument.

LookupAdminGadgetSettings

java.lang.Object[][] LookupAdminGadgetSettings(java.lang.Object vsaSettings)

Deprecated.

This function is similar to the functions with the same name that take in String and String[] arguments. Call those functions instead.