| |  | Aqualogic Interaction API | |
| | IPTDataSource Members
|
IPTDataSource overview
Public Instance Methods
 AttachDataSourceProvider | AttachDataSourceProvider Use this method to attach an instantiated Data Source Provider. For use by the specialized clients of the Data Source object (like the Crawler and Card Refresh Agent). Can be used to test the validity of a card's link. |
| DownloadDocument | Downloads a temporary copy of the source document for the given card |
| GetDataSourceBrowserCLSID | Returns a String used to identify the browsing object for the provider on which this Data Source is based. |
| GetDataSourceProvider | DataSourceProvider Use this method to get an instantiated Data Source Provider for this Data Source which has been Intialized using the RepositoryInfo bag. For use by the specialized clients of the Data Source object (like the Crawler and Card Refresh Agent) which use the option DataSourceProvider argument on the three methods above. |
| GetDataSourceProviderCLSID | Returns a String used to identify the provider object for this Data Source. |
| GetGeneratedURLPrefix | Retrieves a 4.x style URL prefix String |
| GetRepositoryInfo | Returns a provider specific format of configuration and connection parameters for this Data Source. |
| GetURLType | Returns the type of URL that is generated for opening documents for cards built on this Data Source. The value will map to one of the following settings: PT_URL_TYPES.PT_URL_TYPE_SIMPLE_FIELD_MAPPING = 0 PT_URL_TYPES.PT_URL_TYPE_DATASOURCE_GENERATED = 1 If the value is zero then the click thru URL will not be gatewayed and the "raw" URL will be used. |
| GetWebServiceID | Retrieves the Web Service ID from which this Data Source was based |
| ImportDocument | Overloaded. Import Document\u0009\u0009 Takes init info for the Data Source Provider, ID of the Document Type to use, and a fresh Card which will be populated with Properties, have its indexing file property set, and be given a Signature. Indexing will be done when the card is placed in the Catalog. The PropBagDocumentLocation is in a Data Source Provider specific format. The optional Summarize flag will, if set to TRUE, specify that the document should be summarized now, as opposed to waiting for the indexing which occurs when the card is stored. Asking the Data Source to do this extra work will slow down this call significantly and should only be done if it it is important to have the summary available for editing before the store. The optional DataSourceProvider argument allows the caller to pass in an instantiated and initialized Provider to be used in importing the document. In general this argument should be left NULL but some specialized clients of the DataSource (such as the Crawler object) may be able to use this argument to improve performance. |
| ImportDocumentEx | Overloaded. Same as ImportDocument only takes Document Type object in lieu of its ID |
| Initialize | Initializes newly created Data Source. This is only necessary if the Data Source object is being created for the first time (not pre-existing). |
| RefreshCard | Refreshes a Card's Properties and serializes the results May be called when a Card is due for automatic refresh or by a Content Admin. The Document Type referenced in the Card is the one used in refreshing. The optional argument specifies if the Card is to be refreshed regardless of whether the Card is marked dirty or the document has changed. If no argument is given, a refresh will be forced. Refresh involves accessing the original document, repopulating the Card with properties, updating the Document Signature, etc.\u0009 This function may fail if it is not possible to get a lock on the Card. If there are no problems getting the lock, than this function will store the Card to save the Refresh changes. If bForceRefresh is TRUE, then the Card will always be Refreshed. If bForceRefresh is FALSE, then the Signature of the Card and Document will be compared, with the Card being Refreshed only if the Signatures are different. |
| RefreshCardInMemory | RefreshCardInMemory Similar method but takes an instantiated Card, which must be already locked. Upon return of this function, the Card must be stored in order for the effects of the Refresh to be saved. (So cancel functionality on Refresh can be implemented usingn this method.) If bForceRefresh is TRUE, then the Card will always be Refreshed. If bForceRefresh is FALSE, then the Signature of the Card and Document will be compared, with the Card being Refreshed only if the Signatures are different. The optional Summarize flag will, if set to TRUE, specify that the document should be summarized now, as opposed to waiting for the indexing which occurs when the card is stored. Asking the Data Source to do this extra work will slow down this call significantly and should only be done if it it is important to have the summary available for editing before the store. The use of the optional DataSourceProvider argument is identical to that described in ImportDocument, above. |
| SetGeneratedURLPrefix | Sets a 4.x style URL prefix String |
| SetRepositoryInfo | Overloaded. Sets a provider specific format of configuration and connection parameters for this Data Source. |
| SetURLType | Sets the type of URL that is generated for opening documents for cards built on this Data Source. The value must map to one of the following settings: PT_URL_TYPES.PT_URL_TYPE_SIMPLE_FIELD_MAPPING = 0 PT_URL_TYPES.PT_URL_TYPE_DATASOURCE_GENERATED = 1 If the value is zero then the click thru URL will not be gatewayed and the "raw" URL will be used. |
| SetWebServiceID | Sets the Web Service ID from which this Data Source was based |
See Also
IPTDataSource Interface | com.plumtree.server Namespace