InteractiveInterfaces Interface CATIIniSearchListingCriterion

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

interface CATIIniSearchListingCriterion

Interface to define a listing-based attribute criterion.
Role: This interface enables the complete definition of a search criterion on listing attributes (for example when an attribute can have one value in a finite list of values).
This criterion has to be used to look for objects that have a listing-type attribute (as defined through Knowledgeware).
Such a criterion must always be used in conjunction with a CATIIniSearchTypeCriterion, as a second argument of the CATIIniSearchAndCriterion.SetParameters criterion.

Method Index


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

Methods


o GetParameters
public virtual HRESULT GetParameters(CATUnicodeString& oAttributeInternalName,
CATUnicodeString& oValueInternalName,
CATIniSearchEnumeration::Comparison& oOperatingSign,
CATUnicodeString& oAttributeNLSName,
CATUnicodeString& oValueNLSName) = 0
Retrives all the parameters of the criterion.
Role: This method Retrives all the parameters of the listing-based attribute criterion.
Parameters:
oAttributeInternalName
The internal name of the attribute that is being looked for.
oValueInternalName
The value associated to the attribute.
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.
oValueNLSName
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 value, 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 HRESULT SetParameters( const CATUnicodeString& iAttributeInternalName,
const CATUnicodeString& iValueInternalName,
CATIniSearchEnumeration::Comparison iOperatingSign,
CATUnicodeString iAttributeNLSName="",
CATUnicodeString iValueNLSName="") = 0
Sets all the parameters of the criterion.
Role: This method sets all the parameters of the listing-based attribute criterion.
Parameters:
iAttributeInternalName
The internal name of the 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.
    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.
    iValueNLSName
    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 value, 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: CATIIniSearchListingCriterion.h
    If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces

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