Teamcenter C++ API Reference  2312
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
Teamcenter::Awb0Connection Class Reference

#include <Awb0Connection.hxx>

Inheritance diagram for Teamcenter::Awb0Connection:
Teamcenter::Awb0ConditionalElement Teamcenter::Awb0Element Teamcenter::RuntimeBusinessObject Teamcenter::BusinessObject Teamcenter::RootObject Teamcenter::Object

Public Member Functions

int awb0CanCBOSBeCreated (bool *verdict)
 
int awb0CanChildBeAdded (bool *verdict)
 
int awb0CanEffectivityBeApplied (bool *verdict)
 
int awb0CanEffectivityBeAppliedOrRemoved (bool *verdict)
 
int awb0CanEffectivityBeViewed (bool *verdict)
 
int awb0CanParentBeAdded (bool *verdict)
 
int awb0CanRemoveLevel (bool *verdict)
 
int awb0CanSelectionBeRemoved (bool *verdict)
 
int awb0CanSelectionBeReplaced (bool *verdict)
 
int awb0CanSetInContext (bool *verdict)
 
int awb0CanSiblingBeAdded (bool *verdict)
 
int awb0CanSWCBeCreatedInProductContext (bool *verdict)
 
int awb0CanSWCBeDuplicatedInProductContext (bool *verdict)
 
int awb0CanSWCBeSavedInProductContext (bool *verdict)
 
int awb0CanVOOFilterBeApplied (bool *verdict)
 
int awb0getToken (::Teamcenter::OccMgmt::IToken **token)
 
int awb0initalize (tag_t parent, int nChildren, const ::Teamcenter::OccMgmt::IToken *token, const char *identifier)
 
int awb0IsPackSupported (bool *verdict)
 
int awb0save ()
 
int awb0setChildCountStale ()
 
int create (::Teamcenter::CreateInput *creInput)
 
int createPost (::Teamcenter::CreateInput *creInput)
 
int finalizeCreateInput (::Teamcenter::CreateInput *creInput)
 
int finalizeSaveAsInput (::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData * > *vecDeepCopyData)
 
int fnd0AskSRUid (std::string *uid, bool *isFirstTime) const
 
int fnd0GenerateRecipe (std::string *recipe)
 
int fnd0GetChildren (const std::vector< std::string > *propertyNames, std::vector< tag_t > *childTags, std::vector< std::string > *childContextPropertyNames)
 
int fnd0GetSerializationState (bool *currentState) const
 
int fnd0IsRecoverable (bool *isPersistedRecipe, bool *isRecoverableIDSupported) const
 
int fnd0SetSerializationState (bool newState, bool *stateChanged)
 
int fnd0SetSRUid (const std::string *uid)
 
int getAwb0Archetype (tag_t &value, bool &isNull) const
 
int getAwb0BreadcrumbAncestor (tag_t &value, bool &isNull) const
 
int getAwb0CsidPath (std::string &value, bool &isNull) const
 
int getAwb0DisplayedName (std::string &value, bool &isNull) const
 
int getAwb0DisplayedNameDisplayableValues (std::vector< std::string > &values)
 
int getAwb0ElementFilterState (bool &value, bool &isNull) const
 
int getAwb0ElementVariantState (bool &value, bool &isNull) const
 
int getAwb0End1 (tag_t &value, bool &isNull) const
 
int getAwb0End2 (tag_t &value, bool &isNull) const
 
int getAwb0HasAlternates (bool &value, bool &isNull) const
 
int getAwb0HasAlternatesDisplayableValues (std::vector< std::string > &values)
 
int getAwb0HasInContextOverrides (bool &value, bool &isNull) const
 
int getAwb0HasSubstitues (bool &value, bool &isNull) const
 
int getAwb0HasSubstituesDisplayableValues (std::vector< std::string > &values)
 
int getAwb0is_modifiable (bool &value, bool &isNull) const
 
int getAwb0IsStructModifiable (bool &value, bool &isNull) const
 
int getAwb0MarkupPropertyNames (std::vector< std::string > &values, std::vector< int > &isNull) const
 
int getAwb0MarkupPropertyNamesDisplayableValues (std::vector< std::string > &values)
 
int getAwb0MarkupPropertyValues (std::vector< std::string > &values, std::vector< int > &isNull) const
 
int getAwb0MarkupPropertyValuesDisplayableValues (std::vector< std::string > &values)
 
int getAwb0MarkupType (int &value, bool &isNull) const
 
int getAwb0MarkupTypeDisplayableValues (std::vector< std::string > &values)
 
int getAwb0NumberOfChildren (int &value, bool &isNull) const
 
int getAwb0OverriddenProperties (std::vector< std::string > &values, std::vector< int > &isNull) const
 
int getAwb0OverriddenPropertiesDisplayableValues (std::vector< std::string > &values)
 
int getAwb0OverrideContexts (std::vector< std::string > &values, std::vector< int > &isNull) const
 
int getAwb0Parent (tag_t &value, bool &isNull) const
 
int getAwb0PendingAction (std::string &value, bool &isNull) const
 
int getAwb0ServiceAdapter (std::string &value, bool &isNull) const
 
int getAwb0UnderlyingObject (tag_t &value, bool &isNull) const
 
int getChar (const std::string &charName, char &charRetValue, bool &isNull, bool &hasReadAccess)
 
int getChar (const std::string &charName, char &charRetValue, bool &isNull)
 
int getCharArray (const std::string &charArrayName, std::vector< char > &vectorCharVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess)
 
int getCharArray (const std::string &charArrayName, std::vector< char > &vectorCharVals, std::vector< int > &vectorIsNullVals)
 
int getDate (const std::string &dateName, date_t &dateRetValue, bool &isNull, bool &hasReadAccess)
 
int getDate (const std::string &dateName, date_t &dateRetValue, bool &isNull)
 
int getDateArray (const std::string &dateArrayName, std::vector< date_t > &dateArrayRetValue, std::vector< int > &isNull, bool &hasReadAccess)
 
int getDateArray (const std::string &dateArrayName, std::vector< date_t > &dateArrayRetValue, std::vector< int > &isNull)
 
int getDeepCopyData (const std::string *operation, std::vector< ::Teamcenter::DeepCopyData * > *deepCopyDatas)
 
int getDouble (const std::string &doubleName, double &doubleRetValue, bool &isNull, bool &hasReadAccess)
 
int getDouble (const std::string &doubleName, double &doubleRetValue, bool &isNull)
 
int getDoubleArray (const std::string &doubleArrayName, std::vector< double > &vectorDoubleVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess)
 
int getDoubleArray (const std::string &doubleArrayName, std::vector< double > &vectorDoubleVals, std::vector< int > &vectorIsNullVals)
 
int getInt (const std::string &intName, int &intRetValue, bool &isNull, bool &hasReadAccess)
 
int getInt (const std::string &intName, int &intRetValue, bool &isNull)
 
int getIntArray (const std::string &intArrayName, std::vector< int > &vectorIntVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess)
 
