Aqualogic Interaction API  
 

IPTCard Members

IPTCard overview

Public Instance Methods

GetCardSettingsAsInt Get the value stored for a particular card setting identified by one of the PT_CARD_SETTINGS values. These settings govern various aspects of card storage behavior.
GetCardSettingsAsObject Get the value stored for a particular card setting identified by one of the PT_CARD_SETTINGS values. These settings govern various aspects of card storage behavior.
GetCardSettingsAsObject1DArray Get the value stored for a particular card setting identified by one of the PT_CARD_SETTINGS values. These settings govern various aspects of card storage behavior.
GetCardSettingsAsString Get the value stored for a particular card setting identified by one of the PT_CARD_SETTINGS values. These settings govern various aspects of card storage behavior.
GetContentLanguage Retrieve the language code used for indexing text associated with the underlying document.
GetCrawlerID Retrieve the ID of the crawler that originally imported this card. The crawler corresponding to this ID is not guaranteed to exist and a return value of zero indicates a manually submitted card (no crawler).
GetCrawlerTag Returns the value of the CrawlerTag property. This value is seeded by the card's crawler and is intended to provide a searchable value for purposes of identifying all cards brought in by a particular crawler.
GetDataSourceID Identifies the unique ID of the Data Source on which this card relies for click-thru and refresh activity.
GetDocumentLocation Returns an XML specification of the unique location and Provider format for the document represented by this card. The source URL can be retrieved from the returned property bag by reading the string value stored for the name 'PTC_UNIQUE'
GetDocumentSignature Returns the Provider generated string used to determine whether a card's document has changed.
GetDocumentTypeID Passes back the ID of the Document Type for the card. A Document Type serves as a template of properties and mapping designations used by the Data Source in collecting and assigning data from the source document.
GetDocumentURL Reveals the click-thru URL for the document identified by this card.
GetIndexFile Creates an IPTTempfile object corresponding to an empty file which can subsequently be used as the target for copying the document stream.
GetPropertyValues Extracts the collection of properties defined for this card. The returned object is used to add or modify a card's list of properties.
getUserAssignedMetadata Get a reference to the hashtable that represents metadata directly assigned to the card. This metadata will be merged with the metadata derived from datasources and file accessors to create the list of card properties. For more info see PTDataSource.PutCardProperties() method
Refresh Conducts a complete refresh of a card's properties by revisiting the source document and re-collecting mappable data. This call does not imply a serialization of new data. It is an in memory refresh. If the summarization parameter is passed as true, the card's description will be regenerated from the source document. If the bForceRefresh parameter is passed as true, the refresh activity will be done irrespective of whether the source document has changed.
SetCardSettingsOverloaded. Set the value for a particular card setting identified by one of the PT_CARD_SETTINGS values. These settings govern various aspects of card storage behavior.
SetContentLanguage Set the language code used for indexing text associated with the underlying document.
SetCrawlerID Sets the ID of this card's crawler. Method is used by the crawling agent and cannot be overriden once set.
SetCrawlerTag Sets the value of the CrawlerTag property. This value is seeded by the card's crawler and is intended to provide a searchable value for purposes of identifying all cards brought in by a particular crawler.
SetDataSourceID Designates the Data Source to be used for capturing data for this card's document
SetDocumentLocationOverloaded. Set the document location, Provider format, Document Type Map section, and necessary Provider document parameters for this card. These values should only be set once upon creation of the card. The values passed in this property bag uniquely identify the document for this card.
SetDocumentSignature Sets the Provider generated string used to determine whether a card's document has changed. A card's Data Source will set this value when the document is originally imported or refreshed.
SetDocumentTypeID Sets the ID of the Document Type used for this card. A Document Type serves as a template of properties and mapping designations used by the Data Source in collecting and assigning data from the source document.
SetDocumentURL Sets the click-thru URL for the document identified by this card.
setUserAssignedMetadata 

See Also

IPTCard Interface | com.plumtree.server Namespace