NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Validate::OverrideBuilder Class Reference

Represents a NXOpen::Validate::Override builder
To create a new instance of this class, use NXOpen::Validate::ResultObject::CreateOverrideBuilder
Default values. More...

Inheritance diagram for NXOpen::Validate::OverrideBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DecisionActions { DecisionActionsApproved, DecisionActionsRejected, DecisionActionsPending }
 Represents the override request decision action. More...
 
enum  RequestTypes { RequestTypesPermanent, RequestTypesTemporary }
 Represents the override request type. More...
 
enum  ToStates { ToStatesPassed, ToStatesFailed }
 Represents the override request to state. More...
 

Public Member Functions

NXString Category ()
 Returns the category of override request. More...
 
NXOpen::Validate::OverrideBuilder::DecisionActions DecisionAction ()
 Returns the decision action of override request The decision action is automatically pending while override request is created. More...
 
NXString DecisionUser ()
 Returns the decision user The decision user is a Teamcenter user in the Validation Administration group. More...
 
std::vector< NXStringGetDecisionComments ()
 Returns the decision comments. More...
 
std::vector< NXStringGetDetailReason ()
 Returns the detail reason. More...
 
NXString Reason ()
 Returns the reason of override request. More...
 
NXOpen::Validate::OverrideBuilder::RequestTypes RequestType ()
 Returns the type of override request
Created in NX8.5.0. More...
 
void SetCategory (const NXString &category)
 Sets the category of override request. More...
 
void SetCategory (const char *category)
 Sets the category of override request. More...
 
void SetDecisionAction (NXOpen::Validate::OverrideBuilder::DecisionActions decisionAction)
 Sets the decision action of override request The decision action is automatically pending while override request is created. More...
 
void SetDecisionComments (const std::vector< NXString > &decisionComments)
 Sets the decision comments The decision comments is optional. More...
 
void SetDecisionUser (const NXString &decisionUser)
 Sets the decision user The decision user is a Teamcenter user in the Validation Administration group. More...
 
void SetDecisionUser (const char *decisionUser)
 Sets the decision user The decision user is a Teamcenter user in the Validation Administration group. More...
 
void SetDetailReason (const std::vector< NXString > &detailReason)
 Sets the detail reason The detail reason is optional unless override reason configuration is mandatory in Teamcenter. More...
 
void SetReason (const NXString &reason)
 Sets the reason of override request. More...
 
void SetReason (const char *reason)
 Sets the reason of override request. More...
 
void SetRequestType (NXOpen::Validate::OverrideBuilder::RequestTypes requestType)
 Sets the type of override request
Created in NX8.5.0. More...
 
void SetToState (NXOpen::Validate::OverrideBuilder::ToStates toState)
 Sets the to state of override request
Created in NX8.5.0. More...
 
NXOpen::Validate::OverrideBuilder::ToStates ToState ()
 Returns the to state of override request
Created in NX8.5.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. 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
DecisionActionsApproved 

approved

DecisionActionsRejected 

rejected

DecisionActionsPending 

pending

Represents the override request type.

Enumerator
RequestTypesPermanent 

permanent

RequestTypesTemporary 

temporary

Represents the override request to state.

Enumerator
ToStatesPassed 

passed

ToStatesFailed 

failed

Member Function Documentation

NXString NXOpen::Validate::OverrideBuilder::Category ( )

Returns the category of override request.

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


Created in NX8.5.0.

License requirements : None

NXOpen::Validate::OverrideBuilder::DecisionActions NXOpen::Validate::OverrideBuilder::DecisionAction ( )

Returns 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 : None

NXString NXOpen::Validate::OverrideBuilder::DecisionUser ( )

Returns 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 : None

std::vector<NXString> NXOpen::Validate::OverrideBuilder::GetDecisionComments ( )

Returns the decision comments.

Returns

Created in NX8.5.0.

License requirements : None
std::vector<NXString> NXOpen::Validate::OverrideBuilder::GetDetailReason ( )

Returns the detail reason.

Returns

Created in NX8.5.0.

License requirements : None
NXString NXOpen::Validate::OverrideBuilder::Reason ( )

Returns the reason of override request.

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


Created in NX8.5.0.

License requirements : None

NXOpen::Validate::OverrideBuilder::RequestTypes NXOpen::Validate::OverrideBuilder::RequestType ( )

Returns the type of override request
Created in NX8.5.0.



License requirements : None

void NXOpen::Validate::OverrideBuilder::SetCategory ( const NXString category)

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 : ug_checkmate ("UG Check Mate")

Parameters
categorycategory
void NXOpen::Validate::OverrideBuilder::SetCategory ( const char *  category)

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 : ug_checkmate ("UG Check Mate")

Parameters
categorycategory
void NXOpen::Validate::OverrideBuilder::SetDecisionAction ( NXOpen::Validate::OverrideBuilder::DecisionActions  decisionAction)

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 : ug_checkmate ("UG Check Mate")

Parameters
decisionActiondecisionaction
void NXOpen::Validate::OverrideBuilder::SetDecisionComments ( const std::vector< NXString > &  decisionComments)

Sets the decision comments The decision comments is optional.


Created in NX8.5.0.

License requirements : ug_checkmate ("UG Check Mate")

Parameters
decisionCommentsdecisioncomments
void NXOpen::Validate::OverrideBuilder::SetDecisionUser ( const NXString decisionUser)

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 : ug_checkmate ("UG Check Mate")

Parameters
decisionUserdecisionuser
void NXOpen::Validate::OverrideBuilder::SetDecisionUser ( const char *  decisionUser)

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 : ug_checkmate ("UG Check Mate")

Parameters
decisionUserdecisionuser
void NXOpen::Validate::OverrideBuilder::SetDetailReason ( const std::vector< NXString > &  detailReason)

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
detailReasondetailreason
void NXOpen::Validate::OverrideBuilder::SetReason ( const NXString reason)

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 : ug_checkmate ("UG Check Mate")

Parameters
reasonreason
void NXOpen::Validate::OverrideBuilder::SetReason ( const char *  reason)

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 : ug_checkmate ("UG Check Mate")

Parameters
reasonreason
void NXOpen::Validate::OverrideBuilder::SetRequestType ( NXOpen::Validate::OverrideBuilder::RequestTypes  requestType)

Sets the type of override request
Created in NX8.5.0.



License requirements : ug_checkmate ("UG Check Mate")

Parameters
requestTyperequesttype
void NXOpen::Validate::OverrideBuilder::SetToState ( NXOpen::Validate::OverrideBuilder::ToStates  toState)

Sets the to state of override request
Created in NX8.5.0.



License requirements : ug_checkmate ("UG Check Mate")

Parameters
toStatetostate
NXOpen::Validate::OverrideBuilder::ToStates NXOpen::Validate::OverrideBuilder::ToState ( )

Returns the to state of override request
Created in NX8.5.0.



License requirements : None


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