Module Batchdd.pkg

************************************************************************ Confidential Trade Secret. Copyright 1987-1997 Data Access Corporation, Miami FL, USA All Rights reserved DataFlex is a registered trademark of Data Access Corporation. ****************************************************************************// // $File name : BatchDD.pkg // $File title : BusinessProcess class (batch processing) // Notice : // $Author(s) : John Tuohy // // $Rev History // // MG 10/2/98 Changed error_report with additional parameter // JT 9/30/97 Set Focus_mode to no_activate to keep out of F-tree // // JT 9/22/97 Added status_params property and support. // JT 06/29/97 File created // ****************************************************************************// //

Batchdd.pkg (view source)
• import declarations
  • LanguageText.pkg (view source)
  • Windows.pkg (view source)
  • Statpnl.pkg (view source)
    creates object Status_Panel... only if non webapp
  • Msgbox.pkg (view source)
  • GlobalFunctionsProcedures.pkg (view source)
• BusinessProcess : cObject
  Do this so the metadata is correct for windows apps, which means it will be wrong for WebApps.
  • Construct_Object()
    • IntegerStatus_Panel_State
      Status Panel related properties
    • IntegerAllow_Cancel_State
    • StringProcess_Caption
    • StringProcess_Title
    • StringProcess_Message
    • IntegerStatus_Panel_Id
    • StringStatus_Params
    • IntegerDisplay_Error_State
      Error related properties if set true, errors will be forwarded to the normal VDF error handler causing an error message to popup. Normally you would not want this during a batch process.
    • IntegerError_Count
      number of errors
    • IntegerOld_Error_Object_Id
    • integerError_Processing_State
      internal use
    • IntegerError_Check_State
      internal
    • IntegerStatus_Log_State
      Logging
    • IntegerStatus_Log_Id
      If you are going to log information you must create a status log object and set this property to its ID. See Statlog.pkg for more information.
    • handleMain_DD
      This is normally not used at runtime by BPOs but it is required by the IDE to figure out how to structure and relate DDOs
  • Update_Status(string Val)
    ------------------------------------------------------------------------ Status Panel related Messages Send Start_Status Send Resume_Status Send End_Status Send Update_Status StatusString ------------------------------------------------------------------------
    • IntegerStatPnl
  • Start_Status()
    • IntegerStatPnl
  • Resume_Status()
    • IntegerStatPnl
  • End_Status()
    • IntegerStatPnl
  • Start_Log()
    ------------------------------------------------------------------------ Status Logging related Messages Send Start_log Send End_Log Send Error_Log_Status Error_Info Error_Mess Send Log_Status StatusString ------------------------------------------------------------------------
  • End_Log()
    • IntegerErrCount
  • Error_Log_Status(integer Errnum integer iErrLine string ErrMsg)
  • Log_Status(String Mess)
    • IntegerStatId
  • IntegerProcess_Interrupt()
    ------------------------------------------------------------------------ Error and process interupt related Messagss Function Process_Interrupt Returns integer Get Cancel_Check to bShouldStop Procedure Error_Report integer Error_Info String ErrorMess Procedure onError integer Error_info string ErrorMess ------------------------------------------------------------------------ This pops up a message asking if a process should be canceled. Returns non-zero if cancel. This could be augmented, should not be sent.
    • IntegerrVal
    • StringMess
  • IntegerCancel_Check()
    Public way to tell if a process should be canceled. This should be sent but probably not augmented check for report interrupt Returns True to stop report, false to continue
    • IntegerStatPnl
    • IntegerStopIt
  • Error_Report(integer ErrNum integer iErrLine string ErrMsg)
    All errors are directed to the main report. By Default we shut off the status panel, report the error and notify the interrupt mechanism to ask if the report should be canceled. VERY IMPORTANT! If you augment this and you plan on doing ANY windows IO you should first shut of the status panel.
    • Integerid
  • OnError(integer ErrNum integer iErrLine string ErrMsg)
    Event called by Error_Report. For augmentation. If you are planning on doing any interactive IO and you are using the status panel you must first remove the panel (send End_Status).
  • Start_Process()
    ------------------------------------------------------------------------ Process related Messages Send Start_Process Send onProcess Send End_Process Send DoProcess ------------------------------------------------------------------------
  • End_Process()
  • OnProcess()
    This runs the actual busiess process. It is expected that most if not all of the custom code to run a process will be provided here.
  • DoProcess()
    This procedure is the main public access method into this object. A process is run by sending this message. It will start the process, call a user defined Hook (event) to actually do the processing, and then end the process.

References (1):

Field References (0):