src/DDF/DDF_Transaction.cdl

   1 -- Created by: DAUTRY Philippe
   2 -- Copyright (c) 1997-1999 Matra Datavision
   3 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20 --              -------------------
  21
  22 ---Version:     0.0
  23 --Version       Date            Purpose
  24 --              0.0     Nov  4 1997     Creation
  25
  26 class Transaction from DDF
  27     inherits TShared from MMgt
  28
  29         ---Purpose: This class encapsulates TDF_Transaction.
  30
  31 uses
  32
  33     Data  from TDF,
  34     Delta from TDF,
  35     Transaction from TDF
  36
  37 raises
  38
  39     DomainError, NullObject from Standard
  40
  41 is
  42
  43     Create
  44         returns Transaction from DDF;
  45         ---Purpose: Creates an empty transaction context, unable to be
  46         --          opened.
  47
  48     Create(aDF : Data from TDF)
  49         returns Transaction from DDF;
  50         ---Purpose: Creates a transaction context on <aDF>, ready to
  51         --          be opened.
  52
  53     Open(me : mutable)
  54         returns Integer from Standard;
  55         ---Purpose: If not yet done, opens a new transaction on
  56         --          <myDF>. Returns the index of the just opened
  57         --          transaction.
  58         --
  59         --          It raises DomainError if the transaction is
  60         --          already open, and NullObject if there is no
  61         --          current Data framework.
  62
  63     Commit(me : mutable;
  64            withDelta : Boolean from Standard = Standard_False)
  65         returns Delta from TDF;
  66         ---Purpose: Commits the transactions until AND including the
  67         --          current opened one.
  68
  69     Abort(me : mutable);
  70         ---Purpose: Aborts the transactions until AND including the
  71         --          current opened one.
  72         --
  73         ---C++: alias ~
  74
  75     Data(me) returns Data from TDF;
  76         ---Purpose: Returns the Data from TDF.
  77
  78     Transaction(me) returns Integer from Standard;
  79         ---Purpose: Returns the number of the transaction opened by <me>.
  80
  81     IsOpen(me)
  82         returns Boolean from Standard;
  83         ---Purpose: Returns true if the transaction is open.
  84
  85
  86 fields
  87
  88     myTransaction : Transaction from TDF;
  89
  90 end Transaction;