QueryBuilder Class

class NXOpen.AME.QueryBuilder

Bases: NXOpen.Builder

Represents query class builder

To create a new instance of this class, use NXOpen.AME.AMEManager.CreateQueryBuilder()

New in version NX11.0.0.

Properties

Property	Description
CreationType	Returns or sets the defined rule type
Description	Returns or sets the query description
Name	Returns or sets the query name
Parent	Returns the parent node of query node
ReuseLibraryItem	Returns the public query
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.
GetObject	Returns the object currently being edited by this builder.
GetPublicQueryDescription	The selected public query description
GetPublicQueryName	The selected public query name
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.

Enumerations

QueryBuilderTypes Enumeration

the creation type of query

Property Detail

CreationType

QueryBuilder.CreationType

Returns or sets the defined rule type

-------------------------------------

Getter Method

Signature CreationType

Returns: Return type:NXOpen.AME.QueryBuilderTypes

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature CreationType

Parameters:type (NXOpen.AME.QueryBuilderTypes) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Description

QueryBuilder.Description

Returns or sets the query description

-------------------------------------

Getter Method

Signature Description

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature Description

Parameters:description (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Name

QueryBuilder.Name

Returns or sets the query name

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature Name

Parameters:name (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Parent

QueryBuilder.Parent

Returns the parent node of query node

-------------------------------------

Getter Method

Signature Parent

Returns: Return type:NXOpen.AME.SelectAMEBaseNode

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ReuseLibraryItem

QueryBuilder.ReuseLibraryItem

Returns the public query

-------------------------------------

Getter Method

Signature ReuseLibraryItem

Returns: Return type:NXOpen.Tooling.SelectReuseLibraryItemBuilder

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

GetPublicQueryDescription

QueryBuilder.GetPublicQueryDescription

The selected public query description

Signature GetPublicQueryDescription()

Returns: Return type:str

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

GetPublicQueryName

QueryBuilder.GetPublicQueryName

The selected public query name

Signature GetPublicQueryName()

Returns: Return type:str

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

QueryBuilder.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.