All Frameworks Class Hierarchy This Framework Indexes Previous Next

InteractiveInterfaces Interface CATIIniSearchV4ModelCriterion

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

interface CATIIniSearchV4ModelCriterion

Interface to define a type-based criterion for V4 objects.
Role: This interface enables the complete definition of a search criterion on objects whose type is of a V4 kind.

Method Index

o SetParameters(CATListOfCATUnicodeString&,CATIniSearchEnumeration::Comparison,CATUnicodeString): Sets all the parameters of the criterion.

Methods

o SetParameters

public virtual SetParameters(	const	`iV4TypesList`,
		`iOperatingSign`,
		`iNLSName`	`=""`)

Sets all the parameters of the criterion.
Role: This method sets all the parameters of the criterion.

Parameters:

iV4TypesList: The list of internal name for the V4 types to be looked for.
To retrieve this piece of information you can proceed as follows:
Record a macro command on a scenario based on the Edit/Search command with your Search query as input (NLS based query).

Check the macro file. It contains the query under the following format: WorkbenchInternalName.TypeInternalName.iAttributeInternalName operator value
iOperatingSign: The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
iNLSName: This parameter is only required for printing out the query.
If no string is provided here, an NLS print of the query would display the attribute's NLS name, provided the query has been run at least once on a document containing at least one object with the specified attribute.

Returns:

E_FAIL if the criterion is not correctly set up.
S_OK otherwise.

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