Teamcenter C++ API Reference  2312
EPMTask.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, EPMTask
12  Filename: EPMTask.hxx
13  Module: epm
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef TEAMCENTER__EPMTASK__HXX
18 #define TEAMCENTER__EPMTASK__HXX
19 
20 #include <vector>
21 #include <unidefs.h>
22 #include <string>
23 #include <common/tc_deprecation_macros.h>
24 #include <tccore/WorkspaceObject.hxx>
25 
26 #include <epm/libepm_exports.h>
27 
28 namespace Teamcenter
29 {
30  class EPMTask;
31 }
32 namespace Teamcenter
33 {
34  class EPMTaskImpl;
35 }
36 namespace Teamcenter
37 {
38  class EPMTaskDelegate;
39 }
40 namespace Teamcenter
41 {
42  class EPMTaskDispatch;
43 }
44 namespace Teamcenter
45 {
46  class EPMTaskGenImpl;
47 }
48 namespace Teamcenter
49 {
50  class RootObjectImpl;
51 }
52 
53 class EPM_API Teamcenter::EPMTask
54  : public ::Teamcenter::WorkspaceObject
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 getChild_tasks( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
82 
90  int getComment_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
91 
99  int getComplete_node_location( std::string &value, bool &isNull ) const;
100 
108  int getCondition_result( int &value, bool &isNull ) const;
109 
117  int getConflict_tasks( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
118 
126  int getDue_date( date_t &value, bool &isNull ) const;
127 
135  int getEpm_subprocesses( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
136 
144  int getFnd0ActualDuration( int &value, bool &isNull ) const;
145 
153  int getFnd0Assignee( tag_t &value, bool &isNull ) const;
154 
162  int getFnd0EndDate( date_t &value, bool &isNull ) const;
163 
171  int getFnd0IsPKIAuthRequired( bool &value, bool &isNull ) const;
172 
180  int getFnd0IsValidPerformer( bool &value, bool &isNull ) const;
181 
189  int getFnd0MyTaskExecutionErrors( std::vector< std::string > &values, std::vector< int > &isNull ) const;
190 
198  int getFnd0MyTaskExecutionStatus( int &value, bool &isNull ) const;
199 
207  int getFnd0ObjectsToDigitallySign( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
208 
216  int getFnd0rootCMImpactedItems( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
217 
225  int getFnd0rootCMProblemItems( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
226 
234  int getFnd0rootCMSolutionItems( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
235 
243  int getFnd0RootReplicaTargets( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
244 
252  int getFnd0RootScheduleTask( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
253 
261  int getFnd0ScheduleCategory( int &value, bool &isNull ) const;
262 
270  int getFnd0StartDate( date_t &value, bool &isNull ) const;
271 
279  int getFnd0TaskExecutionStatuses( std::vector< std::string > &values, std::vector< int > &isNull ) const;
280 
288  int getFnd0WorkflowTaskLogs( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
289 
297  int getHas_failure_paths( bool &value, bool &isNull ) const;
298 
306  int getHas_surrogate( bool &value, bool &isNull ) const;
307 
315  int getIconKey( std::string &value, bool &isNull ) const;
316 
324  int getInstruction_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
325 
333  int getInterprocess_task_dependencies( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
334 
342  int getIs_valid_surrogate( bool &value, bool &isNull ) const;
343 
351  int getJob_name( std::string &value, bool &isNull ) const;
352 
360  int getLate_flag( bool &value, bool &isNull ) const;
361 
369  int getLocation( std::string &value, bool &isNull ) const;
370 
378  int getMy_signoff_completed( bool &value, bool &isNull ) const;
379 
387  int getNext_task( tag_t &value, bool &isNull ) const;
388 
396  int getNum_targets( int &value, bool &isNull ) const;
397 
405  int getParent_name( std::string &value, bool &isNull ) const;
406 
414  int getParent_process( tag_t &value, bool &isNull ) const;
415 
423  int getParent_processes( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
424 
432  int getParent_processes_states( std::vector< std::string > &values, std::vector< int > &isNull ) const;
433 
441  int getPath_type( std::vector< std::string > &values, std::vector< int > &isNull ) const;
442 
450  int getPredecessors( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
451 
459  int getPrevious_task( tag_t &value, bool &isNull ) const;
460 
468  int getProcess_paths( std::vector< std::string > &values, std::vector< int > &isNull ) const;
469 
477  int getProject_task_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
478 
486  int getReal_state( std::string &value, bool &isNull ) const;
487 
495  int getRecipients( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
496 
504  int getReference_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
505 
513  int getRelease_status_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
514 
522  int getResp_party( std::string &value, bool &isNull ) const;
523 
531  int getResponsible_party( tag_t &value, bool &isNull ) const;
532 
540  int getRoot_reference_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
541 
549  int getRoot_target_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
550 
558  int getRoot_task( tag_t &value, bool &isNull ) const;
559 
567  int getSecure_task( bool &value, bool &isNull ) const;
568 
576  int getSignoff_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
577 
585  int getSignoff_profiles( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
586 
594  int getSignoff_quorum( int &value, bool &isNull ) const;
595 
603  int getStart_node_location( std::string &value, bool &isNull ) const;
604 
612  int getState( int &value, bool &isNull ) const;
613 
621  int getSub_processes( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
622 
630  int getSub_processes_states( std::vector< std::string > &values, std::vector< int > &isNull ) const;
631 
639  int getSuccessors( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
640 
648  int getTarget_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
649 
657  int getTask_duration( int &value, bool &isNull ) const;
658 
666  int getTask_state( std::string &value, bool &isNull ) const;
667 
675  int getTask_type( std::string &value, bool &isNull ) const;
676 
684  int getThe_task_duration( std::vector< std::string > &values, std::vector< int > &isNull ) const;
685 
693  int getUser_all_signoffs( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
694 
702  int getValid_signoffs( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
703 
711  int getViewed_by_me( bool &value, bool &isNull ) const;
712 
720  int getWork_context( tag_t &value, bool &isNull ) const;
721 
729  int setActive_surrogate( const tag_t &value, bool isNull=false );
730 
738  int setComment_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
739 
747  int setComplete_node_location( const std::string &value, bool isNull=false );
748 
756  int setCondition_result( int value, bool isNull=false );
757 
765  int setDue_date( const date_t &value, bool isNull=false );
766 
774  int setDue_date_project( const date_t &value, bool isNull=false );
775 
783  int setEpm_subprocesses( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
784 
792  int setFnd0ActualDuration( int value, bool isNull=false );
793 
801  int setFnd0EndDate( const date_t &value, bool isNull=false );
802 
810  int setFnd0rootCMImpactedItems( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
811 
819  int setFnd0rootCMProblemItems( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
820 
828  int setFnd0rootCMSolutionItems( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
829 
837  int setFnd0RootReplicaTargets( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
838 
846  int setFnd0RootScheduleTask( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
847 
855  int setFnd0StartDate( const date_t &value, bool isNull=false );
856 
864  int setInstruction_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
865 
873  int setInterprocess_task_dependencies( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
874 
882  int setLate_flag( bool value, bool isNull=false );
883 
891  int setLocation( const std::string &value, bool isNull=false );
892 
900  int setProject_task_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
901 
909  int setRecipients( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
910 
918  int setReference_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
919 
927  int setRelease_status_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
928 
936  int setResponsible_party( const tag_t &value, bool isNull=false );
937 
945  int setRoot_reference_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
946 
954  int setRoot_target_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
955 
963  int setSignoff_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
964 
972  int setSignoff_profiles( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
973 
981  int setSignoff_quorum( int value, bool isNull=false );
982 
990  int setStart_node_location( const std::string &value, bool isNull=false );
991 
999  int setTarget_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
1000 
1008  int setTask_duration( int value, bool isNull=false );
1009 
1017  int setTask_type( const std::string &value, bool isNull=false );
1018 
1026  int setThe_task_duration( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
1027 
1035  int setViewed_by_me( bool value, bool isNull=false );
1036 
1044  int setWork_context( const tag_t &value, bool isNull=false );
1045 
1053  int fnd0ModifyTargetList( const int addOrRemoveTargets, const std::vector< tag_t > &targetAttachmentList );
1054 protected:
1055  // Method to initialize
1056  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
1057 
1061  EPMTask();
1062 
1066  virtual ~EPMTask();
1067 
1068 private:
1069  // Getter method for the Implementation Object
1070  EPMTaskImpl* getEPMTaskImpl() const;
1071  // Setter method for the Implementation Object
1072  ::Teamcenter::RootObjectImpl* setEPMTaskImpl( ::Teamcenter::RootObjectImpl* impl );
1073 
1074  // Method to set the delete impl boolean
1075  void setDeleteImpl( bool del );
1076 
1077  // Pointer to the Implementation object
1078  EPMTaskImpl* m_epmtaskImpl;
1079 
1080  // Flag to indicate if Implementation object needs to be deleted
1081  bool m_deleteImpl;
1082 
1086  static std::string name;
1087 
1092  EPMTask( const EPMTask& );
1093  EPMTask& operator=( const EPMTask& );
1094 
1095  friend class EPMTaskDelegate;
1096  friend class EPMTaskGenImpl;
1097 };
1098 
1099 #include <epm/libepm_undef.h>
1100 #endif // TEAMCENTER__EPMTASK__HXX