|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
| Method Summary | |
int |
GetCardSettingsAsInt(int lSettingID)
Get the value stored for a particular card setting identified by one of the PT_CARD_SETTINGS values. |
java.lang.Object |
GetCardSettingsAsObject(int lSettingID)
Get the value stored for a particular card setting identified by one of the PT_CARD_SETTINGS values. |
java.lang.Object[] |
GetCardSettingsAsObject1DArray(int lSettingID)
Get the value stored for a particular card setting identified by one of the PT_CARD_SETTINGS values. |
java.lang.String |
GetCardSettingsAsString(int lSettingID)
Get the value stored for a particular card setting identified by one of the PT_CARD_SETTINGS values. |
java.lang.String |
GetContentLanguage()
Retrieve the language code used for indexing text associated with the underlying document. |
int |
GetCrawlerID()
Retrieve the ID of the crawler that originally imported this card. |
java.lang.String |
GetCrawlerTag()
Returns the value of the CrawlerTag property. |
int |
GetDataSourceID()
Identifies the unique ID of the Data Source on which this card relies for click-thru and refresh activity. |
com.plumtree.openfoundation.util.IXPPropertyBag |
GetDocumentLocation()
Returns an XML specification of the unique location and Provider format for the document represented by this card. |
java.lang.String |
GetDocumentSignature()
Returns the Provider generated string used to determine whether a card's document has changed. |
int |
GetDocumentTypeID()
Passes back the ID of the Document Type for the card. |
java.lang.String |
GetDocumentURL()
Reveals the click-thru URL for the document identified by this card. |
IPTTempfile |
GetIndexFile()
Creates an IPTTempfile object corresponding to an empty file which can subsequently be used as the target for copying the document stream. |
IPTCardPropertyValues |
GetPropertyValues()
Extracts the collection of properties defined for this card. |
void |
Refresh(boolean bSummarize,
boolean bForceRefresh)
Conducts a complete refresh of a card's properties by revisiting the source document and re-collecting mappable data. |
void |
SetCardSettings(int Value,
int pvValue)
Set the value for a particular card setting identified by one of the PT_CARD_SETTINGS values. |
void |
SetCardSettings(int Value,
int[] pvValue)
Set the value for a particular card setting identified by one of the PT_CARD_SETTINGS values. |
void |
SetCardSettings(int Value,
java.lang.String pvValue)
Set the value for a particular card setting identified by one of the PT_CARD_SETTINGS values. |
void |
SetContentLanguage(java.lang.String Value)
Set the language code used for indexing text associated with the underlying document. |
void |
SetCrawlerID(int Value)
Sets the ID of this card's crawler. |
void |
SetCrawlerTag(java.lang.String Value)
Sets the value of the CrawlerTag property. |
void |
SetDataSourceID(int Value)
Designates the Data Source to be used for capturing data for this card's document |
void |
SetDocumentLocation(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Set the document location, Provider format, Document Type Map section, and necessary Provider document parameters for this card. |
void |
SetDocumentLocation(java.lang.String Value)
Set the document location, Provider format, Document Type Map section, and necessary Provider document parameters for this card. |
void |
SetDocumentSignature(java.lang.String Value)
Sets the Provider generated string used to determine whether a card's document has changed. |
void |
SetDocumentTypeID(int Value)
Sets the ID of the Document Type used for this card. |
void |
SetDocumentURL(java.lang.String Value)
Sets the click-thru URL for the document identified by this card. |
| Methods inherited from interface com.plumtree.server.IPTObject |
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified |
| Methods inherited from interface com.plumtree.server.IPTLocalizable |
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang |
| Methods inherited from interface com.plumtree.server.IPTUnknown |
GetInterfaces |
| Method Detail |
public IPTCardPropertyValues GetPropertyValues()
public int GetDataSourceID()
public void SetDataSourceID(int Value)
Value - The ID for this card's Data Source.public int GetCrawlerID()
public void SetCrawlerID(int Value)
Value - The ID of the crawler creating this card.public com.plumtree.openfoundation.util.IXPPropertyBag GetDocumentLocation()
public void SetDocumentLocation(java.lang.String Value)
Value - String version of property bag content, identifying source document location.public void SetDocumentLocation(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Value - Property bag identifying source document location.public java.lang.String GetDocumentURL()
public void SetDocumentURL(java.lang.String Value)
Value - An URL for opening the documentpublic int GetDocumentTypeID()
public void SetDocumentTypeID(int Value)
Value - Document Type ID
public void Refresh(boolean bSummarize,
boolean bForceRefresh)
bSummarize - Regenerate card description if true.bForceRefresh - Perform action even irrespective of document state.public java.lang.String GetDocumentSignature()
public void SetDocumentSignature(java.lang.String Value)
Value - A provider specific identifier for document state.public IPTTempfile GetIndexFile()
public int GetCardSettingsAsInt(int lSettingID)
lSettingID - One of the integer members specified in the PT_CARD_SETTINGS classpublic java.lang.String GetCardSettingsAsString(int lSettingID)
lSettingID - One of the integer members specified in the PT_CARD_SETTINGS classpublic java.lang.Object[] GetCardSettingsAsObject1DArray(int lSettingID)
lSettingID - One of the integer members specified in the PT_CARD_SETTINGS classpublic java.lang.Object GetCardSettingsAsObject(int lSettingID)
lSettingID - One of the integer members specified in the PT_CARD_SETTINGS class
public void SetCardSettings(int Value,
int pvValue)
Value - One of the integer members specified in the PT_CARD_SETTINGS classpvValue - Value stored for desired setting.
public void SetCardSettings(int Value,
java.lang.String pvValue)
Value - One of the integer members specified in the PT_CARD_SETTINGS classpvValue - Value stored for desired setting.
public void SetCardSettings(int Value,
int[] pvValue)
Value - One of the integer members specified in the PT_CARD_SETTINGS classpvValue - Value stored for desired setting.public java.lang.String GetContentLanguage()
public void SetContentLanguage(java.lang.String Value)
public java.lang.String GetCrawlerTag()
public void SetCrawlerTag(java.lang.String Value)
A - string provided by a configurable crawler parameter.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||