com.plumtree.server
Interface IPTCardRefreshInfo

All Superinterfaces:

IPTUnknown

public interface IPTCardRefreshInfo
extends IPTUnknown

Version:

$Revision$

Author:

Stephen Chang

Method Summary

java.lang.Object	GetCardExpirationDateAsObject() Retrieves the date at which this Card is scheduled to expire
com.plumtree.openfoundation.util.XPDateTime	GetCardExpirationDateAsXPDateTime() Retrieves the date at which this Card is scheduled to expire
com.plumtree.openfoundation.util.XPDateTime	GetCardLastRefreshedDate() Returns the last time the Card was refreshed.
void	GetCardMissingDocumentDeletionDelay(java.lang.Object plTimeUnits, java.lang.Object plNumber) Deprecated.
int	GetCardMissingDocumentDeletionDelayUnits() Retrieves the type of interval units at which the Card kept alive after it is found to be missing.
int	GetCardMissingDocumentDeletionDelayValue() Retrieves the number of interval units at which the Card kept alive after it is found to be missing.
java.lang.Object	GetCardNextRefreshDateAsObject() Returns the next time the Card is scheduled to be refreshed.
com.plumtree.openfoundation.util.XPDateTime	GetCardNextRefreshDateAsXPDateTime() Returns the next time the Card is scheduled to be refreshed.
void	GetCardRefreshRate(java.lang.Object plTimeUnits, java.lang.Object plNumber) Deprecated.
int	GetCardRefreshRateUnits() Retrieves the type of interval units at which the Card is refreshed
int	GetCardRefreshRateValue() Retrieves the number of interval units at which the Card is refreshed
java.lang.Object	GetCardRefreshSetting(int lRefreshSetting) Retrieves the Card Refresh setting interval for a specified setting.
boolean	GetCheckLinkOnly() Returns whether the verification of existence of the Card is enough or whether the Card Refresh Agent actually needs to check whether content has changed.
void	SetCardExpirationDate(java.lang.Object Value) Sets the date at which this Card is scheduled to expire
void	SetCardExpirationDate(com.plumtree.openfoundation.util.XPDateTime Value) Sets the date at which this Card is scheduled to expire
void	SetCardLastRefreshedDate(com.plumtree.openfoundation.util.XPDateTime Value) Sets the last time the Card was refreshed.
void	SetCardMissingDocumentDeletionDelay(int lTimeUnits, int lNumber) Sets the interval after which a missing Card is allowed to live
void	SetCardNextRefreshDate(java.lang.Object Value) Sets the next time the Card is scheduled to be refreshed.
void	SetCardNextRefreshDate(com.plumtree.openfoundation.util.XPDateTime Value) Sets the next time the Card is scheduled to be refreshed.
void	SetCardRefreshRate(int lTimeUnits, int lNumber) Sets the interval between Card Refresh.
void	SetCheckLinkOnly(boolean Value) Sets whether the verification of existence of the Card is enough or whether the Card Refresh Agent actually needs to check whether content has changed.

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

GetCardLastRefreshedDate

com.plumtree.openfoundation.util.XPDateTime GetCardLastRefreshedDate()

Returns the last time the Card was refreshed.

Returns:

Last Refresh Date.

SetCardLastRefreshedDate

void SetCardLastRefreshedDate(com.plumtree.openfoundation.util.XPDateTime Value)

Sets the last time the Card was refreshed.

Parameters:

Value - Last Refresh Date

GetCardNextRefreshDateAsXPDateTime

com.plumtree.openfoundation.util.XPDateTime GetCardNextRefreshDateAsXPDateTime()

Returns the next time the Card is scheduled to be refreshed.

Returns:

Next Refresh Date

GetCardNextRefreshDateAsObject

java.lang.Object GetCardNextRefreshDateAsObject()

Returns the next time the Card is scheduled to be refreshed.

Returns:

Next Refresh Date

SetCardNextRefreshDate

