Teamcenter C++ API Reference  2312
WorkspaceObject.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, WorkspaceObject
12  Filename: WorkspaceObject.hxx
13  Module: tccore
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef TEAMCENTER__WORKSPACEOBJECT__HXX
18 #define TEAMCENTER__WORKSPACEOBJECT__HXX
19 
20 #include <vector>
23 #include <string>
24 #include <unidefs.h>
25 #include <common/tc_deprecation_macros.h>
27 
28 #include <tccore/libtccore_exports.h>
29 
30 namespace Teamcenter
31 {
32  class WorkspaceObject;
33 }
34 namespace Teamcenter
35 {
36  class WorkspaceObjectImpl;
37 }
38 namespace Teamcenter
39 {
40  class WorkspaceObjectDelegate;
41 }
42 namespace Teamcenter
43 {
44  class WorkspaceObjectDispatch;
45 }
46 namespace Teamcenter
47 {
48  class WorkspaceObjectGenImpl;
49 }
50 namespace Teamcenter
51 {
52  class RootObjectImpl;
53 }
54 
55 class TCCORE_API Teamcenter::WorkspaceObject
57 {
58 public:
59 
64  static const std::string& getInterfaceName();
65 
66 
74  int getActive_seq( int &value, bool &isNull ) const;
75 
83  int getDate_released( date_t &value, bool &isNull ) const;
84 
92  int getEad_paragraph( std::vector< std::string > &values, std::vector< int > &isNull ) const;
93 
101  int getFnd0complying_objects( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
102 
110  int getFnd0defining_objects( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
111 
119  int getFnd0GeneralAuditLogs( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
120 
128  int getFnd0HasEditInContext( bool &value, bool &isNull ) const;
129 
137  int getFnd0IcsClassNames( std::vector< std::string > &values, std::vector< int > &isNull ) const;
138 
146  int getFnd0IsCheckoutable( bool &value, bool &isNull ) const;
147 
155  int getFnd0LicenseExportAuditLogs( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
156 
164  int getFnd0MyWorkflowTasks( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
165 
173  int getFnd0RevisionId( std::string &value, bool &isNull ) const;
174 
182  int getFnd0SecurityAuditLogs( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
183 
191  int getFnd0SiblingRevisions( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
192 
200  int getFnd0WorkflowAuditLogs( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
201 
209  int getGov_classification( std::string &value, bool &isNull ) const;
210 
218  int getIp_classification( std::string &value, bool &isNull ) const;
219 
227  int getLicense_list( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
228 
236  int getObject_application( std::string &value, bool &isNull ) const;
237 
245  int getObject_desc( std::string &value, bool &isNull ) const;
246 
255  int getObject_desc( std::string &value, bool &isNull, bool &hasReadAccess ) const;
256 
264  int getObject_name( std::string &value, bool &isNull ) const;
265 
273  int getObject_type( std::string &value, bool &isNull ) const;
274 
282  int getOwning_organization( tag_t &value, bool &isNull ) const;
283 
291  int getOwning_project( tag_t &value, bool &isNull ) const;
292 
300  int getProcess_stage_list( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
301 
309  int getProject_list( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
310 
318  int getRelease_status_list( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
319 
327  int getRevision_limit( int &value, bool &isNull ) const;
328 
336  int getRevision_number( int &value, bool &isNull ) const;
337 
345  int getWso_thread( tag_t &value, bool &isNull ) const;
346 
354  int setActive_seq( int value, bool isNull=false );
355 
363  int setDate_released( const date_t &value, bool isNull=false );
364 
372  int setGov_classification( const std::string &value, bool isNull=false );
373 
381  int setIp_classification( const std::string &value, bool isNull=false );
382 
390  int setLicense_list( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
391 
399  int setObject_application( const std::string &value, bool isNull=false );
400 
408  int setObject_desc( const std::string &value, bool isNull=false );
409 
417  int setObject_name( const std::string &value, bool isNull=false );
418 
426  int setObject_type( const std::string &value, bool isNull=false );
427 
435  int setOwning_organization( const tag_t &value, bool isNull=false );
436 
444  int setOwning_project( const tag_t &value, bool isNull=false );
445 
453  int setProcess_stage_list( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
454 
462  int setProject_list( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
463 
471  int setRelease_status_list( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
472 
480  int setRevision_limit( int value, bool isNull=false );
481 
489  int setRevision_number( int value, bool isNull=false );
490 
498  int setWso_thread( const tag_t &value, bool isNull=false );
499 
508  static int fnd0assignObjectsToProjects( std::vector< ::Teamcenter::BulkInput* > *wsoBi, ::Teamcenter::BulkData *bd, bool alwaysPropagate );
509 
519  int fnd0CheckIfPropertyValueMatches( const std::string &propertyName, const std::string &expectedValue, const bool &matchAll, bool *result ) const;
520 
527  int fnd0postCloneAction( const tag_t *originalItem );
528 
536  static int fnd0removeObjectsFromProjects( std::vector< ::Teamcenter::BulkInput* > *wsoBi, ::Teamcenter::BulkData *bd );
537 
544  int isMature( bool *result );
545 protected:
546  // Method to initialize
547  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
548 
552  WorkspaceObject();
553 
557  virtual ~WorkspaceObject();
558 
559 private:
560  // Getter method for the Implementation Object
561  WorkspaceObjectImpl* getWorkspaceObjectImpl() const;
562  // Setter method for the Implementation Object
563  ::Teamcenter::RootObjectImpl* setWorkspaceObjectImpl( ::Teamcenter::RootObjectImpl* impl );
564 
565  // Method to set the delete impl boolean
566  void setDeleteImpl( bool del );
567 
568  // Pointer to the Implementation object
569  WorkspaceObjectImpl* m_workspaceobjectImpl;
570 
571  // Flag to indicate if Implementation object needs to be deleted
573 
577  static std::string name;
578 
585 
586  friend class WorkspaceObjectDelegate;
587  friend class WorkspaceObjectGenImpl;
588 };
589 
590 #include <tccore/libtccore_undef.h>
591 #endif // TEAMCENTER__WORKSPACEOBJECT__HXX