CATPLMIntegrationUse CATAdpPLMQueryFilter

Usage: you must use this class as is. You should never derive it.

public class CATAdpPLMQueryFilter

Class defining a Filter to adress a query with extension.

Role: provide a set of attributes made of an attribute name and a value and operators for query.

Constructor and Destructor Index


o CATAdpPLMQueryFilter(CATAdpPLMQueryFilter&)
* Copy constructs a query filter.
o CATAdpPLMQueryFilter(CATIType*,CATAdpPLMQueryAttributeSet&,CATAdpPLMQueryAttributeOperator::PLMLogicalOperator&)
Constructs a Query Filter.
o ~CATAdpPLMQueryFilter(void)
Destructs an attribute set.

Method Index


o AddFilterOnExtension(CATIType*,CATAdpPLMQueryAttributeSet&,CATAdpPLMQueryAttributeOperator::PLMLogicalOperator&)
Adds an extension on a query filter.
o CaseSensitiveMode(CATBoolean&)
Activate mode sensitive case for query
Role:Activate mode sensitive case for query on string.
o ReturnQueryAttributes(PLMQueryFilterAttributesReturn)
Activate completion of query result
Role: Enables to define the attributes which will be returned for every found Component.
o operator =(CATAdpPLMQueryFilter&)
Affectation operator.

Enumerated Type Index


o PLMQueryFilterAttributesReturn

Constructor and Destructor


o CATAdpPLMQueryFilter
public CATAdpPLMQueryFilter( const )
* Copy constructs a query filter.
Returns:
The copy of the query filter .
o CATAdpPLMQueryFilter
public CATAdpPLMQueryFilter( iType,
const iQueryAttributeSet,
const iCondition=CATAdpPLMQueryAttributeOperator::AND)
Constructs a Query Filter.
Role: Constructs a Query filter and initializes it with a CATAdpPLMQueryAttributeSet.
Parameters:
iType
[in] The PLM Type. .
iQueryAttributeSet
[in] The set of attribute with a list of values and operators on a base PLM Type defining the filter.
iCondition[in]
The logical condition to be applied between each attribute constraint inside the query attribute set. Default value is 'AND'.
o ~CATAdpPLMQueryFilter
public virtual ~CATAdpPLMQueryFilter( )
Destructs an attribute set.

Methods


o AddFilterOnExtension
public AddFilterOnExtension( iType,
iQueryAttributeSet,
const iCondition=CATAdpPLMQueryAttributeOperator::AND)
Adds an extension on a query filter.
Role: Adds an extension query attribute set on a query filter.
Parameters:
iType
[in] The extension PLM type.
iQueryAttributeSet
[in] The set of attribute with a list of values and operators which defines the query attribute set.
iCondition[in]
The logical condition to be applied between each attribute constraint inside the query attribute set. Default value is 'AND'. Between two query attribute sets a AND condition is applied.
Returns:
  • S_OK .
  • S_FALSE .
  • E_FAIL if an internal error occured.
  • E_INVALIDARG if an invalid input was provided.
o CaseSensitiveMode
public CaseSensitiveMode( const iMode=TRUE)
Activate mode sensitive case for query
Role:Activate mode sensitive case for query on string. By default, the applied mode is not sensitive.
Parameters:
iMode
[in] Boolean value. If TRUE, the query is on case sensitive mode.
Returns:
  • S_OK if everything ran ok.
o ReturnQueryAttributes
public ReturnQueryAttributes( iMode)
Activate completion of query result
Role: Enables to define the attributes which will be returned for every found Component.
Parameters:
iMode
[in] The filter on returned attributes from Query mask.
Returns:
  • S_OK if everything ran ok.
o operator =
public operator =( const )
Affectation operator.

Enumerated Types


o PLMQueryFilterAttributesReturn 
enum PLMQueryFilterAttributesReturn {
  None,
  FromQueryMaskAttributes,
  CompleteQueryMaskAttributes
}
This object is included in the file: CATAdpPLMQueryFilter.h
If needed, your Imakefile.mk should include the module: CATPLMIntegrationUse

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