IDocumentSearch¶

class IDocumentSearch¶

Bases: ImpactCOMWrapperBase

Description:: The IDocumentSearch object implements document searching.
Remarks:: The IDocumentSearch object provides a generic searching mechanism that is independant of the underying document repository. Each document provider converts the search criteria into provider specific searches. So any document search you create will work regardless of the underlying document provider being used. To use the IDocumentSearch use the Add method to add one or more search criteria then use the Execute method to retrieve the documents from the document repository. The Type property can be used to limit the IDocumentType’s searched. The IDocumentContext object can be used to initialise the IDocuments collection returned by Execute. To locate all documents in the document repository use an IDocumentSearch with no criteria. The IDocuments collection returned by Execute will contain every document available. You should also check supports_paging before loading all documents as the operation may be very slow for large numbers of documents. Introduced in Impact 9.0.0.83.

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property count¶

Gets Count.

property total_count¶

Gets total_count.

property type¶

Gets Type.

add(column)¶

Description:: Adds a new IDocumentCriterion to the document search.
Remarks:: The same IDocumentColumn object may be used in multiple search criterion. Complex search criteria can be built by adding multiple IDocumentCriterion and combining them with multiple bracketting levels.

Returns:: The IDocumentCriterion object can be used to specify the values to match.
Parameters:: column (IDocumentColumn) – The document column to use in the search.

execute()¶

item(index)¶

Parameters:: index (any) – Specifies the index of the IDocumentCriterion object to get.

Examples¶