Teamcenter C++ API Reference  2312
BusinessObject.hxx
Go to the documentation of this file.
1 //Copyright 2022 Siemens Digital Industries Software
2 //==================================================
3 //Copyright $2023.
4 //Siemens Product Lifecycle Management Software Inc.
5 //All Rights Reserved.
6 //==================================================
7 //Copyright 2022 Siemens Digital Industries Software
8 
9 /*==================================================================================================
10 File description:
11  This file contains the declaration for the Business Object, BusinessObject
12  Filename: BusinessObject.hxx
13  Module: metaframework
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef TEAMCENTER__BUSINESSOBJECT__HXX
18 #define TEAMCENTER__BUSINESSOBJECT__HXX
19 
20 #include <string>
21 #include <metaframework/BulkInput.hxx>
22 #include <metaframework/BulkData.hxx>
23 #include <vector>
24 #include <unidefs.h>
25 #include <metaframework/DeepCopyData.hxx>
26 #include <metaframework/OperationInput.hxx>
27 #include <metaframework/CreateInput.hxx>
28 #include <metaframework/SaveAsInput.hxx>
29 #include <common/tc_deprecation_macros.h>
30 #include <metaframework/RootObject.hxx>
31 
32 #include <metaframework/libmetaframework_exports.h>
33 
34 namespace Teamcenter
35 {
36  class BusinessObject;
37 }
38 namespace Teamcenter
39 {
40  class BusinessObjectImpl;
41 }
42 namespace Teamcenter
43 {
44  class BusinessObjectDelegate;
45 }
46 namespace Teamcenter
47 {
48  class BusinessObjectDispatch;
49 }
50 namespace Teamcenter
51 {
52  class BusinessObjectGenImpl;
53 }
54 namespace Teamcenter
55 {
56  class RootObjectImpl;
57 }
58 
59 class METAFRAMEWORK_API Teamcenter::BusinessObject
60  : public ::Teamcenter::RootObject
61 {
62 public:
63 
64  using ::Teamcenter::RootObject::getTag;
65  using ::Teamcenter::RootObject::setTag;
66 
71  static const std::string& getInterfaceName();
72 
73 
81  int getObject_string( std::string &value, bool &isNull ) const;
82 
90  int fnd0AskSRUid( std::string *uid, bool *isFirstTime ) const;
91 
99  static int fnd0Create( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
100 
108  static int fnd0CreatePost( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
109 
117  static int fnd0FinalizeCreateInput( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
118 
126  static int fnd0FinalizeSaveAsInput( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
127 
134  int fnd0GenerateRecipe( std::string *recipe );
135 
145  int getChar( const std::string &charName, char &charRetValue, bool &isNull, bool &hasReadAccess );
146 
156  int getCharArray( const std::string &charArrayName, std::vector< char > &vectorCharVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess );
157 
166  int fnd0GetChildren( const std::vector< std::string > *propertyNames, std::vector< tag_t > *childTags, std::vector< std::string > *childContextPropertyNames );
167 
177  int getDate( const std::string &dateName, date_t &dateRetValue, bool &isNull, bool &hasReadAccess );
178 
188  int getDateArray( const std::string &dateArrayName, std::vector< date_t > &dateArrayRetValue, std::vector< int > &isNull, bool &hasReadAccess );
189 
197  static int fnd0GetDeepCopyData( std::vector< ::Teamcenter::BulkInput* > *getDeepCopydata, ::Teamcenter::BulkData *bd );
198 
208  int getDouble( const std::string &doubleName, double &doubleRetValue, bool &isNull, bool &hasReadAccess );
209 
219  int getDoubleArray( const std::string &doubleArrayName, std::vector< double > &vectorDoubleVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess );
220 
230  int getInt( const std::string &intName, int &intRetValue, bool &isNull, bool &hasReadAccess );
231 
241  int getIntArray( const std::string &intArrayName, std::vector< int > &vectorIntVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess );
242 
252  int getLogical( const std::string &logicalName, bool &boolRetValue, bool &isNull, bool &hasReadAccess );
253 
263  int getLogicalArray( const std::string &logicalArrayName, std::vector< int > &vectorLogicalVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess );
264 
271  int fnd0GetSerializationState( bool *currentState ) const;
272 
282  int getString( const std::string &stringName, std::string &stringRetValue, bool &isNull, bool &hasReadAccess );
283 
293  int getStringArray( const std::string &stringArrayName, std::vector< std::string > &vectorStringVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess );
294 
304  int getTag( const std::string &tagName, tag_t &tagRetValue, bool &isNull, bool &hasReadAccess );
305 
315  int getTagArray( const std::string &tagArrayName, std::vector< tag_t > &vectorTagVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess );
316 
324  int fnd0IsRecoverable( bool *isPersistedRecipe, bool *isRecoverableIDSupported ) const;
325 
333  static int fnd0PerformDeepCopy( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
334 
342  static int fnd0SaveAs( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
343 
351  static int fnd0SaveAsPost( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
352 
360  static int fnd0SetPropertiesFromCreateInput( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
361 
369  static int fnd0SetPropertiesFromSaveAsInput( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
370 
378  int fnd0SetSerializationState( bool newState, bool *stateChanged );
379 
386  int fnd0SetSRUid( const std::string *uid );
387 
395  static int fnd0ValidateCreateInput( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
396 
404  static int fnd0ValidateSaveAsInput( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
405 
414  int getChar( const std::string &charName, char &charRetValue, bool &isNull );
415 
424  int getCharArray( const std::string &charArrayName, std::vector< char > &vectorCharVals, std::vector< int > &vectorIsNullVals );
425 
434  int getDate( const std::string &dateName, date_t &dateRetValue, bool &isNull );
435 
444  int getDateArray( const std::string &dateArrayName, std::vector< date_t > &dateArrayRetValue, std::vector< int > &isNull );
445 
453  int getDeepCopyData( const std::string *operation, std::vector< ::Teamcenter::DeepCopyData* > *deepCopyDatas );
454 
463  int getDouble( const std::string &doubleName, double &doubleRetValue, bool &isNull );
464 
473  int getDoubleArray( const std::string &doubleArrayName, std::vector< double > &vectorDoubleVals, std::vector< int > &vectorIsNullVals );
474 
483  int getInt( const std::string &intName, int &intRetValue, bool &isNull );
484 
493  int getIntArray( const std::string &intArrayName, std::vector< int > &vectorIntVals, std::vector< int > &vectorIsNullVals );
494 
503  int getLogical( const std::string &logicalName, bool &boolRetValue, bool &isNull );
504 
513  int getLogicalArray( const std::string &logicalArrayName, std::vector< int > &vectorLogicalVals, std::vector< int > &vectorIsNullVals );
514 
523  int getString( const std::string &stringName, std::string &stringRetValue, bool &isNull );
524 
533  int getStringArray( const std::string &stringArrayName, std::vector< std::string > &vectorStringVals, std::vector< int > &vectorIsNullVals );
534 
543  int getTag( const std::string &tagName, tag_t &tagRetValue, bool &isNull );
544 
553  int getTagArray( const std::string &tagArrayName, std::vector< tag_t > &vectorTagVals, std::vector< int > &vectorIsNullVals );
554 
562  int performDeepCopy( ::Teamcenter::OperationInput *pOperationInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
563 
572  int setChar( const std::string &charName, const char &charValue, bool isNull );
573 
582  int setCharArray( const std::string &charArrayName, const std::vector< char > &vectorCharVals, const std::vector< int > *vectorIsNullVals );
583 
592  int setDate( const std::string &dateName, const date_t &dateValue, bool isNull );
593 
602  int setDateArray( const std::string &dateArrayName, const std::vector< date_t > &vectorDateVals, const std::vector< int > *vectorIsNullVals );
603 
612  int setDouble( const std::string &doubleName, const double &doubleValue, bool isNull );
613 
622  int setDoubleArray( const std::string &doubleArrayName, const std::vector< double > &vectorDoubleVals, const std::vector< int > *vectorIsNullVals );
623 
632  int setInt( const std::string &intName, const int &intValue, bool isNull );
633 
642  int setIntArray( const std::string &intArrayName, const std::vector< int > &vectorIntVals, const std::vector< int > *vectorIsNullVals );
643 
652  int setLogical( const std::string &logicalName, const bool logicalValue, bool isNull );
653 
662  int setLogicalArray( const std::string &boolArrayName, const std::vector< int > &vectorboolVals, const std::vector< int > *vectorIsNullVals );
663 
672  int setString( const std::string &stringName, const std::string &stringValue, bool isNull );
673 
682  int setStringArray( const std::string &stringArrayName, const std::vector< std::string > &vectorStringVals, const std::vector< int > *vectorIsNullVals );
683 
692  int setTag( const std::string &tagName, const tag_t &tagValue, bool isNull );
693 
702  int setTagArray( const std::string &tagArrayName, const std::vector< tag_t > &vectorTagVals, const std::vector< int > *vectorIsNullVals );
703 
710  int create( ::Teamcenter::CreateInput *creInput );
711 
718  int createPost( ::Teamcenter::CreateInput *creInput );
719 
726  int finalizeCreateInput( ::Teamcenter::CreateInput *creInput );
727 
735  int finalizeSaveAsInput( ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
736 
745  int saveAs( ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData, tag_t *newObjTag );
746 
754  int saveAsPost( ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
755 
762  int setPropertiesFromCreateInput( ::Teamcenter::CreateInput *creInput );
763 
770  int setPropertiesFromSaveAsInput( ::Teamcenter::SaveAsInput *pSavAsInput );
771 
778  int validateCreateInput( ::Teamcenter::CreateInput *creInput );
779 
787  int validateSaveAsInput( ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
788 protected:
789  // Method to initialize
790  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
791 
795  BusinessObject();
796 
800  virtual ~BusinessObject();
801 
802 private:
803  // Getter method for the Implementation Object
804  BusinessObjectImpl* getBusinessObjectImpl() const;
805  // Setter method for the Implementation Object
806  ::Teamcenter::RootObjectImpl* setBusinessObjectImpl( ::Teamcenter::RootObjectImpl* impl );
807 
808  // Method to set the delete impl boolean
809  void setDeleteImpl( bool del );
810 
811  // Pointer to the Implementation object
812  BusinessObjectImpl* m_businessobjectImpl;
813 
814  // Flag to indicate if Implementation object needs to be deleted
815  bool m_deleteImpl;
816 
820  static std::string name;
821 
826  BusinessObject( const BusinessObject& );
827  BusinessObject& operator=( const BusinessObject& );
828 
829  friend class BusinessObjectDelegate;
830  friend class BusinessObjectGenImpl;
831 };
832 
833 #include <metaframework/libmetaframework_undef.h>
834 #endif // TEAMCENTER__BUSINESSOBJECT__HXX