IDocumentCriterion

class IDocumentCriterion

Bases: ImpactCOMWrapperBase

Summary:

Provides a single document search criterion.

Remarks:

Each criterion uses a single document column to match values for IDocument’s stored in the document repository. 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 brackets_after

Gets brackets_after.

Summary:

Indicates the number of closing brackets that should appear after this IDocumentCriterion.

Returns:

The value of brackets_after.

Return type:

brackets_after (int)

property brackets_before

Gets brackets_before.

Summary:

Indicates the number of open brackets that should appear before this IDocumentCriterion.

Returns:

The value of brackets_before.

Return type:

brackets_before (int)

property column

Gets Column.

Summary:

The document column that will be matched.

Returns:

The value of Column.

Return type:

column (IDocumentColumn)

property criterion_operator

Gets criterion_operator.

Summary:

The criterion search operator to apply.

Remarks:

The criterion operator is used to match the Values specified against values for each IDocument in the document respository. When the criterion_operator is dcoLike, dcoNotLike, dcoIn, dcoNotIn, dcoIsNull or dcoIsNotNull the IDocumentColumn.type must be dctString. When the criterion_operator is dcoLike or dcoNotLike you can also set the string_search property as appropriate. When the criterion_operator is dcoIn or dcoNotIn the Values property can be assigned an array of values. When the criterion_operator is dcoIsNull or dcoIsNotNull the Values property is ignored. When the IDocumentColumn.type is dctBoolean the criterion_operator cannot be dcoLessThan, dcoGreaterThan, dcoLessThanOrEqual or dcoGreaterThanOrEqual. When IDocumentColumn.multi_valued is true the criterion_operator must be either dcoIn or dcoNotIn.

Returns:

The value of criterion_operator.

Return type:

criterion_operator (ipDocumentCriterionOperator)

property exact_case

Gets exact_case.

Summary:

Specifies if the string match should be case-sensitive.

Remarks:

The exact_case property only applies when the IDocumentColumn.type is dctString.

Returns:

The value of exact_case.

Return type:

exact_case (bool)

property operator

Gets Operator.

Summary:

The logical operator applied between this and the previous IDocumentCriterion.

Remarks:

This property is ignored for the first IDocumentCriterion added to the IDocumentSearch. The Operator, brackets_before and brackets_after properties are used to build nested expressions for complex searches.

Returns:

The value of Operator.

Return type:

operator (ipDocumentOperator)

Gets string_search.

Summary:

The string search to apply for ‘like’ searches.

Remarks:

This property only applies when the criterion_operator is dcoLike or dcoNotLike.

Returns:

The value of string_search.

Return type:

string_search (ipDocumentStringSearch)

property values

Gets Values.

Summary:

The value or values to search for.

Remarks:

For most criterion_operator values the Values property should be assigned a single Variant of an appropriate type to match the IDocumentColumn.type property. When the criterion_operator is dcoIn or dcoNotIn the Values property can be assigned a Variant array of Variant values.

Returns:

The value of Values.

Return type:

values (any)

isNone()

Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.

Examples