int getIntArray (const std::string &intArrayName, std::vector< int > &vectorIntVals, std::vector< int > &vectorIsNullVals)
 
int getLogical (const std::string &logicalName, bool &boolRetValue, bool &isNull, bool &hasReadAccess)
 
int getLogical (const std::string &logicalName, bool &boolRetValue, bool &isNull)
 
int getLogicalArray (const std::string &logicalArrayName, std::vector< int > &vectorLogicalVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess)
 
int getLogicalArray (const std::string &logicalArrayName, std::vector< int > &vectorLogicalVals, std::vector< int > &vectorIsNullVals)
 
int getObject_string (std::string &value, bool &isNull) const
 
int getString (const std::string &stringName, std::string &stringRetValue, bool &isNull, bool &hasReadAccess)
 
int getString (const std::string &stringName, std::string &stringRetValue, bool &isNull)
 
int getStringArray (const std::string &stringArrayName, std::vector< std::string > &vectorStringVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess)
 
int getStringArray (const std::string &stringArrayName, std::vector< std::string > &vectorStringVals, std::vector< int > &vectorIsNullVals)
 
tag_t getTag () const
 
int getTag (const std::string &tagName, tag_t &tagRetValue, bool &isNull, bool &hasReadAccess)
 
int getTag (const std::string &tagName, tag_t &tagRetValue, bool &isNull)
 
int getTagArray (const std::string &tagArrayName, std::vector< tag_t > &vectorTagVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess)
 
int getTagArray (const std::string &tagArrayName, std::vector< tag_t > &vectorTagVals, std::vector< int > &vectorIsNullVals)
 
const std::string & getTypeName () const
 
tag_t getTypeTag () const
 
int invokeOperation (const std::string *operationId,...)
 
int invokeOperation (const std::string &operationId, va_list args)
 
int invokeOperation (int operationIdInt, va_list args)
 
int invokeOperation (const std::string &operationId, std::vector< void * > &args)
 
int invokeOperation (int operationIdInt, std::vector< void * > &args)
 
int performDeepCopy (::Teamcenter::OperationInput *pOperationInput, std::vector< ::Teamcenter::DeepCopyData * > *vecDeepCopyData)
 
int saveAs (::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData * > *vecDeepCopyData, tag_t *newObjTag)
 
int saveAsPost (::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData * > *vecDeepCopyData)
 
int setAwb0DisplayedName (const std::string &value, bool isNull=false)
 
int setAwb0End1 (const tag_t &value, bool isNull=false)
 
int setAwb0End2 (const tag_t &value, bool isNull=false)
 
int setAwb0Parent (const tag_t &value, bool isNull=false)
 
int setChar (const std::string &charName, const char &charValue, bool isNull)
 
int setCharArray (const std::string &charArrayName, const std::vector< char > &vectorCharVals, const std::vector< int > *vectorIsNullVals)
 
int setDate (const std::string &dateName, const date_t &dateValue, bool isNull)
 
int setDateArray (const std::string &dateArrayName, const std::vector< date_t > &vectorDateVals, const std::vector< int > *vectorIsNullVals)
 
int setDouble (const std::string &doubleName, const double &doubleValue, bool isNull)
 
int setDoubleArray (const std::string &doubleArrayName, const std::vector< double > &vectorDoubleVals, const std::vector< int > *vectorIsNullVals)
 
int setInt (const std::string &intName, const int &intValue, bool isNull)
 
int setIntArray (const std::string &intArrayName, const std::vector< int > &vectorIntVals, const std::vector< int > *vectorIsNullVals)
 
int setLogical (const std::string &logicalName, const bool logicalValue, bool isNull)
 
int setLogicalArray (const std::string &boolArrayName, const std::vector< int > &vectorboolVals, const std::vector< int > *vectorIsNullVals)
 
int setPropertiesFromCreateInput (::Teamcenter::CreateInput *creInput)
 
int setPropertiesFromSaveAsInput (::Teamcenter::SaveAsInput *pSavAsInput)
 
int setString (const std::string &stringName, const std::string &stringValue, bool isNull)
 
int setStringArray (const std::string &stringArrayName, const std::vector< std::string > &vectorStringVals, const std::vector< int > *vectorIsNullVals)
 
int setTag (const std::string &tagName, const tag_t &tagValue, bool isNull)
 
int setTagArray (const std::string &tagArrayName, const std::vector< tag_t > &vectorTagVals, const std::vector< int > *vectorIsNullVals)
 
int validateCreateInput (::Teamcenter::CreateInput *creInput)
 
int validateSaveAsInput (::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData * > *vecDeepCopyData)
 

Static Public Member Functions

static int fnd0Create (std::vector< ::Teamcenter::BulkInput * > *inputs,::Teamcenter::BulkData *bd)
 
static int fnd0CreatePost (std::vector< ::Teamcenter::BulkInput * > *inputs,::Teamcenter::BulkData *bd)
 
static int fnd0FinalizeCreateInput (std::vector< ::Teamcenter::BulkInput * > *inputs,::Teamcenter::BulkData *bd)
 
static int fnd0FinalizeSaveAsInput (std::vector< ::Teamcenter::BulkInput * > *inputs,::Teamcenter::BulkData *bd)
 
static int fnd0GetDeepCopyData (std::vector< ::Teamcenter::BulkInput * > *getDeepCopydata,::Teamcenter::BulkData *bd)
 
static int fnd0PerformDeepCopy (std::vector< ::Teamcenter::BulkInput * > *inputs,::Teamcenter::BulkData *bd)
 
static int fnd0SaveAs (std::vector< ::Teamcenter::BulkInput * > *inputs,::Teamcenter::BulkData *bd)
 
static int fnd0SaveAsPost (std::vector< ::Teamcenter::BulkInput * > *inputs,::Teamcenter::BulkData *bd)
 
static int fnd0SetPropertiesFromCreateInput (std::vector< ::Teamcenter::BulkInput * > *inputs,::Teamcenter::BulkData *bd)
 
static int fnd0SetPropertiesFromSaveAsInput (std::vector< ::Teamcenter::BulkInput * > *inputs,::Teamcenter::BulkData *bd)
 
static int fnd0ValidateCreateInput (std::vector< ::Teamcenter::BulkInput * > *inputs,::Teamcenter::BulkData *bd)
 
static int fnd0ValidateSaveAsInput (std::vector< ::Teamcenter::BulkInput * > *inputs,::Teamcenter::BulkData *bd)
 
static const std::string & getInterfaceName ()
 

Protected Member Functions

 Awb0Connection ()
 
virtual void initialize (RootObjectImpl *impl=0)
 
virtual void initialize (::Teamcenter::RootObjectImpl *impl)
 
void setTag (tag_t tag)
 
virtual ~Awb0Connection ()
 

Private Member Functions

 Awb0Connection (const Awb0Connection &)
 
Awb0ConnectionImpl * getAwb0ConnectionImpl () const
 
Awb0Connectionoperator= (const Awb0Connection &)
 
::Teamcenter::RootObjectImpl * setAwb0ConnectionImpl (::Teamcenter::RootObjectImpl *impl)
 
