com.plumtree.server
Interface IPTSearchMaintenance

All Superinterfaces:

IPTUnknown

public interface IPTSearchMaintenance
extends IPTUnknown

Version:

$Revision$

Author:

Stephen Chang

Method Summary

com.plumtree.openfoundation.util.IXPPropertyBag	GetSearchUpdateStatus(int lStatus) Generates a report on the search status of the Plumtree objects
int	GetSettingAsInt(int nSettingID) Retrieves an integer setting based on settingID
int	GetSettingAsInt(java.lang.String strSettingName) Retrieves an integer setting based on setting name
java.lang.Object	GetSettingAsObject(java.lang.Object vName) Retrieves an setting value based on setting name
com.plumtree.openfoundation.util.XPDateTime	GetSettingAsXPDateTime(int nSettingID) Retrieves a time setting based on settingID
com.plumtree.openfoundation.util.XPDateTime	GetSettingAsXPDateTime(java.lang.String strSettingName) Retrieves a time setting based on setting name
void	SetSetting(int nSettingID, int vValue) Sets an integer Setting based on Setting ID
void	SetSetting(int nSettingID, com.plumtree.openfoundation.util.XPDateTime vValue) Sets a time Setting based on Setting ID
void	SetSetting(java.lang.Object vName, java.lang.Object vValue) Sets a setting value
void	SetSetting(java.lang.String strSettingName, int vValue) Sets an integer Setting based on Setting Name
void	SetSetting(java.lang.String strSettingName, com.plumtree.openfoundation.util.XPDateTime vValue) Sets a time Value based on setting name

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

GetSettingAsInt

int GetSettingAsInt(int nSettingID)

Retrieves an integer setting based on settingID

Parameters:

nSettingID - Setting ID

Returns:

Setting Value

GetSettingAsInt

int GetSettingAsInt(java.lang.String strSettingName)

Retrieves an integer setting based on setting name

Parameters:

strSettingName - Setting Name

Returns:

Setting Value

GetSettingAsXPDateTime

com.plumtree.openfoundation.util.XPDateTime GetSettingAsXPDateTime(int nSettingID)

Retrieves a time setting based on settingID

Parameters:

nSettingID - Setting ID

Returns:

Setting Value

GetSettingAsXPDateTime

com.plumtree.openfoundation.util.XPDateTime GetSettingAsXPDateTime(java.lang.String strSettingName)

Retrieves a time setting based on setting name

Parameters:

strSettingName - Setting Name

Returns:

Setting Value

GetSettingAsObject

java.lang.Object GetSettingAsObject(java.lang.Object vName)

Retrieves an setting value based on setting name

Parameters:

vName - Setting ID or Setting Name

Returns:

Setting Value

SetSetting

void SetSetting(int nSettingID,
                int vValue)

Sets an integer Setting based on Setting ID

Parameters:

nSettingID - Setting ID

vValue - integer value

SetSetting

void SetSetting(java.lang.String strSettingName,
                int vValue)

Sets an integer Setting based on Setting Name

Parameters:

strSettingName - Setting Name

vValue - integer value

SetSetting

void SetSetting(int nSettingID,
                com.plumtree.openfoundation.util.XPDateTime vValue)

Sets a time Setting based on Setting ID

Parameters:

nSettingID - Setting ID

vValue - Time Value

SetSetting

void SetSetting(java.lang.String strSettingName,
                com.plumtree.openfoundation.util.XPDateTime vValue)

Sets a time Value based on setting name

Parameters:

strSettingName - Setting Name

vValue - Time Value

SetSetting

void SetSetting(java.lang.Object vName,
                java.lang.Object vValue)

Sets a setting value

Parameters:

vName - Setting ID or Setting Name

vValue - value as integer or XPDateTime

GetSearchUpdateStatus

com.plumtree.openfoundation.util.IXPPropertyBag GetSearchUpdateStatus(int lStatus)

Generates a report on the search status of the Plumtree objects

Parameters:

lStatus - Search Status of the objects being queried (0,1,3, or 4)

Returns:

Property Bag of number of objects with the given search status in each class