AttributeSearchTermBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# AttributeSearchTermBuilder Class

class `NXOpen.Assemblies.``AttributeSearchTermBuilder`

  Bases: `NXOpen.Assemblies.SearchTermBuilder`

  An AttributeSearchTermBuilder is used to create or edit an `NXOpen.Assemblies.AttributeSearchTerm`.

  To create a new instance of this class, use `NXOpen.Assemblies.SubsetCollection.CreateAttributeSearchTermBuilder()`

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
QueryName | Returns or sets the name of the saved query upon which this search term is based.
SearchTermLogic | Returns or sets the search term logic.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetCriteria | Get the entry titles and values that are used to populate the saved query.
GetObject | Returns the object currently being edited by this builder.
SetCriteria | Set the entry titles and values that are used to populate the saved query.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## QueryName

`AttributeSearchTermBuilder.``QueryName`

  Returns or sets the name of the saved query upon which this search term is based.

  `-------------------------------------`

  Getter Method

  Signature `QueryName`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

  `-------------------------------------`

  Setter Method

  Signature `QueryName`

  Parameters: | queryName (str) –

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## SearchTermLogic

`AttributeSearchTermBuilder.``SearchTermLogic`

  Returns or sets the search term logic.

  `-------------------------------------`

  Getter Method

  Signature `SearchTermLogic`

  Returns: |
  Return type: | `NXOpen.Assemblies.SearchTermSearchTermLogicType`

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

  `-------------------------------------`

  Setter Method

  Signature `SearchTermLogic`

  Parameters: | searchTermLogic (`NXOpen.Assemblies.SearchTermSearchTermLogicType`) –

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

# Method Detail

## GetCriteria

`AttributeSearchTermBuilder.``GetCriteria`

  Get the entry titles and values that are used to populate the saved query.

  Signature `GetCriteria()`

  Returns: | a tuple
  Return type: | A tuple consisting of (titles, values) titles is a list of str. search criteria titles values is a list of str. search criteria values

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## SetCriteria

`AttributeSearchTermBuilder.``SetCriteria`

  Set the entry titles and values that are used to populate the saved query.

  Signature `SetCriteria(titles, values)`

  Parameters:

  - titles (list of str) – search criteria titles
  - values (list of str) – search criteria values

  New in version NX8.5.0.

  License requirements: nx_4gd_integration (“4th Generation Design”)

## Validate

`AttributeSearchTermBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.