 | Aqualogic Interaction API | ||
IPTAccessor Members | |||
| Aqualogic Interaction API | ||
IPTAccessor Members | |||
 AttachToDocument | Attaches this Accessor to the document identified by information in the PropertyBag |
| DocumentSummary | Returns a human readable summary of the document |
| GetAccessorCLSID | Returns the CLSID associated with this accessor |
| GetCommonFields | Returns names and descriptions of fields that are commonly returned from GetFields, for use in a mapping UI. The columns correspond to PT_FIELDARRAY_INDICES values. |
| GetDescription | Returns a description of this Accessor |
| GetDocumentImageUUID | Returns the UUID for the image that should be used to represent the document in the UI |
| GetDocumentLocationFormatID | Each Accessor knows how to deal with a particular format of document (for example, some Accessors parse files, while others know how to extract metadata from Lotus Notes.) This identifier documents the type of document that this Accessor knows how to deal with. |
| GetFields | Returns a 2D array containing the metadata found in the document. The first column contains the name of the field, as a string. The second column contains the value of the field. This matrix is row-major: name = fields[row][0] value = fields[row][1] |
| GetFileExtension | Returns the file extension (e.g. "xls" for Excel files) to be used when writing the indexing file |
| GetImageUUID | Returns the UUID for the image that's used to represent this Accessor in the UI |
| GetName | Returns the name of this Accessor |
| GetSuggestedCardName | Returns a suggested name for the Card to be made, which is typically generated from a field in the document |
| GetSuggestedDocumentTypeMapEntries | Returns suggested entries for the Document Type Map. This should only be called by the installer. |
| GetURLInfo | Returns additional URL info that helps the UI perform clickthrough on the document |
| QueryCapability | Used to determine if the Accessor supports certain operations. Pass in a value from PT_ACCESSOR_CAPABILITIES |
| WriteIndexingFile | Writes an indexing file to the specified path. Typically, this copies the file to the indicated location, but some Accessors may write a "custom" indexing file which contains more or less information than that contained in the original document. |
IPTAccessor Interface | com.plumtree.server Namespace | IPTDataSourceProvider