PBDoc Example using Code Review Template Review Sheet v1.0
Object: nc_exception Size: 1967
Comment: Example Object Inherited from Exception to show custom exceptions v3.0.0 Last Modified: 03/08/2006 20:14
Location: d:\PB\PBDoc\prod\example\pbdoc_example_ansi.pbl<nc_exception.sru>
Author: Review Date: 25/03/2006 14:32:38
Reviewer:   Signed:  
Instance Vars: Included Shared Vars: None External: None
Functions: 3 Controls: 0 Events: 0

Instance Variable Definition Comments
protected:
String      is_Database
 

Local Function Definition
public string GetDatabase () Comments
/********************************************************************
   GetDatabase

   <DESC>   Returns the setting of the database attribute</DESC>

   <RETURN> Value of the database setting for this exception.</RETURN>

   <ACCESS> Public

   <USAGE>   ls_DB = myex.GetDatabase()</USAGE>

********************************************************************/

RETURN is_Database
 
public SetDatabase ( string as_Database value ) Comments
/********************************************************************
   SetDatabase

   <DESC>   Method to set the database name for this exception.</DESC>

   <ACCESS> Public

   <ARGS>   as_Database: Database details to be set as part of this
            exception.</ARGS>

   <USAGE>   myex.SetDatabase( SQLCA.DBMS )</USAGE>

********************************************************************/
is_Database = as_Database
 
public string GetMessage () Comments
/********************************************************************
   GetMessage

   <DESC>   Overload to add the DB details</DESC>

   <RETURN> Description of the Exception</RETURN>

   <ACCESS> Public

   <USAGE>   ls_Msg = myEx.GetMessage()</USAGE>

********************************************************************/

String ls_Ret

ls_Ret = super::GetMessage() + ' ' + is_Database

RETURN ls_Ret
 

End of Review Document