All Frameworks Class Hierarchy This Framework Indexes Previous Next

InteractiveInterfaces Interface CATIIniSearchUserCriterion

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

interface CATIIniSearchUserCriterion

Interface to define a search criterion based on user-defined attributes.
Role: This interface enables the complete definition of a search criterion for a user-defined attribute.
This criterion has to be used to look for objects that have a user-defined 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&,CATIniSearchEnumeration::Comparison&): Retrives all the parameters of the criterion.
o SetParameters(CATUnicodeString&,CATUnicodeString&,CATIniSearchEnumeration::Comparison): Sets all the parameters of the criterion.

Methods

o GetParameters

public virtual GetParameters(		`oAttributeName`,
		`oAttributeValue`,
		`oOperatingSign`)

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

Parameters:

oAttributeName: The name that was given to the user-defined attribute.
oAttributeValue: The value associated to the attribute.
oOperatingSign: The value corresponding to the desired operating sign.
The authorized values depend on the attribute's type (integer, listing, string, etc.).

Returns:

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

o SetParameters

public virtual SetParameters(	const	`iAttributeName`,
	const	`iAttributeValue`,
		`iOperatingSign`)

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

Parameters:

iAttributeName: The name that was given to the user-defined attribute.
iAttributeValue: The value associated to the attribute.
iOperatingSign: The value corresponding to the desired operating sign.
The authorized values depend on the attribute's type (integer, listing, string, etc.).

Returns:

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

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