void setDeleteImpl (bool del)
 

Private Attributes

Awb0ConnectionImpl * m_awb0connectionImpl
 
bool m_deleteImpl
 

Static Private Attributes

static std::string name
 

Friends

class Awb0ConnectionDelegate
 
class Awb0ConnectionGenImpl
 

Detailed Description

Definition at line 51 of file Awb0Connection.hxx.

Constructor & Destructor Documentation

Teamcenter::Awb0Connection::Awb0Connection ( )
protected

Constructor

virtual Teamcenter::Awb0Connection::~Awb0Connection ( )
protectedvirtual

Destructor

Teamcenter::Awb0Connection::Awb0Connection ( const Awb0Connection )
private

Private default constructor. We do not want this class instantiated without the business object passed in.

Parameters
Awb0Connection- desc for Awb0Connection parameter

Member Function Documentation

int Teamcenter::Awb0Element::awb0CanCBOSBeCreated ( bool *  verdict)
inherited
Version
ActiveWorkspace4.3
Parameters
verdict- This is the verdict if Configure based on Selection command is visible
Returns
-
int Teamcenter::Awb0Element::awb0CanChildBeAdded ( bool *  verdict)
inherited
Version
ActiveWorkspace3.1
Parameters
verdict- This is the verdict if child can be can be added to the input BusinessObject.
Returns
-
int Teamcenter::Awb0Element::awb0CanEffectivityBeApplied ( bool *  verdict)
inherited

Determines if the occurrence effectivities can be applied to the Awb0Element.

Version
ActiveWorkspace3.1
Parameters
verdict- This is the verdict if Awb0Element can be replaced.
Returns
- Returns verdict to determine if effectivity command is visisble.
int Teamcenter::Awb0Element::awb0CanEffectivityBeAppliedOrRemoved ( bool *  verdict)
inherited
Version
ActiveWorkspace3.3
Parameters
verdict- This is the verdict if effectivity can be applied and/or removed.
Returns
-
int Teamcenter::Awb0Element::awb0CanEffectivityBeViewed ( bool *  verdict)
inherited
Version
ActiveWorkspace3.3
Parameters
verdict- This is the verdict if effectivity is visible.
Returns
- Returns verdict to determine if effectivity can only be viewed.
int Teamcenter::Awb0ConditionalElement::awb0CanParentBeAdded ( bool *  verdict)
inherited

This is to determine whether insert level command should be visible to the user.

Version
ActiveWorkspace5.1
Parameters
verdict- This is the verdict if parent can be can be added to the input BusinessObject.
Returns
-
int Teamcenter::Awb0ConditionalElement::awb0CanRemoveLevel ( bool *  verdict)
inherited

This is to determine whether remove level command should be visible to the user.

Version
ActiveWorkspace5.1
Parameters
verdict- This is the verdict if the selected business object can be removed without removing the sub-tree.
Returns
-
int Teamcenter::Awb0Element::awb0CanSelectionBeRemoved ( bool *  verdict)
inherited
Version
ActiveWorkspace3.1
Parameters
verdict- This is the verdict whether the selection can be removed or not.
Returns
-
int Teamcenter::Awb0Element::awb0CanSelectionBeReplaced ( bool *  verdict)
inherited
Version
ActiveWorkspace3.1
Parameters
verdict- This is the verdict whether the selection can be replaced or not.
Returns
-
int Teamcenter::Awb0ConditionalElement::awb0CanSetInContext ( bool *  verdict)
inherited
Version
ActiveWorkspace4.3
Parameters
verdict- This is the verdict if set in context is supported for element or not.
Returns
-
int Teamcenter::Awb0Element::awb0CanSiblingBeAdded ( bool *  verdict)
inherited
Version
ActiveWorkspace3.1
Parameters
verdict- This is the verdict if sibling can be can be added to the input BusinessObject.
Returns
-
int Teamcenter::Awb0Element::awb0CanSWCBeCreatedInProductContext ( bool *  verdict)
inherited
Version
ActiveWorkspace3.2
Parameters
verdict- This is the verdict if Save Working Context can be created in Product Context.
Returns
-
int Teamcenter::Awb0Element::awb0CanSWCBeDuplicatedInProductContext ( bool *  verdict)
inherited
Version
ActiveWorkspace3.2
Parameters
verdict- This is the verdict if Save Working Context can be duplicated in Product Context
Returns
-
int Teamcenter::Awb0Element::awb0CanSWCBeSavedInProductContext ( bool *  verdict)
inherited
Version
ActiveWorkspace3.2
Parameters
verdict- This is the verdict if Save Working Context can be saved or updated in Product Context.
Returns
-
int Teamcenter::Awb0ConditionalElement::awb0CanVOOFilterBeApplied ( bool *  verdict)
inherited

Check if Configure By Valid Overlays command is visible for input Business Object.

Version
ActiveWorkspace4.3
Parameters
verdict- This is the verdict if Configure By Valid Overlays command is visible or not.
Returns
-
int Teamcenter::Awb0Element::awb0getToken ( ::Teamcenter::OccMgmt::IToken **  token)
inherited

Get IToken of Awb0Element

Version
Teamcenter 9.1.2
Parameters
token- IToken of the Awb0Element
Returns
- ITK_ok always
int Teamcenter::Awb0Element::awb0initalize ( tag_t  parent,
int  nChildren,
const ::Teamcenter::OccMgmt::IToken token,
const char *  identifier 
)
inherited

Initialize the operation.

Version
Teamcenter 9.1.2
Parameters
parent- parent Awb0Element
nChildren- number of children
token- IToken holding information about backing object.
identifier- Recoverable identifier for Awb0Element
Returns
- ITK_ok if successful. Failure if token or identifier is null.
int Teamcenter::Awb0ConditionalElement::awb0IsPackSupported ( bool *  verdict)
inherited
Version
ActiveWorkspace4.2
Parameters
verdict- This is the verdict if pack is supported for element or not.
Returns
-
int Teamcenter::Awb0Element::awb0save ( )
inherited

Save any changes.

Version
Teamcenter 9.1.2
Returns
- ITK error if any.
int Teamcenter::Awb0Element::awb0setChildCountStale ( )
inherited

Invalidates child count stale

Version
Teamcenter 9.1.2
Returns
- ITK_ok always
int Teamcenter::BusinessObject::create ( ::Teamcenter::CreateInput creInput)
inherited

desc for validate for create

Version
Tc 8
Parameters
creInput- desc for creInput parameter
Returns
- ret desc for validate for create
int Teamcenter::BusinessObject::createPost ( ::Teamcenter::CreateInput creInput)
inherited

desc for createPost

Version
Tc 8
Parameters
creInput- Description for the Create Input
Returns
- return desc for createPost
int Teamcenter::BusinessObject::finalizeCreateInput ( ::Teamcenter::CreateInput creInput)
inherited

Description for the Finalize Create Input

