com.plumtree.server
Interface IPTCardRefreshInfo

All Superinterfaces:
IPTUnknown

public interface IPTCardRefreshInfo
extends IPTUnknown


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

public com.plumtree.openfoundation.util.XPDateTime GetCardLastRefreshedDate()
Returns the last time the Card was refreshed.
Returns:
Last Refresh Date.

SetCardLastRefreshedDate

public void SetCardLastRefreshedDate(com.plumtree.openfoundation.util.XPDateTime Value)
Sets the last time the Card was refreshed.
Parameters:
Value - Last Refresh Date

GetCardNextRefreshDateAsXPDateTime

public com.plumtree.openfoundation.util.XPDateTime GetCardNextRefreshDateAsXPDateTime()
Returns the next time the Card is scheduled to be refreshed.
Returns:
Next Refresh Date

GetCardNextRefreshDateAsObject

public java.lang.Object GetCardNextRefreshDateAsObject()
Returns the next time the Card is scheduled to be refreshed.
Returns:
Next Refresh Date

SetCardNextRefreshDate

public 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

public void SetCardNextRefreshDate(java.lang.Object Value)
Sets the next time the Card is scheduled to be refreshed.
Parameters:
Value - Next Refresh Date

GetCardRefreshRate

public 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

public void SetCardRefreshRate(int lTimeUnits,
                               int lNumber)
Sets the interval between Card Refresh.
Parameters:
lTimeUnits - type of time units
lNumber - number of time units

GetCardMissingDocumentDeletionDelay

public 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

public 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

public 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

public com.plumtree.openfoundation.util.XPDateTime GetCardExpirationDateAsXPDateTime()
Retrieves the date at which this Card is scheduled to expire
Returns:
Expiration Date

GetCardExpirationDateAsObject

public java.lang.Object GetCardExpirationDateAsObject()
Retrieves the date at which this Card is scheduled to expire
Returns:
Expiration Date

SetCardExpirationDate

public void SetCardExpirationDate(com.plumtree.openfoundation.util.XPDateTime Value)
Sets the date at which this Card is scheduled to expire
Parameters:
Value - Expiration Date

SetCardExpirationDate

public void SetCardExpirationDate(java.lang.Object Value)
Sets the date at which this Card is scheduled to expire
Parameters:
Value - Expiration Date

GetCheckLinkOnly

public 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

public 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

public int GetCardRefreshRateUnits()
Retrieves the type of interval units at which the Card is refreshed
Returns:
Refresh Rate Units

GetCardRefreshRateValue

public int GetCardRefreshRateValue()
Retrieves the number of interval units at which the Card is refreshed
Returns:
Refresh Rate Value

GetCardMissingDocumentDeletionDelayUnits

public 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

public 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


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.