Teamcenter C++ API Reference  2312
DispatcherRequest.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, DispatcherRequest
12  Filename: DispatcherRequest.hxx
13  Module: dispatcher
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef TEAMCENTER__DISPATCHERREQUEST__HXX
18 #define TEAMCENTER__DISPATCHERREQUEST__HXX
19 
20 #include <vector>
21 #include <string>
22 #include <unidefs.h>
23 #include <common/tc_deprecation_macros.h>
25 
26 #include <dispatcher/libdispatcher_exports.h>
27 
28 namespace Teamcenter
29 {
30  class DispatcherRequest;
31 }
32 namespace Teamcenter
33 {
34  class DispatcherRequestImpl;
35 }
36 namespace Teamcenter
37 {
38  class DispatcherRequestDelegate;
39 }
40 namespace Teamcenter
41 {
42  class DispatcherRequestDispatch;
43 }
44 namespace Teamcenter
45 {
46  class DispatcherRequestGenImpl;
47 }
48 namespace Teamcenter
49 {
50  class RootObjectImpl;
51 }
52 
53 class DISPATCHER_API Teamcenter::DispatcherRequest
55 {
56 public:
57 
62  static const std::string& getInterfaceName();
63 
64 
72  int getArgumentData( std::vector< std::string > &values, std::vector< int > &isNull ) const;
73 
81  int getArgumentKeys( std::vector< std::string > &values, std::vector< int > &isNull ) const;
82 
90  int getCurrentState( std::string &value, bool &isNull ) const;
91 
99  int getDataFiles( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
100 
108  int getDataFilesKeys( std::vector< std::string > &values, std::vector< int > &isNull ) const;
109 
117  int getEndTime( date_t &value, bool &isNull ) const;
118 
126  int getHistoryDates( std::vector< date_t > &values, std::vector< int > &isNull ) const;
127 
135  int getHistoryStates( std::vector< std::string > &values, std::vector< int > &isNull ) const;
136 
144  int getInterval( int &value, bool &isNull ) const;
145 
153  int getMode( int &value, bool &isNull ) const;
154 
162  int getPrimaryObjects( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
163 
171  int getPriority( int &value, bool &isNull ) const;
172 
180  int getProviderName( std::string &value, bool &isNull ) const;
181 
189  int getSecondaryObjects( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
190 
198  int getServiceName( std::string &value, bool &isNull ) const;
199 
207  int getStartTime( date_t &value, bool &isNull ) const;
208 
216  int getTaskID( std::string &value, bool &isNull ) const;
217 
225  int getType( std::string &value, bool &isNull ) const;
226 
234  int setArgumentData( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
235 
243  int setArgumentKeys( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
244 
252  int setCurrentState( const std::string &value, bool isNull=false );
253 
261  int setDataFiles( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
262 
270  int setDataFilesKeys( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
271 
279  int setEndTime( const date_t &value, bool isNull=false );
280 
288  int setHistoryDates( const std::vector< date_t > &values, const std::vector< int > *isNull=0 );
289 
297  int setHistoryStates( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
298 
306  int setInterval( int value, bool isNull=false );
307 
315  int setMode( int value, bool isNull=false );
316 
324  int setPrimaryObjects( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
325 
333  int setPriority( int value, bool isNull=false );
334 
342  int setProviderName( const std::string &value, bool isNull=false );
343 
351  int setSecondaryObjects( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
352 
360  int setServiceName( const std::string &value, bool isNull=false );
361 
369  int setStartTime( const date_t &value, bool isNull=false );
370 
378  int setTaskID( const std::string &value, bool isNull=false );
379 
387  int setType( const std::string &value, bool isNull=false );
388 protected:
389  // Method to initialize
390  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
391 
396 
400  virtual ~DispatcherRequest();
401 
402 private:
403  // Getter method for the Implementation Object
404  DispatcherRequestImpl* getDispatcherRequestImpl() const;
405  // Setter method for the Implementation Object
406  ::Teamcenter::RootObjectImpl* setDispatcherRequestImpl( ::Teamcenter::RootObjectImpl* impl );
407 
408  // Method to set the delete impl boolean
409  void setDeleteImpl( bool del );
410 
411  // Pointer to the Implementation object
412  DispatcherRequestImpl* m_dispatcherrequestImpl;
413 
414  // Flag to indicate if Implementation object needs to be deleted
416 
420  static std::string name;
421 
428 
429  friend class DispatcherRequestDelegate;
430  friend class DispatcherRequestGenImpl;
431 };
432 
433 #include <dispatcher/libdispatcher_undef.h>
434 #endif // TEAMCENTER__DISPATCHERREQUEST__HXX