OverrideBuilder Class¶
-
class
NXOpen.Validate.OverrideBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Validate.OverridebuilderTo create a new instance of this class, use
NXOpen.Validate.ResultObject.CreateOverrideBuilder()Default values.
Property Value RequestType Permanent ToState Passed New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| Category | Returns or sets the category of override request. |
| DecisionAction | Returns or sets the decision action of override request The decision action is automatically pending while override request is created. |
| DecisionUser | Returns or sets the decision user The decision user is a Teamcenter user in the Validation Administration group. |
| Reason | Returns or sets the reason of override request. |
| RequestType | Returns or sets the type of override request |
| Tag | Returns the Tag for this object. |
| ToState | Returns or sets the to state of override request |
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. |
| GetDecisionComments | Returns the decision comments |
| GetDetailReason | Returns the detail reason |
| GetObject | Returns the object currently being edited by this builder. |
| SetDecisionComments | Sets the decision comments The decision comments is optional. |
| SetDetailReason | Sets the detail reason The detail reason is optional unless override reason configuration is mandatory in Teamcenter. |
| 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¶
| OverrideBuilderDecisionActions Enumeration | Represents the override request decision action |
| OverrideBuilderRequestTypes Enumeration | Represents the override request type |
| OverrideBuilderToStates Enumeration | Represents the override request to state |
Property Detail¶
Category¶
-
OverrideBuilder.Category¶ Returns or sets the category of override request.
The category is optional unless override reason configuration is mandatory in Teamcenter.
-------------------------------------Getter Method
Signature
CategoryReturns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CategoryParameters: category (str) – New in version NX8.5.0.
License requirements: ug_checkmate (“UG Check Mate”)
DecisionAction¶
-
OverrideBuilder.DecisionAction¶ Returns or sets the decision action of override request The decision action is automatically pending while override request is created.
If any property of override request is changed, the decision action will be pending.
-------------------------------------Getter Method
Signature
DecisionActionReturns: Return type: NXOpen.Validate.OverrideBuilderDecisionActionsNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DecisionActionParameters: decisionAction ( NXOpen.Validate.OverrideBuilderDecisionActions) –New in version NX8.5.0.
License requirements: ug_checkmate (“UG Check Mate”)
DecisionUser¶
-
OverrideBuilder.DecisionUser¶ Returns or sets the decision user The decision user is a Teamcenter user in the Validation Administration group.
If the decision user is empty, it means thant any user in the group can review override request.
-------------------------------------Getter Method
Signature
DecisionUserReturns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DecisionUserParameters: decisionUser (str) – New in version NX8.5.0.
License requirements: ug_checkmate (“UG Check Mate”)
Reason¶
-
OverrideBuilder.Reason¶ Returns or sets the reason of override request.
The reason is optional unless override reason configuration is mandatory in Teamcenter.
-------------------------------------Getter Method
Signature
ReasonReturns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReasonParameters: reason (str) – New in version NX8.5.0.
License requirements: ug_checkmate (“UG Check Mate”)
RequestType¶
-
OverrideBuilder.RequestType¶ Returns or sets the type of override request
-------------------------------------Getter Method
Signature
RequestTypeReturns: Return type: NXOpen.Validate.OverrideBuilderRequestTypesNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RequestTypeParameters: requestType ( NXOpen.Validate.OverrideBuilderRequestTypes) –New in version NX8.5.0.
License requirements: ug_checkmate (“UG Check Mate”)
ToState¶
-
OverrideBuilder.ToState¶ Returns or sets the to state of override request
-------------------------------------Getter Method
Signature
ToStateReturns: Return type: NXOpen.Validate.OverrideBuilderToStatesNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ToStateParameters: toState ( NXOpen.Validate.OverrideBuilderToStates) –New in version NX8.5.0.
License requirements: ug_checkmate (“UG Check Mate”)
Method Detail¶
GetDecisionComments¶
-
OverrideBuilder.GetDecisionComments¶ Returns the decision comments
Signature
GetDecisionComments()Returns: Return type: list of str New in version NX8.5.0.
License requirements: None.
GetDetailReason¶
-
OverrideBuilder.GetDetailReason¶ Returns the detail reason
Signature
GetDetailReason()Returns: Return type: list of str New in version NX8.5.0.
License requirements: None.
SetDecisionComments¶
-
OverrideBuilder.SetDecisionComments¶ Sets the decision comments The decision comments is optional.
Signature
SetDecisionComments(decisionComments)Parameters: decisionComments (list of str) – New in version NX8.5.0.
License requirements: ug_checkmate (“UG Check Mate”)
SetDetailReason¶
-
OverrideBuilder.SetDetailReason¶ Sets the detail reason The detail reason is optional unless override reason configuration is mandatory in Teamcenter.
Signature
SetDetailReason(detailReason)Parameters: detailReason (list of str) – New in version NX8.5.0.
License requirements: ug_checkmate (“UG Check Mate”)
Validate¶
-
OverrideBuilder.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.