All Frameworks Class Hierarchy This Framework Indexes Previous Next

InteractiveInterfaces Interface CATIIniSearchStringCriterion

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

interface CATIIniSearchStringCriterion

Interface to define a string-based attribute criterion.
Role: This interface enables the complete definition of a search criterion on string attributes.
This criterion has to be used to look for objects that have a string type attribute (as defined through Knowledgeware).
Such a criterion must always be used in conjunction with a , as a second argument of the criterion.

Method Index

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

Methods

o GetParameters

public virtual GetParameters(		`oAttributeInternalName`,
		`oAttributeValue`,
		`oCaseSensitive`,
		`oOperatingSign`,
		`oAttributeNLSName`)

Retrives all the parameters of the criterion.
Role: This method Retrives all the parameters of the criterion.

Parameters:

oAttributeInternalName: The internal name of the string attribute that is being looked for.
oAttributeValue: The value associated to the attribute.o
oCaseSensitivity: If the case of oAttributeValue is to be respected, the value must be TRUE. Otherwise, it must be FALSE.
Example:
If you are looking for objects whose name contains the Shell string, without objects whose name contains the shell string, the value should be set to TRUE.
oOperatingSign: The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
oAttributeNLSName: 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.

o SetParameters

public virtual SetParameters(	const	`iAttributeInternalName`,
	const	`iAttributeValue`,
		`iCaseSensitivity`,
		`iOperatingSign`,
		`iAttributeNLSName`	`=""`)

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

Parameters:

iAttributeInternalName: The internal name of the string attribute that is being 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
iAttributeValue: The value associated to the attribute.
The
iCaseSensitivity: If the case of iAttributeValue is to be respected, the value must be TRUE. Otherwise, it must be set to FALSE.
Example:
If you are looking for objects whose name contains the Shell string, without objects whose name contains the shell string, the value should be set to TRUE.
iOperatingSign: The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
iAttributeNLSName: 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: CATIIniSearchStringCriterion.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces