All Frameworks Class Hierarchy This Framework Indexes Previous Next

InteractiveInterfaces Interface CATIIniSearchIntegerCriterion

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

interface CATIIniSearchIntegerCriterion

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

Methods

o GetParameters

public virtual GetParameters(		`oAttributeInternalName`,
		`oValuetype`,
		`oAttributeValue1`,
		`oAttributeValue2`,
		`oOperatingSign`,
		`oAttributeNLSName`)

Retrives all the parameters of the criterion.
Role: This method Retrives all the parameters of the criterion. It is to be used when looking for objects having a specified attribute, whose value belongs (or not) to a range of values.

Parameters:

oAttributeInternalName: The internal name of the integer attribute that is being looked for.
oValuetype: It gives us value in form "Range" or "NotRange" it depends on whether oAttributeValue1 and oAttributeValue2 are both present i.e. range. If only one of them is present means not range.
oAttributeValue1: The lower limit value of the range. It is included in the search.
oAttributeValue2: The upper limit value of the range. It is included in the search.
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`,
		`iAttributeValue`,
		`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 integer 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.
iOperatingSign: The value corresponding to the desired operating sign.
All values are authorized.
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.

o SetParameters

public virtual SetParameters(	const	`iAttributeInternalName`,
		`iAttributeValue1`,
		`iAttributeValue2`,
		`iOperatingSign`,
		`iAttributeNLSName`	`=""`)

Sets all the parameters of the criterion.
Role: This method sets all the parameters of the criterion. It is to be used when looking for objects having a specified attribute, whose value belongs (or not) to a range of values.

Parameters:

iAttributeInternalName: The internal name of the integer 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
iAttributeValue1: The lower limit value of the range. It is included in the search.
iAttributeValue2: The upper limit value of the range. It is included in the search.
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: CATIIniSearchIntegerCriterion.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces