InteractiveInterfaces Interface CATIIniSearchRealCriterion

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

interface CATIIniSearchRealCriterion

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

Methods


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 real 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 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
    • 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: CATIIniSearchRealCriterion.h
    If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces

    Copyright © 1999-2014, Dassault Systèmes. All rights reserved.