/*MAIN
 Overview
 
 BFST_REPORT_FILL is a rule which, during reconstruction, reports in table
    CS_STATE_REPORT when a conseq has been filled (FILL_STATUS = 1).
MAIN*/

/*ARGUMENTS
  Arguments
 
  BFST_REPORT_FILL takes the following argument, which has an IN 
  parameter mode:
   - MIN_ID (INTEGER).  This variable represents the lower boundary of the conseq
     under examination.
ARGUMENTS*/

/*DEPENDENCIES
 Dependencies
 
 The following are the procedures called by BFST_REPORT_FILL (listed in their
 order of call):
   - SWITCH.  This is the package that manipulates the switches for all
     the reconstruction rules.

   - RULES_STATES.  This is a package of three procedures and one function all
     of which track and post reconstruction states for all rules as they become
     available, in the temporary table LOGT.

   - RULE.  This is the stored package that manipulates the reconstruction rules
     numbers, name and version number.

   - OPEN_AND_PARSE.  This function combines what would otherwise have
     been separate calls to the native Oracle DBMS_SQL.OPEN_CURSOR and
     DBMS_SQL.PARSE procedures, into a single function.

   - EXECUTE_AND_CLOSE.  This function combines what would otherwise have
     been separate calls to the native Oracle DBMS_SQL.EXECUTE and
     DBMS_SQL.CLOSE procedures, into a single function.

   - POST_STATE.  This is a package of three procedures and one function all
     of which serve the role of writing the states of all rules as they become
     available, in the system_state table.

   - LOG_FILE.  This is a package of procedures which handle the tasks of
     creating the file in which reconstruction output messages will be written
     to, writing to the latter file, and closing it at the end of
     reconstruction.

   - DBMS_SQL.  This the native Oracle dynamic SQL package.
DEPENDENCIES*/

/*VARIABLES
 Variables

 The following are variables used in the procedure:
   - C (INTEGER). Cursor handle.

   - EXECUTE1 (INTEGER).  The number of rows processed by the SQL statement
     if that statement is an UPDATE, INSERT, or DELETE.  If the SQL statement is
     not an UPDATE, INSERT, or DELETE, this value should be ignored.
VARIABLES*/

/*EXAMPLES
  Examples
 
  Here is a call to BFST_REPORT_FILL:
 
   BEGIN
       BFST_REPORT_FILL (34);
   END;
   /
 
 The argument of this procedure is passed in from procedure any procedure which 
 will fill the BFST.
EXAMPLES*/

/*EXCEPTIONS
 Exceptions

 There are no named exceptions for this procedure, except for the generic one
   WHEN OTHERS.  When the latter is triggered, the error message is outputted
   along with the name of the module that erred, and any cursors that may still
   be opened are closed.  
EXCEPTIONS*/

/*ERRORS
 Errors

 There are no errors that this procedure is known to generate.  Should an
   error occur, take action based on the description of the error.
ERRORS*/

/*TABLES
 Tables
 
 The following tables are referenced in this procedure:
  - CS_STATE_REPORT.  This table created during the initial installation of the
    rules, stores information on the state of all the conseqs found in the BFST
    after every session.

 For more information on this and other tables, see the documentation on tables.
TABLES*/

/*OTHERS
 Others
 
 It should be noted that the reason for reporting when a conseq has been filled
   is to facilitate conseq analysis at a glance through plots, and also to know 
   which conseqs to attempt to fill during the execution of procedure 
   BFST_REFILL_TIMES.

 For more details on this procedure see the reconstruction documentation.
OTHERS*/
