ApLongTransactions.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
#ifndef   _LONG_TRANSACTION_MANAGER_H_INCLUDED_
#define   _LONG_TRANSACTION_MANAGER_H_INCLUDED_
 
#include "RxObject.h"
#include "IdArrays.h"
#include "TD_PackPush.h"
 
class OdDbLongTransaction;
class OdDbDatabase;
class OdDbIdMapping;
 
class TOOLKIT_EXPORT OdApLongTransactionReactor: public OdRxObject 
{ 
public:
  ODRX_DECLARE_MEMBERS(OdApLongTransactionReactor);
  OdApLongTransactionReactor();
 
  virtual void beginCheckOut        (OdDbLongTransaction& , OdDbObjectIdArray& originList);
  virtual void endCheckOut          (OdDbLongTransaction& );
  virtual void beginCheckIn         (OdDbLongTransaction& );
  virtual void endCheckIn           (OdDbLongTransaction& );
  virtual void abortLongTransaction (OdDbLongTransaction& );
 
protected:
  OdResult veto();
 
private:
  bool m_Veto;
  friend class OdApLongTransactionManagerImpl;
};
 
class ODRX_ABSTRACT TOOLKIT_EXPORT OdApLongTransactionManager : public OdRxObject 
{ 
public:
  ODRX_DECLARE_MEMBERS(OdApLongTransactionManager);
 
  virtual OdResult checkOut(OdDbObjectId& transId, OdDbObjectIdArray& objList,
    OdDbObjectId toBlock, OdDbIdMapping& errorMap, OdDbObjectId lockBlkRef = OdDbObjectId::kNull) = 0;
 
  virtual OdResult checkIn(OdDbObjectId transId, OdDbIdMapping& errorMap, bool keepObjs = false) = 0;
 
  virtual OdResult abortLongTransaction(OdDbObjectId transId, bool keepObjs = false) = 0;
 
  virtual OdDbObjectId currentLongTransactionFor(const OdDbDatabase* pDb) const = 0;
  virtual void addReactor(OdApLongTransactionReactor*) = 0;
  virtual void removeReactor(OdApLongTransactionReactor*) = 0;
 
  virtual OdResult addClassFilter (OdRxClass* ) = 0;
  virtual bool isFiltered (OdRxClass* ) const = 0;
};
 
extern TOOLKIT_EXPORT OdApLongTransactionManager* odapLongTransactionManager();
 
#include "TD_PackPop.h"
#endif  // _LONG_TRANSACTION_MANAGER_H_INCLUDED_