Teamcenter C++ API Reference  2312
Scp0DeclarationValidator.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, Scp0DeclarationValidator
12  Filename: Scp0DeclarationValidator.hxx
13  Module: scp0subscmpl
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef SUBSCMPL__SCP0DECLARATIONVALIDATOR__HXX
18 #define SUBSCMPL__SCP0DECLARATIONVALIDATOR__HXX
19 
20 #include <unidefs.h>
21 #include <string>
22 #include <vector>
23 #include <common/tc_deprecation_macros.h>
25 
26 #include <scp0subscmpl/libscp0subscmpl_exports.h>
27 
28 namespace subscmpl
29 {
30  class Scp0DeclarationValidator;
31 }
32 namespace subscmpl
33 {
34  class Scp0DeclarationValidatorImpl;
35 }
36 namespace subscmpl
37 {
38  class Scp0DeclarationValidatorDelegate;
39 }
40 namespace subscmpl
41 {
42  class Scp0DeclarationValidatorDispatch;
43 }
44 namespace subscmpl
45 {
46  class Scp0DeclarationValidatorGenImpl;
47 }
48 namespace Teamcenter
49 {
50  class RootObjectImpl;
51 }
52 
53 class SCP0SUBSCMPL_API subscmpl::Scp0DeclarationValidator
55 {
56 public:
57 
62  static const std::string& getInterfaceName();
63 
64 
72  int getScp0CommunicatorRef( tag_t &value, bool &isNull ) const;
73 
81  int getScp0DeclType( std::string &value, bool &isNull ) const;
82 
90  int getScp0InputFileTickets( std::vector< std::string > &values, std::vector< int > &isNull ) const;
91 
99  int getScp0SessionDigestObjectRef( tag_t &value, bool &isNull ) const;
100 
108  int getScp0ValidationMode( std::string &value, bool &isNull ) const;
109 
117  int getScp0ValidatorAgents( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
118 
126  int getScp0XSLFileFMSTicket( std::string &value, bool &isNull ) const;
127 
135  int setScp0CommunicatorRef( const tag_t &value, bool isNull=false );
136 
144  int setScp0DeclType( const std::string &value, bool isNull=false );
145 
153  int setScp0InputFileTickets( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
154 
162  int setScp0SessionDigestObjectRef( const tag_t &value, bool isNull=false );
163 
171  int setScp0ValidationMode( const std::string &value, bool isNull=false );
172 
180  int setScp0XSLFileFMSTicket( const std::string &value, bool isNull=false );
181 
188 
194  int scp0ExecuteValidation( );
195 
201  int scp0GenerateSessionLog( );
202 protected:
203  // Method to initialize
204  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
205 
210 
214  virtual ~Scp0DeclarationValidator();
215 
216 private:
217  // Getter method for the Implementation Object
218  Scp0DeclarationValidatorImpl* getScp0DeclarationValidatorImpl() const;
219  // Setter method for the Implementation Object
220  ::Teamcenter::RootObjectImpl* setScp0DeclarationValidatorImpl( ::Teamcenter::RootObjectImpl* impl );
221 
222  // Method to set the delete impl boolean
223  void setDeleteImpl( bool del );
224 
225  // Pointer to the Implementation object
226  Scp0DeclarationValidatorImpl* m_scp0declarationvalidatorImpl;
227 
228  // Flag to indicate if Implementation object needs to be deleted
230 
234  static std::string name;
235 
242 
243  friend class Scp0DeclarationValidatorDelegate;
244  friend class Scp0DeclarationValidatorGenImpl;
245 };
246 
247 #include <scp0subscmpl/libscp0subscmpl_undef.h>
248 #endif // SUBSCMPL__SCP0DECLARATIONVALIDATOR__HXX