NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::PDM::PdmSearch Class Reference

Represents search query
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::PDM::PdmSearch:
NXOpen::TransientObject

Public Member Functions

NXOpen::PDM::SearchResultAdvanced (std::vector< NXString > &entries, std::vector< NXString > &values)
 This API performs advanced search in the teamcenter and returns the result vector .Internally it will execute the NX standard Query "__NX_STD_ANY_ITEM_QUERY". More...
 
NXOpen::PDM::SearchResultSimple (const NXString &searchCriteria)
 Perform simple search in the teamcenter and returns the result vector. More...
 
NXOpen::PDM::SearchResultSimple (const char *searchCriteria)
 Perform simple search in the teamcenter and returns the result vector. More...
 
virtual ~PdmSearch ()
 Frees the object from memory. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents search query
Created in NX6.0.0.


Constructor & Destructor Documentation

virtual NXOpen::PDM::PdmSearch::~PdmSearch ( )
virtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX6.0.0.

License requirements : None

Member Function Documentation

NXOpen::PDM::SearchResult* NXOpen::PDM::PdmSearch::Advanced ( std::vector< NXString > &  entries,
std::vector< NXString > &  values 
)

This API performs advanced search in the teamcenter and returns the result vector .Internally it will execute the NX standard Query "__NX_STD_ANY_ITEM_QUERY".

Advanced search takes in detailed inputs to perform the search. The parameters "entries" and "values" are the internal property names and their values to be searched. The attribute/value pairs are combined logically using AND so that only objects matching ALL of the specified criteria are returned. The method can only be used to search for matches on Teamcenter properties that are string valued. It does not work for properties which are Object/LOV valued. For example "owning_user" is TC Object valued so the search does not find any matches when attempting to search on it. Please note, this functionality is available starting in Teamcenter 2007.1 MP2. To see how to spell the "real" attribute names rather than the displayed attribute (column) names, use Edit-> Options...-> General-> UI-> Sys Admin-> Real Property Name in the Rich Client.

Returns
search result
Created in NX6.0.0.

License requirements : None
Parameters
entriessearch criteria entries
valuessearch criteria values
NXOpen::PDM::SearchResult* NXOpen::PDM::PdmSearch::Simple ( const NXString searchCriteria)

Perform simple search in the teamcenter and returns the result vector.

Internally it will execute the NX standard Query "__NX_STD_SIMPLE_ITEM_QUERY". ItemId should be given as the searchCriteria for searching the items Please note, this functionality is available starting in Teamcenter 2007.1 MP2.

Returns
search result
Created in NX6.0.0.

License requirements : None
Parameters
searchCriteriasearch criteria as string
NXOpen::PDM::SearchResult* NXOpen::PDM::PdmSearch::Simple ( const char *  searchCriteria)

Perform simple search in the teamcenter and returns the result vector.

Internally it will execute the NX standard Query "__NX_STD_SIMPLE_ITEM_QUERY". ItemId should be given as the searchCriteria for searching the items Please note, this functionality is available starting in Teamcenter 2007.1 MP2.

Returns
search result
Created in NX6.0.0.

License requirements : None
Parameters
searchCriteriasearch criteria as string

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.