Class: BusinessProcess
Do this so the metadata is correct for windows apps, which
means it will be wrong for WebApps.
Class Hierarchy:
cObject

BusinessProcessClass Definition
Properties
Integer
Allow_Cancel_State
Integer
Display_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.
Integer
Error_Check_State
internal
Integer
Error_Count
number of errors
integer
Error_Processing_State
internal use
handle
Main_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
Integer
Old_Error_Object_Id
String
Process_Caption
String
Process_Message
String
Process_Title
Integer
Status_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.
Integer
Status_Log_State
Logging
Integer
Status_Panel_Id
Integer
Status_Panel_State
Status Panel related properties
String
Status_Params
Functions and Procedures
Integer
Cancel_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

Construct_Object()

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.

End_Log()

End_Process()

End_Status()

Error_Log_Status(integer Errnum integer iErrLine string ErrMsg)

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.

Log_Status(String Mess)

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).

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.
Integer
Process_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.

Resume_Status()

Start_Log()
------------------------------------------------------------------------
Status Logging related Messages
Send Start_log
Send End_Log
Send Error_Log_Status Error_Info Error_Mess
Send Log_Status StatusString
------------------------------------------------------------------------

Start_Process()
------------------------------------------------------------------------
Process related Messages
Send Start_Process
Send onProcess
Send End_Process
Send DoProcess
------------------------------------------------------------------------

Start_Status()

Update_Status(string Val)
------------------------------------------------------------------------
Status Panel related Messages
Send Start_Status
Send Resume_Status
Send End_Status
Send Update_Status StatusString
------------------------------------------------------------------------
References (2):