Version
Tc 8
Parameters
creInput- desc for creInput parameter
Returns
- Return desc for Initialize for Create
int Teamcenter::BusinessObject::finalizeSaveAsInput ( ::Teamcenter::SaveAsInput pSavAsInput,
std::vector< ::Teamcenter::DeepCopyData * > *  vecDeepCopyData 
)
inherited

finalize operation input

Version
Teamcenter 9
Parameters
pSavAsInput- desc
vecDeepCopyData- desc
Returns
- returns an int
int Teamcenter::BusinessObject::fnd0AskSRUid ( std::string *  uid,
bool *  isFirstTime 
) const
inherited

This is the getter for retrieving the recipe/permanent ID if its been created (and cached on the instance). Every Business Object should implement this operation.

Version
Teamcenter 11.1
Parameters
uid- Recipe/permanent ID
isFirstTime- If Session Recovery Uid is yet to be set or does the object need to be serialized again?
Returns
- Failure code
static int Teamcenter::BusinessObject::fnd0Create ( std::vector< ::Teamcenter::BulkInput * > *  inputs,
::Teamcenter::BulkData bd 
)
staticinherited

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version
Teamcenter 11.4
Parameters
inputs- A vector of data that contains reference information to the object to be created
bd- A data structure to store objects and other information relevant for set-based operation
Returns
-
static int Teamcenter::BusinessObject::fnd0CreatePost ( std::vector< ::Teamcenter::BulkInput * > *  inputs,
::Teamcenter::BulkData bd 
)
staticinherited

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version
Teamcenter 11.4
Parameters
inputs- A vector of data that contains reference information to the object to be saved
bd- A data structure to store objects and other information relevant for set-based operation
Returns
-
static int Teamcenter::BusinessObject::fnd0FinalizeCreateInput ( std::vector< ::Teamcenter::BulkInput * > *  inputs,
::Teamcenter::BulkData bd 
)
staticinherited

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version
Teamcenter 11.4
Parameters
inputs- A vector of data that contains reference information to the object to be created
bd- A data structure to store objects and other information relevant for set-based operation
Returns
-
static int Teamcenter::BusinessObject::fnd0FinalizeSaveAsInput ( std::vector< ::Teamcenter::BulkInput * > *  inputs,
::Teamcenter::BulkData bd 
)
staticinherited

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version
Teamcenter 11.2.3
Parameters
inputs- A vector of data that contains reference information to the object to be saved
bd- A data structure to store objects and other information relevant for set-based operation
Returns
-
int Teamcenter::BusinessObject::fnd0GenerateRecipe ( std::string *  recipe)
inherited

Generates permanent ID/recipe. Every Business Object should implement this operation.

Version
Teamcenter 11.1
Parameters
recipe- Permanent ID/recipe
Returns
- Failure code.
int Teamcenter::BusinessObject::fnd0GetChildren ( const std::vector< std::string > *  propertyNames,
std::vector< tag_t > *  childTags,
std::vector< std::string > *  childContextPropertyNames 
)
inherited

This operation returns the children to be displayed when expanding this object.

Version
Teamcenter 10
Parameters
propertyNames- The list of propertyNames to expand. If empty, then the properties defined in <TYPE>_DefaultChildProperties and <TYPE>_DefaultPseudoFolder are returned.
childTags- Tags of children.
childContextPropertyNames- The propertyName in which this child exists in the parent.
Returns
- status
static int Teamcenter::BusinessObject::fnd0GetDeepCopyData ( std::vector< ::Teamcenter::BulkInput * > *  getDeepCopydata,
::Teamcenter::BulkData bd 
)
staticinherited
Version
Teamcenter 11.4
Parameters
getDeepCopydata- This is the object to hold input information.
bd- This is the bulkData
Returns
-
int Teamcenter::BusinessObject::fnd0GetSerializationState ( bool *  currentState) const
inherited

Gets the current POM serialization state. Runtime Business Object does not need to implement this operation.

Version
Teamcenter 11.1
Parameters
currentState- Gets the current POM serialization state.
Returns
- Failure code
int Teamcenter::BusinessObject::fnd0IsRecoverable ( bool *  isPersistedRecipe,
bool *  isRecoverableIDSupported 
) const
inherited

If Business Object supports recoverable ID. Every Business Object should implement this operation.

Version
Teamcenter 11.1
Parameters
isPersistedRecipe- isPersistedRecipe param should be set to true if the recipe is limited to the user session and should be serialized to the database
isRecoverableIDSupported- Returning true indicates support for recoverability/permanent IDs
Returns
- Failure code.
static int Teamcenter::BusinessObject::fnd0PerformDeepCopy ( std::vector< ::Teamcenter::BulkInput * > *  inputs,
::Teamcenter::BulkData bd 
)
staticinherited

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version
Teamcenter 11.2.3
Parameters
inputs- A vector of data that contains reference information to the object to be saved
bd- A data structure to store objects and other information relevant for set-based operation
Returns
-
static int Teamcenter::BusinessObject::fnd0SaveAs ( std::vector< ::Teamcenter::BulkInput * > *  inputs,
::Teamcenter::BulkData bd 
)
staticinherited

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version
Teamcenter 11.2.3
Parameters
inputs- A vector of data that contains reference information to the object to be saved
bd- A data structure to store objects and other information relevant for set-based operation
Returns
-
static int Teamcenter::BusinessObject::fnd0SaveAsPost ( std::vector< ::Teamcenter::BulkInput * > *  inputs,
::Teamcenter::BulkData bd 
)
staticinherited

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version
Teamcenter 11.2.3
Parameters
inputs- A vector of data that contains reference information to the object to be saved
bd- A data structure to store objects and other information relevant for set-based operation
Returns
-
static int Teamcenter::BusinessObject::fnd0SetPropertiesFromCreateInput ( std::vector< ::Teamcenter::BulkInput * > *  inputs,
::Teamcenter::BulkData bd 
)
staticinherited

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version
Teamcenter 11.4
Parameters
inputs- A vector of data that contains reference information to the object to be created
bd- A data structure to store objects and other information relevant for set-based operation
Returns
-
static int Teamcenter::BusinessObject::fnd0SetPropertiesFromSaveAsInput ( std::vector< ::Teamcenter::BulkInput * > *  inputs,
::Teamcenter::BulkData bd 
)
staticinherited

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version
Teamcenter 11.2.3
Parameters
inputs- A vector of data that contains reference information to the object to be saved
bd- A data structure to store objects and other information relevant for set-based operation
Returns
-
int Teamcenter::BusinessObject::fnd0SetSerializationState ( bool  newState,
bool *  stateChanged 
)
inherited

Sets the current POM serialization state. Runtime Business Object does not need to implement this operation.

Version
Teamcenter 11.1
Parameters
newState- true marks the POM serialization recipe as out-of-date, false marks it as up-to-date.
stateChanged- true if the state has changed.
Returns
- Failure code
int Teamcenter::BusinessObject::fnd0SetSRUid ( const std::string *  uid)
inherited

This is the setter for the recipe/permanent ID when it is created (to be cached on the instance). Every Business Object should implement this operation.

