Teamcenter C++ API Reference  2312
UserSession.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, UserSession
12  Filename: UserSession.hxx
13  Module: ce
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef TEAMCENTER__USERSESSION__HXX
18 #define TEAMCENTER__USERSESSION__HXX
19 
20 #include <string>
21 #include <unidefs.h>
22 #include <vector>
23 #include <common/tc_deprecation_macros.h>
25 
26 #include <ce/libce_exports.h>
27 
28 namespace Teamcenter
29 {
30  class UserSession;
31 }
32 namespace Teamcenter
33 {
34  class UserSessionImpl;
35 }
36 namespace Teamcenter
37 {
38  class UserSessionDelegate;
39 }
40 namespace Teamcenter
41 {
42  class UserSessionDispatch;
43 }
44 namespace Teamcenter
45 {
46  class UserSessionGenImpl;
47 }
48 namespace Teamcenter
49 {
50  class RootObjectImpl;
51 }
52 
53 class CE_API Teamcenter::UserSession
55 {
56 public:
57 
62  static const std::string& getInterfaceName();
63 
64 
72  int getFnd0bypassflag( bool &value, bool &isNull ) const;
73 
81  int getFnd0displayrule( std::string &value, bool &isNull ) const;
82 
90  int getFnd0displayTypes( std::vector< std::string > &values, std::vector< int > &isNull ) const;
91 
99  int getFnd0groupmember( tag_t &value, bool &isNull ) const;
100 
108  int getFnd0isTrueConditions( std::vector< std::string > &values, std::vector< int > &isNull ) const;
109 
117  int getFnd0locale( std::string &value, bool &isNull ) const;
118 
126  int getFnd0LocalVolume( tag_t &value, bool &isNull ) const;
127 
135  int getFnd0LocationCode( std::string &value, bool &isNull ) const;
136 
144  int getFnd0organization( tag_t &value, bool &isNull ) const;
145 
153  int getFnd0ShowGDPR( bool &value, bool &isNull ) const;
154 
161  int fnd0getClassMultisiteSessionStatus( int *isActive );
162 
169  int fnd0getGroupName( std::string &gname );
170 
177  int fnd0getPIESessionStatus( int *isActive );
178 
187  int fnd0isInProjListORSessionProject( const tag_t &object, std::string &projectName, bool *output );
188 
197  int fnd0isOwningORSessionProject( const tag_t &object, std::string &projectName, bool *output );
198 
205  int getLicenseLevel( int *level );
206 
213  int getTIESessionStatus( int *isActive );
214 protected:
215  // Method to initialize
216  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
217 
221  UserSession();
222 
226  virtual ~UserSession();
227 
228 private:
229  // Getter method for the Implementation Object
230  UserSessionImpl* getUserSessionImpl() const;
231  // Setter method for the Implementation Object
232  ::Teamcenter::RootObjectImpl* setUserSessionImpl( ::Teamcenter::RootObjectImpl* impl );
233 
234  // Method to set the delete impl boolean
235  void setDeleteImpl( bool del );
236 
237  // Pointer to the Implementation object
238  UserSessionImpl* m_usersessionImpl;
239 
240  // Flag to indicate if Implementation object needs to be deleted
242 
246  static std::string name;
247 
252  UserSession( const UserSession& );
253  UserSession& operator=( const UserSession& );
254 
255  friend class UserSessionDelegate;
256  friend class UserSessionGenImpl;
257 };
258 
259 #include <ce/libce_undef.h>
260 #endif // TEAMCENTER__USERSESSION__HXX