|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTDataSourceProvider
Method Summary | |
---|---|
void |
AttachToDocument(com.plumtree.openfoundation.util.IXPPropertyBag pBagDocumentLocation,
java.lang.String AccessorID)
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). |
java.lang.String |
DocumentSummary()
Returns a suggested description field for this document if the Provider is equipped to deliver one. |
java.lang.Object[][] |
GetCommonFields()
Retrieve the common fields and descriptions for this Provider |
java.lang.String |
GetDataSourceBrowserCLSID()
Returns a unique identifier string used by the server to instantiate the browsing class for this provider |
java.lang.String |
GetDataSourceCrawlProviderCLSID()
Returns a unique identifier string used by the server to instantiate the crawling class for this provider |
java.lang.String |
GetDataSourceProviderCLSID()
Returns a unique idenifier string used by the server to instantiate the provider |
java.lang.String |
GetDescription()
Returns a human readable description for this Data Source Provider |
java.lang.String |
GetDocumentImageUUID()
Returns a String used to build the image URL for this card |
java.lang.String |
GetDocumentSignature()
Returns a provider specific string identifying the "state" of the attached document |
java.lang.Object[][] |
GetDocumentTypeMapSections()
This is used to retrieve a list of sections that should appear in the Document Type Map along with descriptions, etc. |
java.lang.Object[][] |
GetFields()
Retrieves the fields from the document and repository The provider must have already been attached. |
java.lang.String |
GetFileExtension()
Returns the .extension for the attached document |
int |
GetGatewayClassID()
Returns the Class ID used within the Click Thru URL |
java.lang.String |
GetGatewayURL()
Returns the click thru URL for the attached document using the gateway prefix |
java.lang.String |
GetImageUUID()
Returns the image string for this provider type. |
java.lang.String |
GetName()
Returns the human readable name of this Data Source Provider |
java.lang.String |
GetSuggestedCardName()
Returns the provider determined name for this document |
java.lang.Object[][] |
GetSuggestedDocumentTypeMapEntries()
SuggestedDocumentTypeMapEntries returns a SafeArray of suggested Document Type Map entries. |
void |
Initialize(com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo,
IPTSession pSession,
int lWebServiceID)
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 |
int |
QueryCapability(int QueryCapability)
Allows for determination of Provider capabilities |
void |
Shutdown()
Called by the server just before dispensing of the provider. |
java.lang.String |
SpecificDataSourceDescription(com.plumtree.openfoundation.util.IXPPropertyBag pbagConfigurationInfo)
Retrieve a Data Source Provider specific description of the current configuration info |
void |
WriteIndexingFile(java.lang.String bstrFullFilePath)
Copies the document stream of the attached document to the path provided |
Method Detail |
---|
void Initialize(com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo, IPTSession pSession, int lWebServiceID)
pBagRepositoryInfo
- Provider specific repository connection parameterspSession
- a Plumtree user sessionlWebServiceID
- The Web Service ID for this providervoid AttachToDocument(com.plumtree.openfoundation.util.IXPPropertyBag pBagDocumentLocation, java.lang.String AccessorID)
pBagDocumentLocation
- a Provider specific document node property bagAccessorID
- a String identifying the appropriate accessor to be used for this documentjava.lang.String SpecificDataSourceDescription(com.plumtree.openfoundation.util.IXPPropertyBag pbagConfigurationInfo)
pbagConfigurationInfo
- A property bag containing the Data Source configuration info
java.lang.Object[][] GetFields()
java.lang.String GetSuggestedCardName()
java.lang.String DocumentSummary()
java.lang.String GetDocumentSignature()
java.lang.String GetDocumentImageUUID()
java.lang.String GetFileExtension()
void WriteIndexingFile(java.lang.String bstrFullFilePath)
bstrFullFilePath
- The path to which a copy of the document will be madejava.lang.String GetGatewayURL()
int GetGatewayClassID()
java.lang.String GetName()
java.lang.String GetDescription()
java.lang.String GetDataSourceProviderCLSID()
java.lang.String GetDataSourceBrowserCLSID()
java.lang.String GetDataSourceCrawlProviderCLSID()
int QueryCapability(int QueryCapability)
QueryCapability
- a PT_DSPROVIDER_CAPABILITIES type
java.lang.Object[][] GetCommonFields()
java.lang.String GetImageUUID()
java.lang.Object[][] GetDocumentTypeMapSections()
java.lang.Object[][] GetSuggestedDocumentTypeMapEntries()
void Shutdown()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |