GlobalObjects
Loading...
Searching...
No Matches
GloReference.h
Go to the documentation of this file.
1#ifndef INC_GLOREFERENCE_H
2#define INC_GLOREFERENCE_H
3//-----------------------------------------------------------------------------
43//-----------------------------------------------------------------------------
44#include "GloTypes.h"
45#include "GloCallBack.h"
46#include "GloObjID.h"
47#include "GloLockSpecification.h"
48#include "GloWatchSpecification.h"
49#include <memory>
50//-----------------------------------------------------------------------------
51namespace glo
52{
53 //---------------------------------------------------------------------------
54 /* Forwards */
55 class BasePersistent;
56 //---------------------------------------------------------------------------
71 class __glo_export_dll Reference : public CallBack
72 {
73 private:
74 //============== Friends
75 //-----------------------------------------------------------------------
76 friend class ObjectMaker;
77 friend class OndemandLot;
78 friend class OndemandList;
79 friend class OndemandSet;
80 friend class TableReaderInterface;
81 friend class BaseAllSet;
82 friend class Base;
83 friend class OdRefRecordAttribute;
84 //-----------------------------------------------------------------------
85
86 //============== Attribute
87 //-----------------------------------------------------------------------
97 unsigned long m_ulDatabaseID;
98 //-----------------------------------------------------------------------
108 ObjID m_RefObjID;
109 //-----------------------------------------------------------------------
110
111 public:
112 //============== de- contructors
113 //-----------------------------------------------------------------------
123 Reference();
124 //-----------------------------------------------------------------------
138 Reference( const ObjID & rObjID );
139 //-----------------------------------------------------------------------
153 Reference( Base & rBase );
154 //-----------------------------------------------------------------------
168 Reference( unsigned long ulDatabaseID );
169 //-----------------------------------------------------------------------
190 Reference( const ObjID & rObjID, Base & rBase );
191 //-----------------------------------------------------------------------
213 Reference( const ObjID & rObjID, unsigned long ulDatabaseID );
214 //-----------------------------------------------------------------------
226 Reference( const Reference & rT );
227 //-----------------------------------------------------------------------
237 virtual ~Reference();
238 //-----------------------------------------------------------------------
239
240 //============== Methoden
241 //-----------------------------------------------------------------------
262 virtual int setBase( Base * pBase ) override;
263 //-----------------------------------------------------------------------
278 virtual Base * getBase() const override;
279 //-----------------------------------------------------------------------
295 virtual int getTypeAsString( std::string & rsTypeName ) override;
296 //-----------------------------------------------------------------------
308 bool isNULL() const;
309 //-----------------------------------------------------------------------
319 void setNULL();
320 //-----------------------------------------------------------------------
332 ObjID getObjID() const;
333 //-----------------------------------------------------------------------
345 const ObjID * getObjIDAsPointer() const;
346 //-----------------------------------------------------------------------
360 virtual int setReference( const ObjID & rObjID );
361 //-----------------------------------------------------------------------
378 int setReference( const BasePersistent * pObj );
379 //-----------------------------------------------------------------------
396 int setReference( const BasePersistent & rObj );
397 //-----------------------------------------------------------------------
424 int getReference( BasePersistent *& prRetVal );
425 //-----------------------------------------------------------------------
441 int getReference( std::shared_ptr<BasePersistent> & sprRetVal );
442 //-----------------------------------------------------------------------
456 virtual int deleteInBase( EnDeepMode eDeepMode = DM_SHALLOW );
457 //-----------------------------------------------------------------------
481 virtual int lock( EnLockMode eLockMode = LK_DELETEvWRITE,
482 EnDeepMode eDeepMode = DM_SHALLOW ) const;
483 //-----------------------------------------------------------------------
505 virtual int lock( const LockSpecification & rLockSpecification ) const;
506 //-----------------------------------------------------------------------
533 virtual int unlock( EnLockMode eLockMode = LK_DELETEvWRITE,
534 EnDeepMode eDeepMode = DM_SHALLOW ) const;
535 //-----------------------------------------------------------------------
560 virtual int unlock( const LockSpecification & rLockSpecification ) const;
561 //-----------------------------------------------------------------------
584 virtual int isLocked( EnLockMode eLockMode = LK_DELETEvWRITE,
585 EnDeepMode eDeepMode = DM_SHALLOW ) const;
586 //-----------------------------------------------------------------------
606 virtual int isLocked( const LockSpecification & rLockSpecification ) const;
607 //-----------------------------------------------------------------------
631 virtual int isPossible( bool bRead,
632 bool bWrite,
633 bool bDelete,
634 EnDeepMode eDeepMode = DM_SHALLOW ) const;
635 //-----------------------------------------------------------------------
655 virtual int isPossible( const LockPossibleSpecification & rLockPossibleSpec,
656 EnDeepMode eDeepMode = DM_SHALLOW ) const;
657 //-----------------------------------------------------------------------
708 virtual int setWatch( TdWatchNotifyMode ulWatchMode,
709 EnDeepMode eDeepMode,
710 CallBack * pCallBack = 0 ) const;
711 //-----------------------------------------------------------------------
734 virtual int setWatch( const WatchSpecification & rWatchSpec ) const;
735 //-----------------------------------------------------------------------
786 virtual int unsetWatch( TdWatchNotifyMode ulWatchMode,
787 EnDeepMode eDeepMode,
788 CallBack * pCallBack ) const;
789 //-----------------------------------------------------------------------
815 virtual int unsetWatch( const WatchSpecification & rWatchSpec ) const;
816 //-----------------------------------------------------------------------
817
818 //============== Operatoren
819 //-----------------------------------------------------------------------
831 Reference & operator= ( const Reference & rT );
832 //-----------------------------------------------------------------------
834
845 bool operator== ( const Reference & rT ) const;
846 bool operator!= ( const Reference & rT ) const;
848 //-----------------------------------------------------------------------
849 };
850 //---------------------------------------------------------------------------
851} // namespace glo
852#endif
GloCallBack.h
Header for CallBack
GloLockSpecification.h
Header for LockSpecification
GloObjID.h
Header for ObjID
GloTypes.h
For each library, here 'GlobalObjects' there is a type file.
__glo_export_dll
#define __glo_export_dll
Definition GloTypes.h:70
GloWatchSpecification.h
Header for WatchSpecification
glo::BasePersistent
Abstract base class for Persistent and the generic GenericPersistent.
Definition GloBasePersistent.h:124
glo::LockSpecification
To be able to lock objects, the 'lock mode' and the 'lock depth' are required as parameters....
Definition GloLockSpecification.h:65
glo::ObjID
An object ID consists of the class ID, a database ID and the actual unique object number (all unsigne...
Definition GloObjID.h:84
glo::Reference::unsetWatch
virtual int unsetWatch(TdWatchNotifyMode ulWatchMode, EnDeepMode eDeepMode, CallBack *pCallBack) const
glo::Reference::OndemandSet
friend class OndemandSet
Definition GloReference.h:79
glo::Reference::setWatch
virtual int setWatch(TdWatchNotifyMode ulWatchMode, EnDeepMode eDeepMode, CallBack *pCallBack=0) const
glo::Reference::OdRefRecordAttribute
friend class OdRefRecordAttribute
Definition GloReference.h:83
glo::Reference::lock
virtual int lock(const LockSpecification &rLockSpecification) const
glo::Reference::unsetWatch
virtual int unsetWatch(const WatchSpecification &rWatchSpec) const
glo::Reference::setReference
virtual int setReference(const ObjID &rObjID)
glo::Reference::getReference
int getReference(std::shared_ptr< BasePersistent > &sprRetVal)
glo::Reference::getReference
int getReference(BasePersistent *&prRetVal)
glo::Reference::isLocked
virtual int isLocked(EnLockMode eLockMode=LK_DELETEvWRITE, EnDeepMode eDeepMode=DM_SHALLOW) const
glo::Reference::isLocked
virtual int isLocked(const LockSpecification &rLockSpecification) const
glo::Reference::Reference
Reference(const Reference &rT)
glo::Reference::setWatch
virtual int setWatch(const WatchSpecification &rWatchSpec) const
glo::Reference::getTypeAsString
virtual int getTypeAsString(std::string &rsTypeName) override
glo::Reference::isPossible
virtual int isPossible(bool bRead, bool bWrite, bool bDelete, EnDeepMode eDeepMode=DM_SHALLOW) const
glo::Reference::setReference
int setReference(const BasePersistent *pObj)
glo::Reference::setReference
int setReference(const BasePersistent &rObj)
glo::Reference::getBase
virtual Base * getBase() const override
glo::Reference::setBase
virtual int setBase(Base *pBase) override
glo::Reference::Reference
Reference(unsigned long ulDatabaseID)
glo::Reference::Reference
Reference(const ObjID &rObjID)
glo::Reference::ObjectMaker
friend class ObjectMaker
Definition GloReference.h:76
glo::Reference::lock
virtual int lock(EnLockMode eLockMode=LK_DELETEvWRITE, EnDeepMode eDeepMode=DM_SHALLOW) const
glo::Reference::OndemandList
friend class OndemandList
Definition GloReference.h:78
glo::Reference::isPossible
virtual int isPossible(const LockPossibleSpecification &rLockPossibleSpec, EnDeepMode eDeepMode=DM_SHALLOW) const
glo::Reference::Base
friend class Base
Definition GloReference.h:82
glo::Reference::~Reference
virtual ~Reference()
glo::Reference::Reference
Reference(Base &rBase)
glo::Reference::OndemandLot
friend class OndemandLot
Definition GloReference.h:77
glo::Reference::TableReaderInterface
friend class TableReaderInterface
Definition GloReference.h:80
glo::Reference::getObjID
ObjID getObjID() const
glo::Reference::deleteInBase
virtual int deleteInBase(EnDeepMode eDeepMode=DM_SHALLOW)
glo::Reference::isNULL
bool isNULL() const
glo::Reference::BaseAllSet
friend class BaseAllSet
Definition GloReference.h:81
glo::Reference::m_ulDatabaseID
unsigned long m_ulDatabaseID
Definition GloReference.h:97
glo::Reference::m_RefObjID
ObjID m_RefObjID
Definition GloReference.h:108
glo::Reference::Reference
Reference(const ObjID &rObjID, unsigned long ulDatabaseID)
glo::Reference::getObjIDAsPointer
const ObjID * getObjIDAsPointer() const
glo::Reference::Reference
Reference(const ObjID &rObjID, Base &rBase)
glo::Reference::unlock
virtual int unlock(EnLockMode eLockMode=LK_DELETEvWRITE, EnDeepMode eDeepMode=DM_SHALLOW) const
glo::Reference::unlock
virtual int unlock(const LockSpecification &rLockSpecification) const
glo::WatchSpecification
To be able to watch objects, the 'watching mode', the 'watching depth' and the 'notification object' ...
Definition GloWatchSpecification.h:67
glo
Definition GloAbstractBaseLot.h:49
glo::EnDeepMode
EnDeepMode
Definition GloTypes.h:254
glo::DM_SHALLOW
@ DM_SHALLOW
Definition GloTypes.h:290
glo::EnLockMode
EnLockMode
Definition GloTypes.h:1055
glo::LK_DELETEvWRITE
@ LK_DELETEvWRITE
Definition GloTypes.h:1105
glo::TdWatchNotifyMode
unsigned long TdWatchNotifyMode
Definition GloTypes.h:558
glo::LockPossibleSpecification
Permitted actions in the database such as read, write and delete can be queried for an object....
Definition GloTypes.h:1256