Teamcenter C++ API Reference  2312
ScheduleTask.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, ScheduleTask
12  Filename: ScheduleTask.hxx
13  Module: schmgt
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef TEAMCENTER__SCHEDULETASK__HXX
18 #define TEAMCENTER__SCHEDULETASK__HXX
19 
20 #include <unidefs.h>
21 #include <string>
22 #include <vector>
23 #include <common/tc_deprecation_macros.h>
24 #include <tccore/WorkspaceObject.hxx>
25 
26 #include <schmgt/libschmgt_exports.h>
27 
28 namespace Teamcenter
29 {
30  class ScheduleTask;
31 }
32 namespace Teamcenter
33 {
34  class ScheduleTaskImpl;
35 }
36 namespace Teamcenter
37 {
38  class ScheduleTaskDelegate;
39 }
40 namespace Teamcenter
41 {
42  class ScheduleTaskDispatch;
43 }
44 namespace Teamcenter
45 {
46  class ScheduleTaskGenImpl;
47 }
48 namespace Teamcenter
49 {
50  class RootObjectImpl;
51 }
52 
53 class SCHMGT_API Teamcenter::ScheduleTask
54  : public ::Teamcenter::WorkspaceObject
55 {
56 public:
57 
62  static const std::string& getInterfaceName();
63 
64 
72  int getActual_finish_date( date_t &value, bool &isNull ) const;
73 
81  int getActual_start_date( date_t &value, bool &isNull ) const;
82 
90  int getApproved_work( int &value, bool &isNull ) const;
91 
99  int getAuto_complete( bool &value, bool &isNull ) const;
100 
108  int getBill_code( std::string &value, bool &isNull ) const;
109 
117  int getBill_sub_code( std::string &value, bool &isNull ) const;
118 
126  int getBill_type( std::string &value, bool &isNull ) const;
127 
135  int getBillrate_tag( tag_t &value, bool &isNull ) const;
136 
144  int getChild_task_taglist( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
145 
153  int getComplete_percent( double &value, bool &isNull ) const;
154 
162  int getConstraint( int &value, bool &isNull ) const;
163 
171  int getDuration( int &value, bool &isNull ) const;
172 
180  int getFinish_date( date_t &value, bool &isNull ) const;
181 
189  int getFixed_cost_taglist( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
190 
198  int getFixed_type( int &value, bool &isNull ) const;
199 
207  int getFnd0ForecastEndDate( date_t &value, bool &isNull ) const;
208 
216  int getFnd0ForecastStartDate( date_t &value, bool &isNull ) const;
217 
225  int getFnd0IsLegacy( bool &value, bool &isNull ) const;
226 
234  int getFnd0IsSchSummaryTask( bool &value, bool &isNull ) const;
235 
243  int getFnd0MyTaskExecutionErrors( std::vector< std::string > &values, std::vector< int > &isNull ) const;
244 
252  int getFnd0MyTaskExecutionStatus( int &value, bool &isNull ) const;
253 
261  int getFnd0ParentTask( tag_t &value, bool &isNull ) const;
262 
270  int getFnd0Qualifications( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
271 
279  int getFnd0sch_notification_count( int &value, bool &isNull ) const;
280 
288  int getFnd0sch_subscription_count( int &value, bool &isNull ) const;
289 
297  int getFnd0ScheduleAuditLogs( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
298 
306  int getFnd0state( std::string &value, bool &isNull ) const;
307 
315  int getFnd0status( std::string &value, bool &isNull ) const;
316 
324  int getFnd0TaskExecutionStatuses( std::vector< std::string > &values, std::vector< int > &isNull ) const;
325 
333  int getFnd0WhatIfMode( int &value, bool &isNull ) const;
334 
342  int getFnd0workflow_owner( tag_t &value, bool &isNull ) const;
343 
351  int getIs_baseline( bool &value, bool &isNull ) const;
352 
360  int getItem_id( std::string &value, bool &isNull ) const;
361 
369  int getPriority( int &value, bool &isNull ) const;
370 
378  int getPrivileged_user( tag_t &value, bool &isNull ) const;
379 
387  int getSch_task_deliverable_list( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
388 
396  int getSchedule_tag( tag_t &value, bool &isNull ) const;
397 
405  int getStart_date( date_t &value, bool &isNull ) const;
406 
414  int getTask_type( int &value, bool &isNull ) const;
415 
423  int getWbs_code( std::string &value, bool &isNull ) const;
424 
432  int getWork_complete( int &value, bool &isNull ) const;
433 
441  int getWork_estimate( int &value, bool &isNull ) const;
442 
450  int getWork_remaining( int &value, bool &isNull ) const;
451 
459  int getWorkflow_process( tag_t &value, bool &isNull ) const;
460 
468  int getWorkflow_template( tag_t &value, bool &isNull ) const;
469 
477  int getWorkflow_trigger_type( int &value, bool &isNull ) const;
478 
486  int setActual_finish_date( const date_t &value, bool isNull=false );
487 
495  int setActual_start_date( const date_t &value, bool isNull=false );
496 
504  int setApproved_work( int value, bool isNull=false );
505 
513  int setAuto_complete( bool value, bool isNull=false );
514 
522  int setBill_code( const std::string &value, bool isNull=false );
523 
531  int setBill_sub_code( const std::string &value, bool isNull=false );
532 
540  int setBill_type( const std::string &value, bool isNull=false );
541 
549  int setBillrate_tag( const tag_t &value, bool isNull=false );
550 
558  int setChild_task_taglist( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
559 
567  int setComplete_percent( double value, bool isNull=false );
568 
576  int setConstraint( int value, bool isNull=false );
577 
585  int setDuration( int value, bool isNull=false );
586 
594  int setFinish_date( const date_t &value, bool isNull=false );
595 
603  int setFixed_cost_taglist( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
604 
612  int setFixed_type( int value, bool isNull=false );
613 
621  int setFnd0ForecastEndDate( const date_t &value, bool isNull=false );
622 
630  int setFnd0ForecastStartDate( const date_t &value, bool isNull=false );
631 
639  int setFnd0IsLegacy( bool value, bool isNull=false );
640 
648  int setFnd0IsSchSummaryTask( bool value, bool isNull=false );
649 
657  int setFnd0ParentTask( const tag_t &value, bool isNull=false );
658 
666  int setFnd0state( const std::string &value, bool isNull=false );
667 
675  int setFnd0status( const std::string &value, bool isNull=false );
676 
684  int setFnd0WhatIfMode( int value, bool isNull=false );
685 
693  int setFnd0workflow_owner( const tag_t &value, bool isNull=false );
694 
702  int setIs_baseline( bool value, bool isNull=false );
703 
711  int setItem_id( const std::string &value, bool isNull=false );
712 
720  int setPriority( int value, bool isNull=false );
721 
729  int setPrivileged_user( const tag_t &value, bool isNull=false );
730 
738  int setSch_task_deliverable_list( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
739 
747  int setSchedule_tag( const tag_t &value, bool isNull=false );
748 
756  int setStart_date( const date_t &value, bool isNull=false );
757 
765  int setTask_type( int value, bool isNull=false );
766 
774  int setWbs_code( const std::string &value, bool isNull=false );
775 
783  int setWork_complete( int value, bool isNull=false );
784 
792  int setWork_estimate( int value, bool isNull=false );
793 
801  int setWork_remaining( int value, bool isNull=false );
802 
810  int setWorkflow_process( const tag_t &value, bool isNull=false );
811 
819  int setWorkflow_template( const tag_t &value, bool isNull=false );
820 
828  int setWorkflow_trigger_type( int value, bool isNull=false );
829 
836  int fnd0isScheduleCoordinator( bool *isCoordinator );
837 
844  int fnd0isTaskAssignee( bool *isAssignee );
845 protected:
846  // Method to initialize
847  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
848 
852  ScheduleTask();
853 
857  virtual ~ScheduleTask();
858 
859 private:
860  // Getter method for the Implementation Object
861  ScheduleTaskImpl* getScheduleTaskImpl() const;
862  // Setter method for the Implementation Object
863  ::Teamcenter::RootObjectImpl* setScheduleTaskImpl( ::Teamcenter::RootObjectImpl* impl );
864 
865  // Method to set the delete impl boolean
866  void setDeleteImpl( bool del );
867 
868  // Pointer to the Implementation object
869  ScheduleTaskImpl* m_scheduletaskImpl;
870 
871  // Flag to indicate if Implementation object needs to be deleted
872  bool m_deleteImpl;
873 
877  static std::string name;
878 
883  ScheduleTask( const ScheduleTask& );
884  ScheduleTask& operator=( const ScheduleTask& );
885 
886  friend class ScheduleTaskDelegate;
887  friend class ScheduleTaskGenImpl;
888 };
889 
890 #include <schmgt/libschmgt_undef.h>
891 #endif // TEAMCENTER__SCHEDULETASK__HXX