void SetCardNextRefreshDate(com.plumtree.openfoundation.util.XPDateTime Value)

Sets the next time the Card is scheduled to be refreshed.

Parameters:

Value - Next Refresh Date

SetCardNextRefreshDate

void SetCardNextRefreshDate(java.lang.Object Value)

Sets the next time the Card is scheduled to be refreshed.

Parameters:

Value - Next Refresh Date

GetCardRefreshRate

void GetCardRefreshRate(java.lang.Object plTimeUnits,
                        java.lang.Object plNumber)

Deprecated.

Retrieves the interval between Card Refresh.

Parameters:

plTimeUnits - type of time units

plNumber - number of time units

SetCardRefreshRate

void SetCardRefreshRate(int lTimeUnits,
                        int lNumber)

Sets the interval between Card Refresh.

Parameters:

lTimeUnits - type of time units

lNumber - number of time units

GetCardMissingDocumentDeletionDelay

void GetCardMissingDocumentDeletionDelay(java.lang.Object plTimeUnits,
                                         java.lang.Object plNumber)

Deprecated.

Retrieves the interval after which a missing Card is allowed to live

Parameters:

plTimeUnits - type of time units

plNumber - number of time units

SetCardMissingDocumentDeletionDelay

void SetCardMissingDocumentDeletionDelay(int lTimeUnits,
                                         int lNumber)

Sets the interval after which a missing Card is allowed to live

Parameters:

lTimeUnits - type of time units

lNumber - number of time units

GetCardRefreshSetting

java.lang.Object GetCardRefreshSetting(int lRefreshSetting)

Retrieves the Card Refresh setting interval for a specified setting.

Parameters:

lRefreshSetting - type of setting to retrieve of type PT_CARDREFRESHSETTING

Returns:

2 element array consisting of the unit type and the number of units

GetCardExpirationDateAsXPDateTime

com.plumtree.openfoundation.util.XPDateTime GetCardExpirationDateAsXPDateTime()

Retrieves the date at which this Card is scheduled to expire

Returns:

Expiration Date

GetCardExpirationDateAsObject

java.lang.Object GetCardExpirationDateAsObject()

Retrieves the date at which this Card is scheduled to expire

Returns:

Expiration Date

SetCardExpirationDate

void SetCardExpirationDate(com.plumtree.openfoundation.util.XPDateTime Value)

Sets the date at which this Card is scheduled to expire

Parameters:

Value - Expiration Date

SetCardExpirationDate

void SetCardExpirationDate(java.lang.Object Value)

Sets the date at which this Card is scheduled to expire

Parameters:

Value - Expiration Date

GetCheckLinkOnly

boolean GetCheckLinkOnly()

Returns whether the verification of existence of the Card is enough or whether the Card Refresh Agent actually needs to check whether content has changed.

Returns:

whether or not to just verify the Card Link

SetCheckLinkOnly

void SetCheckLinkOnly(boolean Value)

Sets whether the verification of existence of the Card is enough or whether the Card Refresh Agent actually needs to check whether content has changed.

Parameters:

Value - boolean representing whether it is enough to just verify the Card Link.

GetCardRefreshRateUnits

int GetCardRefreshRateUnits()

Retrieves the type of interval units at which the Card is refreshed

Returns:

Refresh Rate Units

GetCardRefreshRateValue

int GetCardRefreshRateValue()

Retrieves the number of interval units at which the Card is refreshed

Returns:

Refresh Rate Value

GetCardMissingDocumentDeletionDelayUnits

int GetCardMissingDocumentDeletionDelayUnits()

Retrieves the type of interval units at which the Card kept alive after it is found to be missing.

Returns:

Missing Document Deletion Delay Units

GetCardMissingDocumentDeletionDelayValue

int GetCardMissingDocumentDeletionDelayValue()

Retrieves the number of interval units at which the Card kept alive after it is found to be missing.

Returns:

Missing Document Deletion Delay Value