DocumentFinder Class

Service for searching and retrieving information about documents

Definition

Namespace: FileHold.LibraryManager
Assembly: FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.1.0.0
C#
[WebServiceAttribute(Namespace = "http://filehold.com/librarymanager/documentfinder/")]
[WebServiceBindingAttribute(ConformsTo = WsiProfiles.BasicProfile1_1)]
public class DocumentFinder : WebService
Inheritance
Object    MarshalByValueComponent    WebService    DocumentFinder

Constructors

DocumentFinderInitializes a new instance of the DocumentFinder class

Methods

AddIdToSnapshot 
CreateSnapshotAndPerformSearch(SearchCriteria, ColumnSelector, Database, DbTransaction) 
CreateSnapshotAndPerformSearch(Principal, SearchCriteria, String, ColumnSelector, SearchLogEntry, Boolean, Database, DbTransaction, Boolean) Finds documents which fulfills specified search criteria and put them into snapshot table. For use with application server plug-ins only.
CreateSystemFieldDefinition 
DeleteSearchLog Delete filtered logs
DisableVisibilityInUnindexedDocumentList Disable document visibility in unindexed documents list
DisableVisibilityInUnindexedDocumentListAll Disable all document visibility in unindexed documents list
FindDocumentInSnapshot Find the index of a document with given ID in the snapshot.
FindDocumentInSnapshotHistory Find the index of a document with given ID in the version history snapshot.
FindDocumentVersionInSnapshot Find the index of a document with given version ID in the snapshot.
GetCalendarEntries Get list of calendar entries for given period of time.
GetChangedMetadataFields(Int32, Database, DbTransaction) 
GetChangedMetadataFields(ColumnsWithValues, ColumnsWithValues, Database, DbTransaction) 
GetChangedMetadataFields(Int32, Int32, Database, DbTransaction) 
GetChoicesForMetadataVersion 
GetColumnForDocuments(Int32, Int32) Get given column value for each document.
GetColumnForDocuments(Int32, Int32, Database, DbTransaction) 
GetDocumentDetails(Int32) Returns detailed information about specified document version
GetDocumentDetails(Int32, Boolean, Boolean, Database, DbTransaction) 
GetDocumentDetailsForFTS 
GetDocumentDetailsForHistory 
GetDocumentDetailsForSchema(Int32, Int32) Returns detailed information about specified document version for particular schema
GetDocumentDetailsForSchema(Int32, Int32, Boolean, Database, DbTransaction) 
GetDocumentDetailsForSchemaUsingCheckInMode Returns detailed information about specified document version for particular schema according to check-in mode
GetDocumentDetailsUsingCheckInMode 
GetDocumentDetailsWithChanges Returns information about specified document with changes made to each metadata version
GetDocumentExtension(Int32) Returns file extension
GetDocumentExtension(Int32, Database, DbTransaction) 
GetDocumentNameAndSchemaId 
GetDocumentsBySnapshot(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.
GetDocumentsBySnapshot(Guid, Guid, String, FieldDefinition, SearchCriteria, ColumnSelector, Int32, Int32, Boolean) 
GetDocumentsBySnapshot(Guid, Guid, String, FieldDefinition, SearchCriteria, ColumnSelector, Int32, Int32, SearchLogEntry, Database, DbTransaction, Boolean) 
GetDocumentsBySnapshotExcludeLibrary Special case of GetDocumentsBySnapshot(Guid, Guid, String, SearchCriteria, ColumnSelector, Int32, Int32). It excludes document in Library. Used in special cases (Anonymous Portal).
GetDocumentsWithFields Finds documents which fulfill specified search criteria using given array of field definitions.
GetDocumentSystemDetails(Int32) Returns detailed system information about specified document metadata version
GetDocumentSystemDetails(Int32, Database, DbTransaction) 
GetDownloadDocument 
GetDrilldownChoicesForMetadataVersion 
GetFieldsForView Returns collection of fields connected with specified view type
GetFtsErrorInfoCount Returns count of FTS errors
GetFtsErrorList Returns list of FTS errors
GetFtsErrorSubList Returns sub list of FTS errors
GetFtsLastUpdateState Get state of latest FTS index update
GetFtsScheduled Get scheduled FTS action
GetFtsState Return state of FTS
GetHostNameFromConfigFile Get the host name from config file (download url).
GetLastDocumentVersions Get the last version number of each document.
GetLastMetadataVersionIdForDocumentId(Int32) Returns metadata version id of the latest document version based on document's id
GetLastMetadataVersionIdForDocumentId(Int32, Database, DbTransaction) 
GetLastMetadataVersionIdForDocumentVersionId(Int32) 
GetLastMetadataVersionIdForDocumentVersionId(Int32, Database, DbTransaction) 
GetMergedDocuments Returns merged metadata values of documents from specified selection
GetPreviousMetadataVersion 
GetSchemaIdForDocument Returns id of the schema that particular metadata version of a document is in
GetSchemaTypeForDocument(Int32) Returns type of the schema that particular metadata version of a document is in
GetSchemaTypeForDocument(Int32, Database, DbTransaction) 
GetSearchLog Returns users searches
GetSearchLogDetails Returns users searches
GetSearchTextResult Returns html with file content from dtSearch containing highlighted strings from search query
GetSnapshotContent 
GetSnapshotDocumentCount(Guid) Returns number of documents in specified snapshot
GetSnapshotDocumentCount(Guid, Database, DbTransaction) 
GetSpecificUnindexedDocumentsCount Returns number of specific unindexed documents in the system (only latest versions), that logged in user can access
GetSpecificUnindexedDocumentsList Returns specific list of unindexed documents in the system (only latest versions)
GetSpecificUnindexedDocumentsListSorted Returns sorted list of specific unindexed documents in the system (only latest versions)
GetStringsForSearchTextResults 
GetUnindexedDocuments 
GetUnindexedDocumentsCount Returns number of unindexed documents in the system (only latest versions), that logged in user can access
GetUnindexedDocumentsInformations 
GetUnindexedDocumentsList Returns list of unindexed documents in the system (only latest versions)
GetUsageLog Returns information about usage of particular document(s) based on specified filter
GetUsageLogCount Returns number of entries in usage log according to specified filter
GetUsageLogUsersList Returns users list for the document usage log filters.
GetUsageLogWithDetails Returns information about usage of particular document(s) based on specified filter
GetUserViewFields(String) Returns collection of fields connected with specified view type for current user
GetUserViewFields(String, Int32, Database, DbTransaction) 
GetVersionsWithIds Get a list of document versions of the given document.
IncludeArchiveInLinkedByMetadata Check if archived documents need to be included in linked by metadata panel.
InitializeFtsIndex Initializes FTS index
IsIndexedByFTS 
LinkDocumentWithColumns(FieldDefinition, Int32, Database, DbTransaction) Retrieves document's data for specified metadata version. For use with application server plug-ins only.
LinkDocumentWithColumns(FieldDefinition, Int32, Boolean, Boolean, Database, DbTransaction) 
LinkDocumentWithColumns(Principal, FieldDefinition, Int32, Boolean, Boolean, Database, DbTransaction) 
LinkSnapshotWithColumns(DocumentFinderSnapshot, FieldDefinition, Int32, Int32, Database, DbTransaction) Retrieves documents' metadata for specified snapshot and page. For use with application server plug-ins only.
LinkSnapshotWithColumns(Principal, DocumentFinderSnapshot, FieldDefinition, Int32, Int32, SearchLogEntry, Database, DbTransaction) Retrieves documents' metadata for specified snapshot and page. For use with application server plug-ins only.
LoadSmartFolder(Int32) Returns stored search criteria for specified smart folder id
LoadSmartFolder(Int32, Database, DbTransaction) 
LoadUserSmartFolder Returns stored search criteria for specified smart folder id which belongs to the specified user.
RemoveFromUnidexedDocumentList Permamently removes from unindexed documents list
RemoveSnapshot Removing snapshot. For use with application server plug-ins only.
SaveSmartFolder Saves search criteria for specified smart folder id
SaveUserSmartFolder Saves search criteria for specified smart folder id which belongs to the specified user.
SetAllFtsErrorVisibilityState Set visibility of All errors
SetFtsErrorVisibilityState Set error visibility state
UpdateIdInAllUserSnapshots 

Extension Methods

See Also