|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTServerConfigSettings
The IPTServerConfigSettings interface is used to set and retrieve global Plumtree
Server settings.
The settings are stored in the database, and thus accessible
to all instances of Plumtree that share the same database (i.e. the settings
are available to every instance of Plumtree within a single install.)
Changes to settings generally do not take effect until the Plumtree
process has been restarted- Plumtree does not have a facility to notice
that global settings have been reset in the database, and that in-memory
copies of those settings should be updated.
Settings are identified by unique integers. The known setting IDs are
enumerated in the PT_SERVER_CONFIG_SETTINGNAME
class.
PT_SERVER_CONFIG_SETTINGNAME
Method Summary | |
---|---|
double |
GetSettingAsDouble(int iSettingID)
Returns the specified global Plumtree setting as a double. |
int |
GetSettingAsInt(int iSettingID)
Returns the specified global Plumtree setting as an int. |
java.lang.Object |
GetSettingAsObject(int iSettingID)
Returns the specified global Plumtree setting as an Object. |
java.lang.String |
GetSettingAsString(int iSettingID)
Returns the specified global Plumtree setting as a String. |
com.plumtree.openfoundation.util.XPDateTime |
GetSettingAsXPDateTime(int iSettingID)
Returns the specified global Plumtree setting as a XPDateTime. |
java.lang.Object[][] |
GetSettings(int iSettingID)
Deprecated. |
java.lang.Object[][] |
GetSettings(int[] iaSettingIDs)
Retrieves multiple global Plumtree settings in a single call. |
void |
SetSetting(int iSettingID,
double dblValue)
Sets the specified global Plumtree setting. |
void |
SetSetting(int iSettingID,
int iValue)
Sets the specified global Plumtree setting. |
void |
SetSetting(int iSettingID,
java.lang.Object objValue)
Sets the specified global Plumtree setting. |
void |
SetSetting(int iSettingID,
java.lang.String sValue)
Sets the specified global Plumtree setting. |
void |
SetSetting(int iSettingID,
com.plumtree.openfoundation.util.XPDateTime dtValue)
Sets the specified global Plumtree setting. |
Method Detail |
---|
int GetSettingAsInt(int iSettingID)
iSettingID
- is the ID of the setting to return.
See PT_SERVER_CONFIG_SETTINGNAME
for allowed values.
java.lang.String GetSettingAsString(int iSettingID)
iSettingID
- is the ID of the setting to return.
See PT_SERVER_CONFIG_SETTINGNAME
for allowed values.
com.plumtree.openfoundation.util.XPDateTime GetSettingAsXPDateTime(int iSettingID)
iSettingID
- is the ID of the setting to return.
See PT_SERVER_CONFIG_SETTINGNAME
for allowed values.
double GetSettingAsDouble(int iSettingID)
iSettingID
- is the ID of the setting to return.
See PT_SERVER_CONFIG_SETTINGNAME
for allowed values.
java.lang.Object GetSettingAsObject(int iSettingID)
iSettingID
- is the ID of the setting to return.
See PT_SERVER_CONFIG_SETTINGNAME
for allowed values.
void SetSetting(int iSettingID, int iValue)
iSettingID
- is the ID of the setting to set.
See PT_SERVER_CONFIG_SETTINGNAME
for allowed values.iValue
- is the value which the setting should have.void SetSetting(int iSettingID, java.lang.String sValue)
iSettingID
- is the ID of the setting to set.
See PT_SERVER_CONFIG_SETTINGNAME
for allowed values.sValue
- is the value which the setting should have.void SetSetting(int iSettingID, com.plumtree.openfoundation.util.XPDateTime dtValue)
iSettingID
- is the ID of the setting to set.
See PT_SERVER_CONFIG_SETTINGNAME
for allowed values.dtValue
- is the value which the setting should have.void SetSetting(int iSettingID, double dblValue)
iSettingID
- is the ID of the setting to set.
See PT_SERVER_CONFIG_SETTINGNAME
for allowed values.dblValue
- is the value which the setting should have.void SetSetting(int iSettingID, java.lang.Object objValue)
iSettingID
- is the ID of the setting to set.
See PT_SERVER_CONFIG_SETTINGNAME
for allowed values.objValue
- is the value which the setting should have.java.lang.Object[][] GetSettings(int iSettingID)
iSettingID
- is the ID of the setting to return.
See PT_SERVER_CONFIG_SETTINGNAME
for allowed values.
PT_SERVER_CONFIG_SETTINGNAME
,
and the 1st column contains the value for that setting.java.lang.Object[][] GetSettings(int[] iaSettingIDs)
iaSettingIDs
- is a 1D int array of the setting to return.
See PT_SERVER_CONFIG_SETTINGNAME
for allowed values.
PT_SERVER_CONFIG_SETTINGNAME
,
and the 1st column contains the value for that setting.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |