IPTDataSourceProvider overview
Public Instance Methods
 AttachToDocument | Attach to Document (requires that Initialize has been successfully called already) Takes the Document Location Information (where the Document is located inside the Repository) and the Accessor to be used (the ID of which is taken from the Document Type). Using this, the document is located, the Accessor is initialized (after doing a sanity check on Data Format) and the Fields are retrieved (and resolved). Attaches the DataSourceProvider to a specific Document in the Repository |
| DocumentSummary | Returns a suggested description field for this document if the Provider is equipped to deliver one. |
| GetCommonFields | Retrieve the common fields and descriptions for this Provider |
| GetDataSourceBrowserCLSID | Returns a unique identifier string used by the server to instantiate the browsing class for this provider |
| GetDataSourceCrawlProviderCLSID | Returns a unique identifier string used by the server to instantiate the crawling class for this provider |
| GetDataSourceProviderCLSID | Returns a unique idenifier string used by the server to instantiate the provider |
| GetDescription | Returns a human readable description for this Data Source Provider |
| GetDocumentImageUUID | Returns a String used to build the image URL for this card |
| GetDocumentSignature | Returns a provider specific string identifying the "state" of the attached document |
| GetDocumentTypeMapSections | This is used to retrieve a list of sections that should appear in the Document Type Map along with descriptions, etc. of the sections. See the PT_PROVIDER_DOC_TYPE_MAP_SECTIONS enumeration. |
| GetFields | Retrieves the fields from the document and repository The provider must have already been attached. |
| GetFileExtension | Returns the .extension for the attached document |
| GetGatewayClassID | Returns the Class ID used within the Click Thru URL |
| GetGatewayURL | Returns the click thru URL for the attached document using the gateway prefix |
| GetImageUUID | Returns the image string for this provider type. |
| GetName | Returns the human readable name of this Data Source Provider |
| GetSuggestedCardName | Returns the provider determined name for this document |
| GetSuggestedDocumentTypeMapEntries | SuggestedDocumentTypeMapEntries returns a SafeArray of suggested Document Type Map entries. For examples, the File provider might suggest that "*.txt" should be in the File section of the map. See the PT_SUGG_DOC_TYPE_MAP_ENTRIES_INDICES enumeration |
| Initialize | Initialization of a Data Source Provider requires Repository specific Information (passwd, logon, preferences, etc.) Initialization causes the DataSourceProvider to connect to the Repository in 5.0, client should pass in the WSID on the data source |
| QueryCapability | Allows for determination of Provider capabilities |
| Shutdown | Called by the server just before dispensing of the provider. This ensures connection and file resources are appropriately cleaned up after use. |
| SpecificDataSourceDescription | Retrieve a Data Source Provider specific description of the current configuration info |
| WriteIndexingFile | Copies the document stream of the attached document to the path provided |
See Also
IPTDataSourceProvider Interface | com.plumtree.server Namespace