NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Validate.OverrideBuilder Class Reference

Represents a NXOpen.Validate.Override builder More...

Inheritance diagram for NXOpen.Validate.OverrideBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  DecisionActions { Approved, Rejected, Pending }
 Represents the override request decision action More...
 
enum  RequestTypes { Permanent, Temporary }
 Represents the override request type More...
 
enum  ToStates { Passed, Failed }
 Represents the override request to state More...
 

Public Member Functions

unsafe string[] GetDecisionComments ()
 Returns the decision comments More...
 
unsafe string[] GetDetailReason ()
 Returns the detail reason More...
 
unsafe void SetDecisionComments (string[] decisionComments)
 Sets the decision comments The decision comments is optional. More...
 
unsafe void SetDetailReason (string[] detailReason)
 Sets the detail reason The detail reason is optional unless override reason configuration is mandatory in Teamcenter. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe string Category [get, set]
 Returns or sets the category of override request. More...
 
unsafe
NXOpen.Validate.OverrideBuilder.DecisionActions 
DecisionAction [get, set]
 Returns or sets the decision action of override request The decision action is automatically pending while override request is created. More...
 
unsafe string DecisionUser [get, set]
 Returns or sets the decision user The decision user is a Teamcenter user in the Validation Administration group. More...
 
unsafe string Reason [get, set]
 Returns or sets the reason of override request. More...
 
unsafe
NXOpen.Validate.OverrideBuilder.RequestTypes 
RequestType [get, set]
 Returns or sets the type of override request More...
 
unsafe
NXOpen.Validate.OverrideBuilder.ToStates 
ToState [get, set]
 Returns or sets the to state of override request More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Validate.Override builder

To create a new instance of this class, use NXOpen.Validate.ResultObject.CreateOverrideBuilder

Default values.

Property Value

RequestType

Permanent

ToState

Passed

Created in NX8.5.0

Member Enumeration Documentation

Represents the override request decision action

Enumerator
Approved 
Rejected 
Pending 

Represents the override request type

Enumerator
Permanent 
Temporary 

Represents the override request to state

Enumerator
Passed 
Failed 

Member Function Documentation

unsafe string [] NXOpen.Validate.OverrideBuilder.GetDecisionComments ( )
inline

Returns the decision comments

Created in NX8.5.0

License requirements: None.

Returns
unsafe string [] NXOpen.Validate.OverrideBuilder.GetDetailReason ( )
inline

Returns the detail reason

Created in NX8.5.0

License requirements: None.

Returns
unsafe void NXOpen.Validate.OverrideBuilder.SetDecisionComments ( string[]  decisionComments)
inline

Sets the decision comments The decision comments is optional.

Created in NX8.5.0

License requirements: ug_checkmate ("UG Check Mate")

Parameters
decisionComments
unsafe void NXOpen.Validate.OverrideBuilder.SetDetailReason ( string[]  detailReason)
inline

Sets the detail reason The detail reason is optional unless override reason configuration is mandatory in Teamcenter.

Created in NX8.5.0

License requirements: ug_checkmate ("UG Check Mate")

Parameters
detailReason

Property Documentation

unsafe string NXOpen.Validate.OverrideBuilder.Category
getset

Returns or sets the category of override request.

The category is optional unless override reason configuration is mandatory in Teamcenter.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ug_checkmate ("UG Check Mate")

unsafe NXOpen.Validate.OverrideBuilder.DecisionActions NXOpen.Validate.OverrideBuilder.DecisionAction
getset

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.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ug_checkmate ("UG Check Mate")

unsafe string NXOpen.Validate.OverrideBuilder.DecisionUser
getset

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.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ug_checkmate ("UG Check Mate")

unsafe string NXOpen.Validate.OverrideBuilder.Reason
getset

Returns or sets the reason of override request.

The reason is optional unless override reason configuration is mandatory in Teamcenter.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ug_checkmate ("UG Check Mate")

unsafe NXOpen.Validate.OverrideBuilder.RequestTypes NXOpen.Validate.OverrideBuilder.RequestType
getset

Returns or sets the type of override request

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ug_checkmate ("UG Check Mate")

unsafe NXOpen.Validate.OverrideBuilder.ToStates NXOpen.Validate.OverrideBuilder.ToState
getset

Returns or sets the to state of override request

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ug_checkmate ("UG Check Mate")


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