Version
Teamcenter 11.1
Parameters
uid- Rrecipe/permanent ID
Returns
- Failure code.
static int Teamcenter::BusinessObject::fnd0ValidateCreateInput ( std::vector< ::Teamcenter::BulkInput * > *  inputs,
::Teamcenter::BulkData bd 
)
staticinherited

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version
Teamcenter 11.4
Parameters
inputs- A vector of data that contains reference information to the object to be created
bd- A data structure to store objects and other information relevant for set-based operation
Returns
-
static int Teamcenter::BusinessObject::fnd0ValidateSaveAsInput ( std::vector< ::Teamcenter::BulkInput * > *  inputs,
::Teamcenter::BulkData bd 
)
staticinherited

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version
Teamcenter 11.2.3
Parameters
inputs- A vector of data that contains reference information to the object to be saved
bd- A data structure to store objects and other information relevant for set-based operation
Returns
-
int Teamcenter::Awb0Element::getAwb0Archetype ( tag_t &  value,
bool &  isNull 
) const
inherited

Getter for a Tag Property

Version
ActiveWorkspace4.3
Parameters
value- Parameter value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0Element::getAwb0BreadcrumbAncestor ( tag_t &  value,
bool &  isNull 
) const
inherited

Getter for a Tag Property

Version
ActiveWorkspace3.4
Parameters
value- Parameter value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
Awb0ConnectionImpl* Teamcenter::Awb0Connection::getAwb0ConnectionImpl ( ) const
private
int Teamcenter::Awb0Element::getAwb0CsidPath ( std::string &  value,
bool &  isNull 
) const
inherited

Getter for a string Property

Version
ActiveWorkspace5.2
Parameters
value- Parameter value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0Element::getAwb0DisplayedName ( std::string &  value,
bool &  isNull 
) const
inherited

Getter for a string Property

Version
Teamcenter 10.1.5
Parameters
value- Parameter value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0Element::getAwb0DisplayedNameDisplayableValues ( std::vector< std::string > &  values)
inherited

Getter for Property Display Value

Version
ActiveWorkspace5.0
Parameters
values- Parameter value
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0ElementFilterState ( bool &  value,
bool &  isNull 
) const
inherited

Getter for a Boolean Property

Version
ActiveWorkspace6.3
Parameters
value- Parameter Value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0ElementVariantState ( bool &  value,
bool &  isNull 
) const
inherited

Getter for a Boolean Property

Version
ActiveWorkspace4.2
Parameters
value- Parameter Value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0Connection::getAwb0End1 ( tag_t &  value,
bool &  isNull 
) const

Getter for a Tag Property

Version
Teamcenter 9.1.2
Parameters
value- Parameter value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0Connection::getAwb0End2 ( tag_t &  value,
bool &  isNull 
) const

Getter for a Tag Property

Version
Teamcenter 9.1.2
Parameters
value- Parameter value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0HasAlternates ( bool &  value,
bool &  isNull 
) const
inherited

Getter for a Boolean Property

Version
ActiveWorkspace4.3
Parameters
value- Parameter Value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0HasAlternatesDisplayableValues ( std::vector< std::string > &  values)
inherited

Getter for Property Display Value

Version
ActiveWorkspace4.3
Parameters
values- Parameter value
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0HasInContextOverrides ( bool &  value,
bool &  isNull 
) const
inherited

Getter for a Boolean Property

Version
ActiveWorkspace4.3
Parameters
value- Parameter Value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0HasSubstitues ( bool &  value,
bool &  isNull 
) const
inherited

Getter for a Boolean Property

Version
ActiveWorkspace4.3
Parameters
value- Parameter Value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0HasSubstituesDisplayableValues ( std::vector< std::string > &  values)
inherited

Getter for Property Display Value

Version
ActiveWorkspace4.3
Parameters
values- Parameter value
Returns
- Status. 0 if successful
int Teamcenter::Awb0Element::getAwb0is_modifiable ( bool &  value,
bool &  isNull 
) const
inherited

Getter for a Boolean Property

Version
Teamcenter 9.1.2
Parameters
value- Parameter Value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0Element::getAwb0IsStructModifiable ( bool &  value,
bool &  isNull 
) const
inherited

Getter for a Boolean Property

Version
Teamcenter 9.1.2
Parameters
value- Parameter Value
isNull- Returns true if the Parameter value is null
Deprecated:
Teamcenter::Awb0Element::getAwb0IsStructModifiable deprecated in ActiveWorkspace3.2
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0MarkupPropertyNames ( std::vector< std::string > &  values,
std::vector< int > &  isNull 
) const
inherited

Getter for an String Array Property

Version
ActiveWorkspace4.1
Parameters
values- Parameter value
isNull- Returns true for an array element if the parameter value at that location is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0MarkupPropertyNamesDisplayableValues ( std::vector< std::string > &  values)
inherited

Getter for Property Display Value

Version
ActiveWorkspace4.1
Parameters
values- Parameter value
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0MarkupPropertyValues ( std::vector< std::string > &  values,
std::vector< int > &  isNull 
) const
inherited

Getter for an String Array Property

Version
ActiveWorkspace4.1
Parameters
values- Parameter value
isNull- Returns true for an array element if the parameter value at that location is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0MarkupPropertyValuesDisplayableValues ( std::vector< std::string > &  values)
inherited

Getter for Property Display Value

Version
ActiveWorkspace4.1
Parameters
values- Parameter value
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0MarkupType ( int &  value,
bool &  isNull 
) const
inherited

Getter for an Integer Property

Version
ActiveWorkspace4.2
Parameters
value- Parameter Value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0MarkupTypeDisplayableValues ( std::vector< std::string > &  values)
inherited

Getter for Property Display Value

Version
ActiveWorkspace5.1
Parameters
values- Parameter value
Returns
- Status. 0 if successful
int Teamcenter::Awb0Element::getAwb0NumberOfChildren ( int &  value,
bool &  isNull 
) const
inherited

Getter for an Integer Property

Version
Teamcenter 9.1.2
Parameters
value- Parameter Value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0OverriddenProperties ( std::vector< std::string > &  values,
std::vector< int > &  isNull 
) const
inherited

Getter for an String Array Property

Version
ActiveWorkspace4.3
Parameters
values- Parameter value
isNull- Returns true for an array element if the parameter value at that location is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0OverriddenPropertiesDisplayableValues ( std::vector< std::string > &  values)
inherited

Getter for Property Display Value

Version
ActiveWorkspace4.3
Parameters
values- Parameter value
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0OverrideContexts ( std::vector< std::string > &  values,
std::vector< int > &  isNull 
) const
inherited

Getter for an String Array Property

Version
ActiveWorkspace4.3
Parameters
values- Parameter value
isNull- Returns true for an array element if the parameter value at that location is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0Element::getAwb0Parent ( tag_t &  value,
bool &  isNull 
) const
inherited

Getter for a Tag Property

Version
Teamcenter 9.1.2
Parameters
value- Parameter value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0ConditionalElement::getAwb0PendingAction ( std::string &  value,
bool &  isNull 
) const
inherited

Getter for a string Property

