src/Interface/Interface_ReportEntity.cdl

   1 -- File:        Interface_ReportEntity.cdl
   2 -- Created:     Fri Feb  5 16:35:30 1993
   3 -- Author:      Christian CAILLET
   4 --              <cky@phobox>
   5 ---Copyright:    Matra Datavision 1993
   6
   7
   8 class ReportEntity  from Interface  inherits TShared
   9
  10     ---Purpose : A ReportEntity is produced to aknowledge and memorize the
  11     --           binding between a Check and an Entity. The Check can bring
  12     --           Fails (+ Warnings if any), or only Warnings. If it is empty,
  13     --           the Report Entity is for an Unknown Entity.
  14     --
  15     --           The ReportEntity brings : the Concerned Entity, the
  16     --           Check, and if the Entity is empty (Fails due to Read
  17     --           Errors, hence the Entity could not be loaded), a Content.
  18     --           The Content is itself an Transient Object, but remains in a
  19     --           literal form : it is an "Unknown Entity". If the Concerned
  20     --           Entity is itself Unknown, Concerned and Content are equal.
  21     --
  22     --           According to the Check, if it brings Fail messages,
  23     --           the ReportEntity is an "Error Entity", the Concerned Entity is
  24     --           an "Erroneous Entity". Else it is a "Correction Entity", the
  25     --           Concerned Entity is a "Corrected Entity". With no Check
  26     --           message and if Concerened and Content are equal, it reports
  27     --           for an "Unknown Entity".
  28     --
  29     --           Each norm must produce its own type of Unknown Entity, but can
  30     --           use the class UndefinedContent to brings parameters : it is
  31     --           enough for most of information and avoids to redefine them,
  32     --           only the specific part remains to be defined for each norm.
  33
  34 uses Check, Transient
  35
  36 is
  37
  38     Create (unknown : mutable Transient) returns mutable ReportEntity;
  39     ---Purpose : Creates a ReportEntity for an Unknown Entity : Check is empty,
  40     --           and Concerned equates Content (i.e. the Unknown Entity)
  41
  42     Create (acheck : Check; concerned : mutable Transient)
  43         returns mutable ReportEntity;
  44     ---Purpose : Creates a ReportEntity with its features :
  45     --           - <acheck> is the Check to be memorised
  46     --           - <concerned> is the Entity to which the Check is bound
  47     --           Later, a Content can be set : it is required for an Error
  48
  49     SetContent (me : mutable; content : mutable Transient);
  50     ---Purpose : Sets a Content : it brings non interpreted data which belong
  51     --           to the Concerned Entity. It can be empty then loaded later.
  52     --           Remark that for an Unknown Entity, Content is set by Create.
  53
  54     Check (me) returns Check;
  55     ---Purpose : Returns the stored Check
  56     ---C++ : return const &
  57
  58     CCheck (me : mutable) returns Check;
  59     ---Purpose : Returns the stored Check in order to change it
  60     ---C++ : return &
  61
  62     Concerned (me) returns mutable Transient;
  63     ---Purpose : Returns the stored Concerned Entity. It equates the Content
  64     --           in the case of an Unknown Entity
  65
  66     HasContent (me) returns Boolean;
  67     ---Purpose : Returns True if a Content is stored (it can equate Concerned)
  68
  69     HasNewContent (me) returns Boolean;
  70     ---Purpose : Returns True if a Content is stored AND differs from Concerned
  71     --           (i.e. redefines content) : used when Concerned could not be
  72     --           loaded
  73
  74     Content (me) returns mutable Transient;
  75     ---Purpose : Returns the stored Content, or a Null Handle
  76     --           Remark that it must be an "Unknown Entity" suitable for
  77     --           the norm of the containing Model
  78
  79
  80     IsError (me) returns Boolean;
  81     ---Purpose : Returns True for an Error Entity, i.e. if the Check
  82     --           brings at least one Fail message
  83
  84     IsUnknown (me) returns Boolean;
  85     ---Purpose : Returns True for an Unknown Entity, i,e. if the Check
  86     --           is empty and Concerned equates Content
  87
  88 fields
  89
  90     thecheck     : Check;
  91     theconcerned : Transient;
  92     thecontent   : Transient;
  93
  94 end ReportEntity;