Teamcenter C++ API Reference  2312
Signoff.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, Signoff
12  Filename: Signoff.hxx
13  Module: epm
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef TEAMCENTER__SIGNOFF__HXX
18 #define TEAMCENTER__SIGNOFF__HXX
19 
20 #include <unidefs.h>
21 #include <string>
22 #include <vector>
23 #include <common/tc_deprecation_macros.h>
25 
26 #include <epm/libepm_exports.h>
27 
28 namespace Teamcenter
29 {
30  class Signoff;
31 }
32 namespace Teamcenter
33 {
34  class SignoffImpl;
35 }
36 namespace Teamcenter
37 {
38  class SignoffDelegate;
39 }
40 namespace Teamcenter
41 {
42  class SignoffDispatch;
43 }
44 namespace Teamcenter
45 {
46  class SignoffGenImpl;
47 }
48 namespace Teamcenter
49 {
50  class RootObjectImpl;
51 }
52 
53 class EPM_API Teamcenter::Signoff
55 {
56 public:
57 
62  static const std::string& getInterfaceName();
63 
64 
72  int getActive_surrogate( tag_t &value, bool &isNull ) const;
73 
81  int getComments( std::string &value, bool &isNull ) const;
82 
90  int getDecision( int &value, bool &isNull ) const;
91 
99  int getDecision_date( date_t &value, bool &isNull ) const;
100 
108  int getDue_date( date_t &value, bool &isNull ) const;
109 
117  int getFnd0Assignee( tag_t &value, bool &isNull ) const;
118 
126  int getFnd0AssigneeGroupRole( std::string &value, bool &isNull ) const;
127 
135  int getFnd0AssigneeOrigin( tag_t &value, bool &isNull ) const;
136 
144  int getFnd0Assigner( tag_t &value, bool &isNull ) const;
145 
153  int getFnd0DecisionRequired( std::string &value, bool &isNull ) const;
154 
162  int getFnd0ParentTask( tag_t &value, bool &isNull ) const;
163 
171  int getFnd0Performer( tag_t &value, bool &isNull ) const;
172 
180  int getFnd0Priority( std::string &value, bool &isNull ) const;
181 
189  int getFnd0StartDate( date_t &value, bool &isNull ) const;
190 
198  int getFnd0WorkflowInitiator( tag_t &value, bool &isNull ) const;
199 
207  int getGroup_member( tag_t &value, bool &isNull ) const;
208 
216  int getIs_mine_to_perform( bool &value, bool &isNull ) const;
217 
225  int getIs_modifiable( bool &value, bool &isNull ) const;
226 
234  int getIs_valid_surrogate( bool &value, bool &isNull ) const;
235 
243  int getJob_name( std::string &value, bool &isNull ) const;
244 
252  int getObject_desc( std::string &value, bool &isNull ) const;
253 
261  int getObject_name( std::string &value, bool &isNull ) const;
262 
270  int getObject_type( std::string &value, bool &isNull ) const;
271 
279  int getOrigin( tag_t &value, bool &isNull ) const;
280 
288  int getOriginated_from( int &value, bool &isNull ) const;
289 
297  int getProfile( tag_t &value, bool &isNull ) const;
298 
306  int getResource_pool( tag_t &value, bool &isNull ) const;
307 
315  int getRoot_reference_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
316 
324  int getRoot_target_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
325 
333  int getSignoff_action( int &value, bool &isNull ) const;
334 
342  int getSignoff_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
343 
351  int getSignoff_member( tag_t &value, bool &isNull ) const;
352 
360  int getSignoff_type( int &value, bool &isNull ) const;
361 
369  int getUser_access( bool &value, bool &isNull ) const;
370 
378  int setActive_surrogate( const tag_t &value, bool isNull=false );
379 
387  int setComments( const std::string &value, bool isNull=false );
388 
396  int setDecision( int value, bool isNull=false );
397 
405  int setDecision_date( const date_t &value, bool isNull=false );
406 
414  int setDue_date( const date_t &value, bool isNull=false );
415 
423  int setFnd0DecisionRequired( const std::string &value, bool isNull=false );
424 
432  int setGroup_member( const tag_t &value, bool isNull=false );
433 
441  int setOrigin( const tag_t &value, bool isNull=false );
442 
450  int setOriginated_from( int value, bool isNull=false );
451 
459  int setResource_pool( const tag_t &value, bool isNull=false );
460 
468  int setRoot_reference_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
469 
477  int setRoot_target_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
478 
486  int setSignoff_action( int value, bool isNull=false );
487 
495  int setSignoff_member( const tag_t &value, bool isNull=false );
496 protected:
497  // Method to initialize
498  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
499 
503  Signoff();
504 
508  virtual ~Signoff();
509 
510 private:
511  // Getter method for the Implementation Object
512  SignoffImpl* getSignoffImpl() const;
513  // Setter method for the Implementation Object
514  ::Teamcenter::RootObjectImpl* setSignoffImpl( ::Teamcenter::RootObjectImpl* impl );
515 
516  // Method to set the delete impl boolean
517  void setDeleteImpl( bool del );
518 
519  // Pointer to the Implementation object
520  SignoffImpl* m_signoffImpl;
521 
522  // Flag to indicate if Implementation object needs to be deleted
524 
528  static std::string name;
529 
534  Signoff( const Signoff& );
535  Signoff& operator=( const Signoff& );
536 
537  friend class SignoffDelegate;
538  friend class SignoffGenImpl;
539 };
540 
541 #include <epm/libepm_undef.h>
542 #endif // TEAMCENTER__SIGNOFF__HXX