PdmSearch Class

class NXOpen.PDM.PdmSearch

Bases: NXOpen.TransientObject

Represents search query

New in version NX6.0.0.

Methods

Method Description
Advanced This API performs advanced search in the teamcenter and returns the result vector .
Dispose Frees the object from memory.
Simple Perform simple search in the teamcenter and returns the result vector.

Method Detail

Advanced

PdmSearch.Advanced

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. </b>

Signature Advanced(entries, values)

Parameters:
  • entries (list of str) – search criteria entries
  • values (list of str) – search criteria values
Returns:

search result

Return type:

NXOpen.PDM.SearchResult

New in version NX6.0.0.

License requirements: None.

Dispose

PdmSearch.Dispose

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.

Signature Dispose()

New in version NX6.0.0.

License requirements: None.

Simple

PdmSearch.Simple

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. </b>

Signature Simple(searchCriteria)

Parameters:searchCriteria (str) – search criteria as string
Returns:search result
Return type:NXOpen.PDM.SearchResult

New in version NX6.0.0.

License requirements: None.