Version
ActiveWorkspace4.2
Parameters
value- Parameter value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0Element::getAwb0ServiceAdapter ( std::string &  value,
bool &  isNull 
) const
inherited

Returns the adapter to manage Awb0Element

Version
ActiveWorkspace3.4
Parameters
value- Parameter value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::Awb0Element::getAwb0UnderlyingObject ( tag_t &  value,
bool &  isNull 
) const
inherited

Getter for a Tag Property

Version
Teamcenter 11.2.1
Parameters
value- Parameter value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::BusinessObject::getChar ( const std::string &  charName,
char &  charRetValue,
bool &  isNull,
bool &  hasReadAccess 
)
inherited

To Return the Character

Version
Teamcenter 2312
Parameters
charName- To return the character Name
charRetValue- The value of the Character
isNull- Is the Value Null
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getChar ( const std::string &  charName,
char &  charRetValue,
bool &  isNull 
)
inherited

To Return the Character

Version
Tc 8
Parameters
charName- To return the character Name
charRetValue- The value of the Character
isNull- Is the Value Null
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getCharArray ( const std::string &  charArrayName,
std::vector< char > &  vectorCharVals,
std::vector< int > &  vectorIsNullVals,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the Character array property

Version
Teamcenter 2312
Parameters
charArrayName- The Char array Name
vectorCharVals- Vector of char values
vectorIsNullVals- Is the Values Null
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getCharArray ( const std::string &  charArrayName,
std::vector< char > &  vectorCharVals,
std::vector< int > &  vectorIsNullVals 
)
inherited

The array of Character

Version
Tc 8
Parameters
charArrayName- The Char array Name
vectorCharVals- vector of char values
vectorIsNullVals- Is the Values Null
Returns
- Returns the Status as Integer
int Teamcenter::BusinessObject::getDate ( const std::string &  dateName,
date_t &  dateRetValue,
bool &  isNull,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the Date property

Version
Teamcenter 2312
Parameters
dateName- Name of the date property
dateRetValue- Value of the date property
isNull- is value null
hasReadAccess- Indicates whether the user has read access to the property.
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getDate ( const std::string &  dateName,
date_t &  dateRetValue,
bool &  isNull 
)
inherited

get date value

Version
Tc 8
Parameters
dateName- Name of the date property
dateRetValue- Value of the date property
isNull- is value Null
Returns
- status
int Teamcenter::BusinessObject::getDateArray ( const std::string &  dateArrayName,
std::vector< date_t > &  dateArrayRetValue,
std::vector< int > &  isNull,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the date array property

Version
Teamcenter 2312
Parameters
dateArrayName- Name of the date array property
dateArrayRetValue- Value of the date array property
isNull- is null values
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getDateArray ( const std::string &  dateArrayName,
std::vector< date_t > &  dateArrayRetValue,
std::vector< int > &  isNull 
)
inherited

get array of Date Values for a property

Version
Tc 8
Parameters
dateArrayName- Name of the date array property
dateArrayRetValue- Value of the date array
isNull- is null values
Returns
- status
int Teamcenter::BusinessObject::getDeepCopyData ( const std::string *  operation,
std::vector< ::Teamcenter::DeepCopyData * > *  deepCopyDatas 
)
inherited

gets deep copy data

Version
Teamcenter 9
Parameters
operation- operation desc
deepCopyDatas- desc
Returns
- returns an int
int Teamcenter::BusinessObject::getDouble ( const std::string &  doubleName,
double &  doubleRetValue,
bool &  isNull,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the Double array property

Version
Teamcenter 2312
Parameters
doubleName- The name of the double property
doubleRetValue- The value of the double property
isNull- Is the value null
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getDouble ( const std::string &  doubleName,
double &  doubleRetValue,
bool &  isNull 
)
inherited

To get the double value

Version
Tc 8
Parameters
doubleName- The name of the double variable
doubleRetValue- The value of the double variable
isNull- Is the value Null
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getDoubleArray ( const std::string &  doubleArrayName,
std::vector< double > &  vectorDoubleVals,
std::vector< int > &  vectorIsNullVals,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the Double array property

Version
Teamcenter 2312
Parameters
doubleArrayName- The name of the double array property
vectorDoubleVals- The values of the double array property
vectorIsNullVals- Is Value Null array
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getDoubleArray ( const std::string &  doubleArrayName,
std::vector< double > &  vectorDoubleVals,
std::vector< int > &  vectorIsNullVals 
)
inherited

Array of Doubles

Version
Tc 8
Parameters
doubleArrayName- The Array Name
vectorDoubleVals- Array of Doubles
vectorIsNullVals- Is the Value Null
Returns
- Return the status as Integer
int Teamcenter::BusinessObject::getInt ( const std::string &  intName,
int &  intRetValue,
bool &  isNull,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the Integer property

Version
Teamcenter 2312
Parameters
intName- The name of the Integer property
intRetValue- The value of the Integer property
isNull- Is the value null
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getInt ( const std::string &  intName,
int &  intRetValue,
bool &  isNull 
)
inherited

To get the Integer

Version
Tc 8
Parameters
intName- The name of the Integer
intRetValue- The value of the Integer
isNull- Is the value null
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getIntArray ( const std::string &  intArrayName,
std::vector< int > &  vectorIntVals,
std::vector< int > &  vectorIsNullVals,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the Integer array property

Version
Teamcenter 2312
Parameters
intArrayName- The name of the integer array property
vectorIntVals- The vector of integer values
vectorIsNullVals- Are the values null
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getIntArray ( const std::string &  intArrayName,
std::vector< int > &  vectorIntVals,
std::vector< int > &  vectorIsNullVals 
)
inherited

Array of Integers

Version
Tc 8
Parameters
intArrayName- The array name of integers
vectorIntVals- The Vector of Integer values
vectorIsNullVals- are the Values Null
Returns
- Returns the status as Integers
static const std::string& Teamcenter::Awb0Connection::getInterfaceName ( )
static

Get the Interface Name

Returns
- return desc for getInterfaceName
int Teamcenter::BusinessObject::getLogical ( const std::string &  logicalName,
bool &  boolRetValue,
bool &  isNull,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the Boolean property

Version
Teamcenter 2312
Parameters
logicalName- The name of the Boolean property
boolRetValue- The value of the boolean property
isNull- Is the value null
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getLogical ( const std::string &  logicalName,
bool &  boolRetValue,
bool &  isNull 
)
inherited

To get the Logical Value

Version
Tc 8
Parameters
logicalName- The name of the Logical Variable
boolRetValue- The logical value
isNull- Is the value null
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getLogicalArray ( const std::string &  logicalArrayName,
std::vector< int > &  vectorLogicalVals,
std::vector< int > &  vectorIsNullVals,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the Boolean array property

Version
Teamcenter 2312
Parameters
logicalArrayName- The name of the boolean array property
vectorLogicalVals- The vector of Logical values
vectorIsNullVals- Are the values null
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getLogicalArray ( const std::string &  logicalArrayName,
std::vector< int > &  vectorLogicalVals,
std::vector< int > &  vectorIsNullVals 
)
inherited

Array of Logical Values

Version
Tc 8
Parameters
logicalArrayName- Array of Logical Names
vectorLogicalVals- Vector of Logical Values
vectorIsNullVals- are the Value Null
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getObject_string ( std::string &  value,
bool &  isNull 
) const
inherited

Getter for a string Property

Version
Teamcenter 10
Parameters
value- Parameter value
isNull- Returns true if the Parameter value is null
Returns
- Status. 0 if successful
int Teamcenter::BusinessObject::getString ( const std::string &  stringName,
std::string &  stringRetValue,
bool &  isNull,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the String property

Version
Teamcenter 2312
Parameters
stringName- The name of the string property
stringRetValue- The value of the string property
isNull- Is the value null
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getString ( const std::string &  stringName,
std::string &  stringRetValue,
bool &  isNull 
)
inherited

Returns the String

Version
Tc 8
Parameters
stringName- The name of the String
stringRetValue- The value of the string
isNull- Is the String Null
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getStringArray ( const std::string &  stringArrayName,
std::vector< std::string > &  vectorStringVals,
std::vector< int > &  vectorIsNullVals,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the String array property

Version
Teamcenter 2312
Parameters
stringArrayName- The name of the string array property
vectorStringVals- The values of string array property
vectorIsNullVals- Are the values null
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getStringArray ( const std::string &  stringArrayName,
std::vector< std::string > &  vectorStringVals,
std::vector< int > &  vectorIsNullVals 
)
inherited

To get the StringArray

Version
Tc 8
Parameters
stringArrayName- The String name
vectorStringVals- Vector of Strings
vectorIsNullVals- vector of booleans
Returns
- Returns the status as Integer
tag_t Teamcenter::RootObject::getTag ( ) const
inherited
int Teamcenter::BusinessObject::getTag ( const std::string &  tagName,
tag_t &  tagRetValue,
bool &  isNull,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the reference property

Version
Teamcenter 2312
Parameters
tagName- The name of the reference property
tagRetValue- The value of the reference property
isNull- Is the value null
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getTag ( const std::string &  tagName,
tag_t &  tagRetValue,
bool &  isNull 
)
inherited

Returns the Tag

Version
Tc 8
Parameters
tagName- The name of the Tag
tagRetValue- The value of the Tag
isNull- Is the Value Null
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getTagArray ( const std::string &  tagArrayName,
std::vector< tag_t > &  vectorTagVals,
std::vector< int > &  vectorIsNullVals,
bool &  hasReadAccess 
)
inherited

To retrieve the values of the reference array property

Version
Teamcenter 2312
Parameters
tagArrayName- The name of the reference array property
vectorTagVals- The vector of values of reference array property
vectorIsNullVals- Are the values null
hasReadAccess- Indicates whether the user has read access to the property
Returns
- Returns the status as Integer
int Teamcenter::BusinessObject::getTagArray ( const std::string &  tagArrayName,
std::vector< tag_t > &  vectorTagVals,
std::vector< int > &  vectorIsNullVals 
)
inherited

Array of Tags

Version
Tc 8
Parameters
tagArrayName- Nameof the Tag Array
vectorTagVals- Vector of Tags
vectorIsNullVals- are the Value Null
Returns
- Returns the status as Integer
const std::string& Teamcenter::RootObject::getTypeName ( ) const
inherited
tag_t Teamcenter::RootObject::getTypeTag ( ) const
inherited
virtual void Teamcenter::RootObject::initialize ( RootObjectImpl *  impl = 0)
protectedvirtualinherited
virtual void Teamcenter::Awb0Connection::initialize ( ::Teamcenter::RootObjectImpl *  impl)
protectedvirtual
int Teamcenter::RootObject::invokeOperation ( const std::string *  operationId,
  ... 
)
inherited
int Teamcenter::RootObject::invokeOperation ( const std::string &  operationId,
va_list  args 
)
inherited
int Teamcenter::RootObject::invokeOperation ( int  operationIdInt,
va_list  args 
)
inherited
int Teamcenter::RootObject::invokeOperation ( const std::string &  operationId,
std::vector< void * > &  args 
)
inherited
int Teamcenter::RootObject::invokeOperation ( int  operationIdInt,
std::vector< void * > &  args 
)
inherited
Awb0Connection& Teamcenter::Awb0Connection::operator= ( const Awb0Connection )
private
int Teamcenter::BusinessObject::performDeepCopy ( ::Teamcenter::OperationInput pOperationInput,
std::vector< ::Teamcenter::DeepCopyData * > *  vecDeepCopyData 
)
inherited

perform deep copy

Version
Teamcenter 9
Parameters
pOperationInput- desc
vecDeepCopyData- deep copy data
Returns
- returns an int
int Teamcenter::BusinessObject::saveAs ( ::Teamcenter::SaveAsInput pSavAsInput,
std::vector< ::Teamcenter::DeepCopyData * > *  vecDeepCopyData,
tag_t *  newObjTag 
)
inherited

save as operation

Version
Teamcenter 9
Parameters
pSavAsInput- save as input
vecDeepCopyData- vector deepcopy data
newObjTag- new object tag
Returns
- returns an int
int Teamcenter::BusinessObject::saveAsPost ( ::Teamcenter::SaveAsInput pSavAsInput,
std::vector< ::Teamcenter::DeepCopyData * > *  vecDeepCopyData 
)
inherited

Generic saveAsPost operation.

Version
Teamcenter 8.1
Parameters
pSavAsInput- Input argument as SaveAsInput object.
vecDeepCopyData- vector deepcopy data
Returns
- Return integer value.
::Teamcenter::RootObjectImpl* Teamcenter::Awb0Connection::setAwb0ConnectionImpl ( ::Teamcenter::RootObjectImpl *  impl)
private
int Teamcenter::Awb0Element::setAwb0DisplayedName ( const std::string &  value,
bool  isNull = false 
)
inherited

Setter for a string Property

Version
Teamcenter 10.1.5
Parameters
value- Value to be set for the parameter
isNull- If true, set the parameter value to null
Returns
- Status. 0 if successful
int Teamcenter::Awb0Connection::setAwb0End1 ( const tag_t &  value,
bool  isNull = false 
)

Setter for a Tag Property

Version
Teamcenter 9.1.2
Parameters
value- Value to be set for the parameter
isNull- If true, set the parameter value to null
Returns
- Status. 0 if successful
int Teamcenter::Awb0Connection::setAwb0End2 ( const tag_t &  value,
bool  isNull = false 
)

Setter for a Tag Property

Version
Teamcenter 9.1.2
Parameters
value- Value to be set for the parameter
isNull- If true, set the parameter value to null
Returns
- Status. 0 if successful
int Teamcenter::Awb0Element::setAwb0Parent ( const tag_t &  value,
bool  isNull = false 
)
inherited

Setter for a Tag Property

Version
Teamcenter 9.1.2
Parameters
value- Value to be set for the parameter
isNull- If true, set the parameter value to null
Returns
- Status. 0 if successful
int Teamcenter::BusinessObject::setChar ( const std::string &  charName,
const char &  charValue,
bool  isNull 
)
inherited

To set the character

Version
Tc 8
Parameters
charName- The Name
charValue- The Character Value
isNull- Is the Value Null
Returns
- Returns an Integer
int Teamcenter::BusinessObject::setCharArray ( const std::string &  charArrayName,
const std::vector< char > &  vectorCharVals,
const std::vector< int > *  vectorIsNullVals 
)
inherited

To set the character array

Version
Tc 8
Parameters
charArrayName- charArrayName
vectorCharVals- vectorCharVals
vectorIsNullVals- vectorIsNullVals
Returns
- Returns an Integer
int Teamcenter::BusinessObject::setDate ( const std::string &  dateName,
const date_t &  dateValue,
bool  isNull 
)
inherited

To set the Date

Version
Tc 8
Parameters
dateName- dateName
dateValue- dateValue
isNull- isNull
Returns
- Returns an Integer
int Teamcenter::BusinessObject::setDateArray ( const std::string &  dateArrayName,
const std::vector< date_t > &  vectorDateVals,
const std::vector< int > *  vectorIsNullVals 
)
inherited

To set the Date Array

Version
Tc 8
Parameters
dateArrayName- dateArrayName
vectorDateVals- vectorDateVals
vectorIsNullVals- vectorIsNullVals
Returns
- Returns an Integer
void Teamcenter::Awb0Connection::setDeleteImpl ( bool  del)
private
int Teamcenter::BusinessObject::setDouble ( const std::string &  doubleName,
const double &  doubleValue,
bool  isNull 
)
inherited

To set the Double Value

Version
Tc 8
Parameters
doubleName- doubleName
doubleValue- doubleValue
isNull- isNull
Returns
- Returns an Integer
int Teamcenter::BusinessObject::setDoubleArray ( const std::string &  doubleArrayName,
const std::vector< double > &  vectorDoubleVals,
const std::vector< int > *  vectorIsNullVals 
)
inherited

To set the double array

Version
Tc 8
Parameters
doubleArrayName- doubleArrayName
vectorDoubleVals- vectorDoubleVals
vectorIsNullVals- vectorIsNullVals
Returns
- Returns an Integer
int Teamcenter::BusinessObject::setInt ( const std::string &  intName,
const int &  intValue,
bool  isNull 
)
inherited

To set an Integer

Version
Tc 8
Parameters
intName- The name of the integer
intValue- The Integer Value
isNull- Is the value Null
Returns
- Returns status as Integer
int Teamcenter::BusinessObject::setIntArray ( const std::string &  intArrayName,
const std::vector< int > &  vectorIntVals,
const std::vector< int > *  vectorIsNullVals 
)
inherited

To the the Array of Integer type data on BusinessObject

Version
Tc 8
Parameters
intArrayName- name of the integer array
vectorIntVals- vector or array of integer values
vectorIsNullVals- vector of isNulls
Returns
- success or failure
int Teamcenter::BusinessObject::setLogical ( const std::string &  logicalName,
const bool  logicalValue,
bool  isNull 
)
inherited

To set the Logical Value

Version
Tc 8
Parameters
logicalName- logicalName
logicalValue- logicalValue
isNull- isNull
Returns
- Returns an Integer
int Teamcenter::BusinessObject::setLogicalArray ( const std::string &  boolArrayName,
const std::vector< int > &  vectorboolVals,
const std::vector< int > *  vectorIsNullVals 
)
inherited

To set Logical Array

Version
Tc 8
Parameters
boolArrayName- boolArrayName
vectorboolVals- vectorboolVals
vectorIsNullVals- vectorIsNullVals
Returns
- Returns an Integer
int Teamcenter::BusinessObject::setPropertiesFromCreateInput ( ::Teamcenter::CreateInput creInput)
inherited

desc for setPropertiesFromCreateInpu

Version
Tc 8
Parameters
creInput- Description for CreateInput
Returns
- return desc for setPropertiesFromCreateInput
int Teamcenter::BusinessObject::setPropertiesFromSaveAsInput ( ::Teamcenter::SaveAsInput pSavAsInput)
inherited

setproperties from saveas input

Version
Teamcenter 9
Parameters
pSavAsInput- desc
Returns
- returns an int
int Teamcenter::BusinessObject::setString ( const std::string &  stringName,
const std::string &  stringValue,
bool  isNull 
)
inherited

To set the String

Version
Tc 8
Parameters
stringName- stringName
stringValue- stringValue
isNull- isNull
Returns
- Returns an Integer
int Teamcenter::BusinessObject::setStringArray ( const std::string &  stringArrayName,
const std::vector< std::string > &  vectorStringVals,
const std::vector< int > *  vectorIsNullVals 
)
inherited

To set the string array

Version
Tc 8
Parameters
stringArrayName- stringArrayName
vectorStringVals- vectorStringVals
vectorIsNullVals- vectorIsNullVals
Returns
- Returns an integer
void Teamcenter::RootObject::setTag ( tag_t  tag)
protectedinherited
int Teamcenter::BusinessObject::setTag ( const std::string &  tagName,
const tag_t &  tagValue,
bool  isNull 
)
inherited

To set the tag

Version
Tc 8
Parameters
tagName- tagName
tagValue- tagValue
isNull- isNull
Returns
- Returns an Integer
int Teamcenter::BusinessObject::setTagArray ( const std::string &  tagArrayName,
const std::vector< tag_t > &  vectorTagVals,
const std::vector< int > *  vectorIsNullVals 
)
inherited

To set the Tag Array

Version
Tc 8
Parameters
tagArrayName- tagArrayName
vectorTagVals- vectorTagVals
vectorIsNullVals- vectorIsNullVals
Returns
- Returns an Integer
int Teamcenter::BusinessObject::validateCreateInput ( ::Teamcenter::CreateInput creInput)
inherited

desc for validate for create

Version
Tc 8
Parameters
creInput- desc for creInput parameter
Returns
- ret desc for validate for create
int Teamcenter::BusinessObject::validateSaveAsInput ( ::Teamcenter::SaveAsInput pSavAsInput,
std::vector< ::Teamcenter::DeepCopyData * > *  vecDeepCopyData 
)
inherited

validate saveas input

Version
Teamcenter 9
Parameters
pSavAsInput- desc
vecDeepCopyData- desc
Returns
- returns an int

Friends And Related Function Documentation

friend class Awb0ConnectionDelegate
friend

Definition at line 139 of file Awb0Connection.hxx.

friend class Awb0ConnectionGenImpl
friend

Definition at line 140 of file Awb0Connection.hxx.

Member Data Documentation

Awb0ConnectionImpl* Teamcenter::Awb0Connection::m_awb0connectionImpl
private

Definition at line 122 of file Awb0Connection.hxx.

bool Teamcenter::Awb0Connection::m_deleteImpl
private

Definition at line 125 of file Awb0Connection.hxx.

std::string Teamcenter::Awb0Connection::name
staticprivate

Name of the Business Object

Definition at line 130 of file Awb0Connection.hxx.


The documentation for this class was generated from the following file: