All Frameworks Class Hierarchy This Framework Indexes Previous Next

InteractiveInterfaces Interface CATIIniSearchCriterion

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIIniSearchCriterion

Interface to use an already defined search criterion.
Role: This interface is the basic interface from which every Search criterion interface derive.
It defines the common services awaited on a Search criterion: printing, testing.

Method Index

o GetNLSQuery(CATUnicodeString&): Retrieves a string-format criterion.
o GetTransFormatQuery(CATUnicodeString&): Retrieves a string-format criterion.
o IsObjectMatching(CATBaseUnknown_var&): Tests if an object matches the criterion.

Methods

o GetNLSQuery

public virtual GetNLSQuery( oQueryString)

Retrieves a string-format criterion.
Role: This method enables the retrieval of a string-format criterion (i.e. query), using the session language (NLS support).

Parameters:

oQueryString: The NLS query corresponding to the criterion.

Returns:

E_FAIL if the criterion is not correctly set up (refer the adequate SetParameters method of the criterion). S_OK otherwise.

o GetTransFormatQuery

public virtual GetTransFormatQuery( oTFQueryString)

Retrieves a string-format criterion.
Role: This method enables the retrieval of a string-format criterion (i.e. query), using the transformat language. This language enables a query to be correctly analyzed and transformed into a criterion whatever the session language ( method).

Parameters:

oTFQueryString: The transformat query corresponding to the criterion.

Returns:

E_FAIL if the criterion is not correctly set up (refer the adequate SetParameters method of the criterion).
S_OK otherwise.

o IsObjectMatching

public virtual IsObjectMatching( const iObject)

Tests if an object matches the criterion.
Role: This method enables to test if an object matches the criterion as defined through the adequate SetParameters method.

Parameters:

iObject: The object to test.

Returns:

S_OK if the object fits the criterion.
E_FAIL otherwise.

This object is included in the file: CATIIniSearchCriterion.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces