All Frameworks Class Hierarchy This Framework Indexes Previous Next

InteractiveInterfaces Interface CATIIniSearchTypeCriterion

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

interface CATIIniSearchTypeCriterion

Interface to define a type-based search criterion.
Role: This interface enables the complete definition of a search criterion on objects of a specified type.
The type is defined through Knowledgeware.

Method Index

o GetParameters(CATIType**,CATIniSearchEnumeration::Comparison&,CATUnicodeString&): Retrives the type parameter using a CATIType pointer.
o SetParameters(CATIType*,CATIniSearchEnumeration::Comparison,CATUnicodeString): Sets the type parameter using a CATIType pointer.
o SetParameters(CATUnicodeString&,CATIniSearchEnumeration::Comparison,CATUnicodeString): Sets the type parameter using the type internal name.

Methods

o GetParameters

public virtual GetParameters(		`oSearchedType`,
		`oOperatingSign`,
		`oWorkbenchInternalName`)

Retrives the type parameter using a CATIType pointer.
Role: This method Retrives the type parameter thanks to a pointer to representing the type of objects looked for.

Parameters:

oSearchedType: A pointer to CATIType representing the type of objects.
oOperatingSign: The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
oWorkbenchInternalName: The internal name of the workbench to which the type belongs (the NLS name is displayed in the Edit/Search command's user interface).

Returns:

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

o SetParameters

public virtual SetParameters(	const	`iSearchedType`,
		`iOperatingSign`,
		`iWorkbenchInternalName`	`=""`)

Sets the type parameter using a CATIType pointer.
Role: This method sets the type parameter thanks to a pointer to representing the type of objects looked for.

Parameters:

iSearchedType: A pointer to CATIType representing the type of objects.
iOperatingSign: The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
iWorkbenchInternalName: The internal name of the workbench to which the type belongs (the NLS name is displayed in the Edit/Search command's user interface).
This parameter is only required for printing out the query.
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: iWorkbenchInternalName.TypeInternalName

Returns:

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

o SetParameters

public virtual SetParameters(	const	`iSearchedTypeInternalName`,
		`iOperatingSign`,
		`iWorkbenchInternalName`	`=""`)

Sets the type parameter using the type internal name.
Role: This method sets the type parameter thanks to a CATUnicodeString corresponding to the internal name of the type of object.

Parameters:

iSearchedTypeInternalName: The internal name of a type of object.
For instance GSMScaling is the internal name for the Generative Shape Design scaling operation.
iOperatingSign: The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
iWorkbenchInternalName: The internal name of the workbench to which the type belongs (the NLS name is displayed in the Edit/Search command's user interface).
This parameter is only required for printing out the query.
The internal workbench name corresponding to GSMScaling is CATPrtSearch.
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: iWorkbenchInternalName.iSearchedTypeInternalName

Returns:

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

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