CATPLMIntegrationUse CATAdpPLMExtendedQueryServices

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

public class CATAdpPLMExtendedQueryServices

Class to manage queries on PLM component in database.

Role: Provides basic functions to query PLM data.

Method Index

o GetElementsFromQueryFilter(CATAdpPLMQueryFilter&,CATAdpPLMComponentsInfos&,CATIAdpPLMErrorReviewer*)

Retrieves in the current repository the objects corresponding to a set of attributes of any type.

Methods

Retrieves in the current repository the objects corresponding to a set of attributes of any type.
Role: This method retrieves in the current repository the objects matching the input defined criterion.

• The input criterion is defined with a query filter (see further on for more accurate description).
• If no provider is currently connected, the query will result in an E_FAIL return.
• If more than one provider is connected, the query will result in an E_FAIL return.
• See to create filter.

Parameters:

iQueryFilter

[in] The Filter to adress a query with possible extension and supporting any kind of attributes. This filter owns a CATAdpPLMQueryAttributeSet corresponding to the main type of object to be retrieved and a list of CATAdpPLMQueryAttributeSet corresponding each to constraint on an extension. see (

) for more informations. The attribute set that the searched object should match. It contains the names , values and operators ("EQ", "NOT_EQ", "GT" , "LTEQ", "LT" , "GTEQ" , "LIKE") of the attributes which will be used during the search operation. It must not be empty for a set corresponding to an extension type.

• Inside a attribute set, attribute constraint can be combined through a ‘AND’ condition or a 'OR' condition .
• Between two attribute sets, the ‘AND’ condition is applied .
• These attributes should be of only string, double, integer, time, boolean types.
• Multi valuated attributes are not supported.
• Wildcard are supported as attribute values on string attribute type.

A set is invalid if :

• The attribute set is empty and if its type corresponds to an extension.
• The attribute set is empty and if its type corresponds to the main type and if there is no extension set defined and if the mode attribute completion with query mask is not set, see ( ) for more information.
• Or, one of the attributes available in the set is not defined for such a in the metadata.

oComponentsInfos

[out] Returned Informations on the found components.

• These components are not loaded in a session.
• Components are identified through

by using the method.

The return attributes on each Component are those which are specified according to completion of query result mode on iQueryFilter. See to have detailed informations. Be aware that this service returns only attributes belonging to the query mask (it is the same on extension). When the mode is set on iQueryFilter object, an attribute is filtered from output if it is not part of the Query mask and a warning is generated in param iopErrorMonitor (if it is defined).

iopErrorReviewer

[inout] The ErrorMonitor dedicated to store and handle all PLM Errors raised during the execution of this service.

Returns:

• S_OK if a component was found in the database.
• S_FALSE if no component matching the criterion was found in the database.
• E_FAIL if an error occured. If a blocking error occured, it can be accessed through method.
• E_INVALIDARG if the provided iType or iQueryFilter is invalid.

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