Click or drag to resize

DocumentFinder Class

Service for searching and retrieving information about documents
Inheritance Hierarchy

Namespace:  FileHold.LibraryManager
Assembly:  FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.0.0.0
Syntax
C#
public class DocumentFinder : WebService

The DocumentFinder type exposes the following members.

Constructors
  NameDescription
Public methodDocumentFinder
Initializes a new instance of the DocumentFinder class
Top
Methods
  NameDescription
Public methodAddIdToSnapshot
Public methodCreateSnapshotAndPerformSearch(SearchCriteria, ColumnSelector, Database, DbTransaction)
Public methodCreateSnapshotAndPerformSearch(Principal, SearchCriteria, String, ColumnSelector, SearchLogEntry, Boolean, Database, DbTransaction)
Finds documents which fulfills specified search criteria and put them into snapshot table.
Public methodStatic memberCreateSystemFieldDefinition
Public methodDeleteSearchLog
Delete filtered logs
Public methodDisableVisibilityInUnindexedDocumentList
Disable document visibility in unindexed documents list
Public methodDisableVisibilityInUnindexedDocumentListAll
Disable all document visibility in unindexed documents list
Public methodFindDocumentInSnapshot
Find the index of a document with given ID in the snapshot.
Public methodFindDocumentInSnapshotHistory
Find the index of a document with given ID in the version history snapshot.
Public methodFindDocumentVersionInSnapshot
Public methodGetCalendarEntries
Get list of calendar entries for given period of time.
Public methodGetChangedMetadataFields(Int32, Database, DbTransaction)
Public methodGetChangedMetadataFields(Int32, Int32, Database, DbTransaction)
Public methodGetChangedMetadataFields(ColumnsWithValues, ColumnsWithValues, Database, DbTransaction)
Public methodStatic memberGetChoicesForMetadataVersion
Public methodGetColumnForDocuments(Int32, Int32)
Get given column value for each document.
Public methodGetColumnForDocuments(Int32, Int32, Database, DbTransaction)
Public methodGetDocumentDetails(Int32)
Returns detailed information about specified document version
Public methodGetDocumentDetails(Int32, Boolean, Boolean, Database, DbTransaction)
Public methodGetDocumentDetailsForFTS
Public methodGetDocumentDetailsForHistory
Public methodGetDocumentDetailsForSchema(Int32, Int32)
Returns detailed information about specified document version for particular schema
Public methodGetDocumentDetailsForSchema(Int32, Int32, Boolean, Database, DbTransaction)
Public methodGetDocumentDetailsForSchemaUsingCheckInMode
Public methodGetDocumentDetailsUsingCheckInMode
Public methodGetDocumentDetailsWithChanges
Returns information about specified document with changes made to each metadata version
Public methodGetDocumentExtension(Int32)
Returns file extension
Public methodGetDocumentExtension(Int32, Database, DbTransaction)
Public methodStatic memberGetDocumentNameAndSchemaId
Public methodGetDocumentsBySnapshot(Guid, Guid, String, SearchCriteria, ColumnSelector, Int32, Int32)
Finds documents which fulfills specified search criteria and retrieves a single page of data. This the main method in the API for finding documents in FileHold. It will use the specified criteria to get a list of documents. For efficiency, it will store the result set as a snapshot in the database and return a page of documents of the specified size starting from the specified row. If necessary, a previous snapshot id can be invalidated when a new one is created.
Public methodGetDocumentsBySnapshot(Guid, Guid, String, FieldDefinition, SearchCriteria, ColumnSelector, Int32, Int32)
Public methodGetDocumentsBySnapshot(Guid, Guid, String, FieldDefinition, SearchCriteria, ColumnSelector, Int32, Int32, SearchLogEntry, Database, DbTransaction)
Public methodGetDocumentsWithFields
Finds documents which fulfill specified search criteria using given array of field definitions.
Public methodGetDocumentSystemDetails(Int32)
Returns detailed system information about specified document metadata version
Public methodGetDocumentSystemDetails(Int32, Database, DbTransaction)
Public methodGetDownloadDocument
Public methodStatic memberGetDrilldownChoicesForMetadataVersion
Public methodGetFieldsForView
Returns collection of fields connected with specified view type
Public methodGetFtsErrorInfoCount
Returns count of FTS errors
Public methodGetFtsErrorList
Returns list of FTS errors
Public methodGetFtsErrorSubList
Returns sub list of FTS errors
Public methodGetFtsLastUpdateState
Get state of latest FTS index update
Public methodGetFtsScheduled
Get scheduled FTS action
Public methodGetFtsState
Return state of FTS
Public methodGetHostNameFromConfigFile
Public methodGetLastDocumentVersions
Get the last version number of each document.
Public methodGetLastMetadataVersionIdForDocumentId(Int32)
Returns metadata verson id of the latest document version based on document's id
Public methodGetLastMetadataVersionIdForDocumentId(Int32, Database, DbTransaction)
Public methodGetLastMetadataVersionIdForDocumentVersionId(Int32)
Public methodGetLastMetadataVersionIdForDocumentVersionId(Int32, Database, DbTransaction)
Public methodGetMergedDocuments
Returns merged metadata values of documents from specified selection
Public methodGetPreviousMetadataVersion
Public methodGetSchemaIdForDocument
Returns id of the schema that particular metadata version of a document is in
Public methodGetSchemaTypeForDocument(Int32)
Returns type of the schema that particular metadata version of a document is in
Public methodGetSchemaTypeForDocument(Int32, Database, DbTransaction)
Public methodGetSearchLog
Returns users searches
Public methodGetSearchLogDetails
Returns users searches
Public methodGetSearchTextResult
Returns html with file content from dtSearch containing highlighted strings from search query
Public methodGetSnapshotContent
Public methodGetSnapshotDocumentCount(Guid)
Returns number of documents in specified snapshot
Public methodGetSnapshotDocumentCount(Guid, Database, DbTransaction)
Public methodGetSpecificUnindexedDocumentsCount
Returns number of specific unindexed documents in the system (only latest versions), that logged in user can access
Public methodGetSpecificUnindexedDocumentsList
Public methodGetSpecificUnindexedDocumentsListSorted
Returns sorted list of specific unindexed documents in the system (only latest versions)
Public methodGetStringsForSearchTextResults
Public methodGetUnindexedDocuments
Public methodGetUnindexedDocumentsCount
Returns number of unindexed documents in the system (only latest versions), that logged in user can access
Public methodGetUnindexedDocumentsInformations
Public methodGetUnindexedDocumentsList
Returns list of unindexed documents in the system (only latest versions)
Public methodGetUsageLog
Returns information about usage of particular document(s) based on specified filter
Public methodGetUsageLogCount
Returns number of entries in usage log according to specified filter
Public methodGetUsageLogUsersList
Public methodGetUsageLogWithDetails
Returns information about usage of particular document(s) based on specified filter
Public methodGetUserViewFields(String)
Returns collection of fields connected with specified view type for current user
Public methodGetUserViewFields(String, Int32, Database, DbTransaction)
Public methodGetVersionsWithIds
Get a list of document versions of the given document.
Public methodIncludeArchiveInLinkedByMetadata
Check if archived documents need to be included in linked by metadata panel.
Public methodInitializeFtsIndex
Initializes FTS index
Public methodIsIndexedByFTS
Public methodLinkDocumentWithColumns(FieldDefinition, Int32, Database, DbTransaction)
Retrieves document's data for specified metadata version
Public methodLinkDocumentWithColumns(FieldDefinition, Int32, Boolean, Boolean, Database, DbTransaction)
Public methodLinkDocumentWithColumns(Principal, FieldDefinition, Int32, Boolean, Boolean, Database, DbTransaction)
Public methodLinkSnapshotWithColumns(DocumentFinderSnapshot, FieldDefinition, Int32, Int32, Database, DbTransaction)
Retrieves documents' metadata for specified snapshot and page
Public methodLinkSnapshotWithColumns(Principal, DocumentFinderSnapshot, FieldDefinition, Int32, Int32, SearchLogEntry, Database, DbTransaction)
Retrieves documents' metadata for specified snapshot and page
Public methodLoadSmartFolder(Int32)
Returns stored search criteria for specified smart folder id
Public methodLoadSmartFolder(Int32, Database, DbTransaction)
Public methodLoadUserSmartFolder
Returns stored search criteria for specified smart folder id which belongs to the specified user.
Public methodRemoveFromUnidexedDocumentList
Permamently removes from unindexed documents list
Public methodRemoveSnapshot
Removing snapshot
Public methodSaveSmartFolder
Saves search criteria for specified smart folder id
Public methodSaveUserSmartFolder
Saves search criteria for specified smart folder id which belongs to the specified user.
Public methodSetAllFtsErrorVisibilityState
Set visibility of All errors
Public methodSetFtsErrorVisibilityState
Set error visibility state
Public methodUpdateIdInAllUserSnapshots
Top
Extension Methods
See Also