LEHS - Log- and Exception Handling System for ORACLE


Package pkg_lehs

This Package is the user defined Interface for the Log-System.

For the Concepts of the Log-System itself please refer to the pldoc Pages of the Package PKG_LEHS_SYSTEM.
The Description of this Package refers only to the Methods within this Package. That is really enough to figure out.


Field Summary
 BINARY_INTEGERpc_buffer
           Default Buffer Size for GET_LOG_DATA
 LEHS_EXCEPTION_MESSAGES.nls_language%TYPEpc_default_language
           Default Language for the Exception Messages

Type Summary
 LEHS_APPLICATIONS.application%TYPEpst_application_name()
           Datatype for the Log-Application
 LEHS_EXCEPTION_MESSAGES.name%TYPEpst_error_name()
           Datatype for the Error Names of named Exception
 LEHS_TOPICS.topic_name%TYPEpst_log_topic()
           Datatype for the Log-Topics
 LEHS_TRANSACTIONS.transaction_id%TYPEpst_log_transaction()
           Datatype for the Log-Transaction
 VARYING ARRAY(9) OF VARCHAR2(2000) INDEX BY nullpt_error_arguments()
           List-Type for the Exception Arguments
Every named Exception is a parametrized Exception.
 TABLE OF lehs_log_table_basic%ROWTYPE INDEX BY nullpt_log_table()
           Output-Datatype for the pipelined Function GET_LOG_DATA

Method Summary
 add_message(pi_application pst_application_name, pi_error_name pst_error_name, pi_error_code BINARY_INTEGER, pi_message CLOB, pi_show_error_stack BOOLEAN DEFAULT TRUE, pi_nls_language VARCHAR2 DEFAULT pc_default_language)
           Add a new or change an existing Exception Message for the specified Application.
 add_topic(pi_application pst_application_name, pi_topic VARCHAR2, pi_topic_parent VARCHAR2, pi_topic_predecessor VARCHAR2)
           Adds a new Log-Topic to the specified Application.
 add_topic(pi_application pst_application_name, pi_topic VARCHAR2, pi_topic_parent VARCHAR2, pi_position BINARY_INTEGER DEFAULT NULL)
           Adds a new Log-Topic to the specified Application.
 add_transaction_key(pi_application pst_application_name, pi_transaction_id pst_log_transaction, pi_key VARCHAR2, pi_value CLOB)
           Adds an alphanumeric Key to the given Log-Transaction.
 add_transaction_key(pi_application pst_application_name, pi_transaction_id pst_log_transaction, pi_key VARCHAR2, pi_value VARCHAR2)
           Adds an alphanumeric Key to the given Log-Transaction.
 add_transaction_key(pi_application pst_application_name, pi_transaction_id pst_log_transaction, pi_key VARCHAR2, pi_value NUMBER)
           Adds a numeric Key to the given Log-Transaction.
 add_transaction_key(pi_application pst_application_name, pi_transaction_id pst_log_transaction, pi_key VARCHAR2, pi_value DATE)
           Adds a Date Key to the given Log-Transaction.
 add_transaction_key(pi_application pst_application_name, pi_transaction_id pst_log_transaction, pi_key VARCHAR2, pi_value DSINTERVAL_UNCONSTRAINED)
           Adds a Day to Second Interval Key to the given Log-Transaction.
 add_transaction_key(pi_application pst_application_name, pi_transaction_id pst_log_transaction, pi_key VARCHAR2, pi_value YMINTERVAL_UNCONSTRAINED)
           Adds a Year to Month Interval Key to the given Log-Transaction.
 add_transaction_key(pi_application pst_application_name, pi_transaction_id pst_log_transaction, pi_key VARCHAR2, pi_value TIMESTAMP_UNCONSTRAINED)
           Adds a Timestamp Key to the given Log-Transaction.
 assert(pi_assertion BOOLEAN, pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments, pi_log BOOLEAN DEFAULT TRUE, pi_log_level VARCHAR2 DEFAULT NULL)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application if the Assertion fails.
 assert(pi_assertion BOOLEAN, pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments, pi_log_level VARCHAR2 DEFAULT NULL)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails.
 assert_debug(pi_assertion BOOLEAN, pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level DEBUG.
 assert_debug(pi_assertion BOOLEAN, pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level DEBUG.
 assert_error(pi_assertion BOOLEAN, pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level ERROR.
 assert_error(pi_assertion BOOLEAN, pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level ERROR.
 assert_fatal(pi_assertion BOOLEAN, pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level FATAL.
 assert_fatal(pi_assertion BOOLEAN, pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level FATAL.
 assert_info(pi_assertion BOOLEAN, pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level INFO.
 assert_info(pi_assertion BOOLEAN, pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level INFO.
 assert_trace(pi_assertion BOOLEAN, pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level TRACE.
 assert_trace(pi_assertion BOOLEAN, pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level TRACE.
 assert_warn(pi_assertion BOOLEAN, pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level WARN.
 assert_warn(pi_assertion BOOLEAN, pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level WARN.
 debug(pi_application pst_application_name, pi_message CLOB)
           Logs a Message to a specific Application with the programable DEBUG Log-Level
 debug(pi_application pst_application_name, pi_topic VARCHAR2, pi_message CLOB)
           Logs a Message to a specific Application with the programable DEBUG Log-Level.
 end_log_transaction(pi_application pst_application_name)
           Stops the actual open Log-Transaction to the specified Application
 error(pi_application pst_application_name, pi_message CLOB)
           Logs a Message to a specific Application with the programable ERROR Log-Level
 error(pi_application pst_application_name, pi_topic VARCHAR2, pi_message CLOB)
           Logs a Message to a specific Application with the programable ERROR Log-Level.
 fatal(pi_application pst_application_name, pi_message CLOB)
           Logs a Message to a specific Application with the programable FATAL Log-Level
 fatal(pi_application pst_application_name, pi_topic VARCHAR2, pi_message CLOB)
           Logs a Message to a specific Application with the programable FATAL Log-Level.
 PKG_LEHS.pst_error_nameget_last_exception_name(pi_application PKG_LEHS.pst_application_name)
          
 VARCHAR2get_version()
           Returns the Version of LEHS
 handle_exception(pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application.
 handle_exception_and_log(pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments, pi_log_level VARCHAR2 DEFAULT NULL)
           Raises a named Exception to the specified Application and logs it to the specified Application.
 handle_exception_and_log(pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments, pi_log_level VARCHAR2 DEFAULT NULL)
           Raises a named Exception to the specified Application and logs it to the specified Application.
 handle_exception_and_log_debug(pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level DEBUG.
 handle_exception_and_log_debug(pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level DEBUG.
 handle_exception_and_log_error(pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level ERROR.
 handle_exception_and_log_error(pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level ERROR.
 handle_exception_and_log_fatal(pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level FATAL.
 handle_exception_and_log_fatal(pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level FATAL.
 handle_exception_and_log_info(pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level INFO.
 handle_exception_and_log_info(pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level INFO.
 handle_exception_and_log_trace(pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level TRACE.
 handle_exception_and_log_trace(pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level TRACE.
 handle_exception_and_log_warn(pi_application pst_application_name, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level WARN.
 handle_exception_and_log_warn(pi_application pst_application_name, pi_topic VARCHAR2, pi_error_name pst_error_name, pi_error_arguments pt_error_arguments)
           Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level WARN.
 info(pi_application pst_application_name, pi_message CLOB)
           Logs a Message to a specific Application with the programable INFO Log-Level
 info(pi_application pst_application_name, pi_topic VARCHAR2, pi_message CLOB)
           Logs a Message to a specific Application with the programable INFO Log-Level.
 BOOLEANis_debug_enabled(pi_application pst_application_name)
           Is the DEBUG-Mode enabled at the specified Application.
 BOOLEANis_error_enabled(pi_application pst_application_name)
           Is the ERROR-Mode enabled at the specified Application.
 BOOLEANis_fatal_enabled(pi_application pst_application_name)
           Is the FATAL-Mode enabled at the specified Application.
 BOOLEANis_info_enabled(pi_application pst_application_name)
           Is the INFO-Mode enabled at the specified Application.
 BOOLEANis_log_level_enabled(pi_application pst_application_name, pi_log_level VARCHAR2)
           Is the specified Log-Level enabled at the specified Application.
 BOOLEANis_named_exception(pi_application pst_application_name, pi_error_code BINARY_INTEGER)
           Does the given Error Code correspond to any named Exception of the specified Application?
 BOOLEANis_named_exception(pi_application pst_application_name, pi_error_code BINARY_INTEGER, pi_error_name pst_error_name)
           Does the given Error Code correspond to the given named Exception of the specified Application?
 BOOLEANis_trace_enabled(pi_application pst_application_name)
           Is the TRACE-Mode enabled at the specified Application.
 BOOLEANis_warn_enabled(pi_application pst_application_name)
           Is the WARN-Mode enabled at the specified Application.
 join_log_transaction(pi_application pst_application_name, pi_transaction_id pst_log_transaction)
           Joins an open Log-Transaction with a Log-Transaction Number got by START_LOG_TRANSACTION
 log(pi_application pst_application_name, pi_log_level VARCHAR2, pi_message CLOB)
           Logs a Message to a specific Application with a predefined Log-Level
 log(pi_application pst_application_name, pi_topic VARCHAR2, pi_log_level VARCHAR2, pi_message CLOB)
           Logs a Message to a specific Application with a predefined Log-Level.
 log_exception(pi_application pst_application_name, pi_topic VARCHAR2 DEFAULT NULL, pi_log_app_exception BOOLEAN DEFAULT FALSE, pi_log_level VARCHAR2 DEFAULT NULL)
           Logs an unhandled, unnamed Exception to the specified Application.
 log_exception_debug(pi_application pst_application_name, pi_topic VARCHAR2 DEFAULT NULL, pi_log_app_exception BOOLEAN DEFAULT FALSE)
           Logs an unhandled, unnamed Exception to the specified Application and logs it with the programmable Log-Level DEBUG.
 log_exception_error(pi_application pst_application_name, pi_topic VARCHAR2 DEFAULT NULL, pi_log_app_exception BOOLEAN DEFAULT FALSE)
           Logs an unhandled, unnamed Exception to the specified Application and logs it with the programmable Log-Level ERROR.
 log_exception_fatal(pi_application pst_application_name, pi_topic VARCHAR2 DEFAULT NULL, pi_log_app_exception BOOLEAN DEFAULT FALSE)
           Logs an unhandled, unnamed Exception to the specified Application and logs it with the programmable Log-Level FATAL.
 log_exception_info(pi_application pst_application_name, pi_topic VARCHAR2 DEFAULT NULL, pi_log_app_exception BOOLEAN DEFAULT FALSE)
           Logs an unhandled, unnamed Exception to the specified Application and logs it with the programmable Log-Level INFO.
 log_exception_trace(pi_application pst_application_name, pi_topic VARCHAR2 DEFAULT NULL, pi_log_app_exception BOOLEAN DEFAULT FALSE)
           Logs an unhandled, unnamed Exception to the specified Application and logs it with the programmable Log-Level TRACE.
 log_exception_warn(pi_application pst_application_name, pi_topic VARCHAR2 DEFAULT NULL, pi_log_app_exception BOOLEAN DEFAULT FALSE)
           Logs an unhandled, unnamed Exception to the specified Application and logs it with the programmable Log-Level WARN.
 resync()
           Resynchronize the internal Buffer Cache (useful, when the Data of the Log-System has been changed.
 resync_on_modification()
           Resynchronize the internal Buffer Cache when the Log-Application has been modified by PKG_LEHS_SYSTEM.
 pst_log_transactionstart_log_transaction(pi_application pst_application_name)
           Starts a new Log-Transaction to the specific Log-Application
 trace(pi_application pst_application_name, pi_message CLOB)
           Logs a Message to a specific Application with the programable TRACE Log-Level
 trace(pi_application pst_application_name, pi_topic VARCHAR2, pi_message CLOB)
           Logs a Message to a specific Application with the programable TRACE Log-Level.
 warn(pi_application pst_application_name, pi_message CLOB)
           Logs a Message to a specific Application with the programable WARN Log-Level
 warn(pi_application pst_application_name, pi_topic VARCHAR2, pi_message CLOB)
           Logs a Message to a specific Application with the programable WARN Log-Level.

Field Detail

pc_buffer

  public BINARY_INTEGER pc_buffer
Default Buffer Size for GET_LOG_DATA

pc_default_language

  public LEHS_EXCEPTION_MESSAGES.nls_language%TYPE pc_default_language
Default Language for the Exception Messages

Type Detail

pt_error_arguments

  public VARYING ARRAY(9) OF VARCHAR2(2000) INDEX BY null pt_error_arguments()
List-Type for the Exception Arguments
Every named Exception is a parametrized Exception. The Placeholder Values %1 to %9 (max 9 Parameters) are set by the PL/SQL-Application during the Runtime. Look above at HANDLE_EXCEPTION and HANDLE_EXCEPTION_AND_LOG for an Example

pt_log_table

  public TABLE OF lehs_log_table_basic%ROWTYPE INDEX BY null pt_log_table()
Output-Datatype for the pipelined Function GET_LOG_DATA

pst_error_name

  public LEHS_EXCEPTION_MESSAGES.name%TYPE pst_error_name()
Datatype for the Error Names of named Exception

pst_application_name

  public LEHS_APPLICATIONS.application%TYPE pst_application_name()
Datatype for the Log-Application

pst_log_topic

  public LEHS_TOPICS.topic_name%TYPE pst_log_topic()
Datatype for the Log-Topics

pst_log_transaction

  public LEHS_TRANSACTIONS.transaction_id%TYPE pst_log_transaction()
Datatype for the Log-Transaction

Method Detail

log

  public  log(pi_application pst_application_name, 
pi_log_level VARCHAR2,
pi_message CLOB)
Logs a Message to a specific Application with a predefined Log-Level
Parameters:
pi_application - Log-Application of the applied Message
pi_log_level - predefined Log-Level
pi_message - Log Message

log

  public  log(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_log_level VARCHAR2,
pi_message CLOB)
Logs a Message to a specific Application with a predefined Log-Level.

This Message applies to the given Log-Topic

Parameters:
pi_application - Log-Application of the applied Message
pi_topic - Log-Topic of the applied Message
pi_log_level - predefined Log-Level
pi_message - Log Message

fatal

  public  fatal(pi_application pst_application_name, 
pi_message CLOB)
Logs a Message to a specific Application with the programable FATAL Log-Level
Parameters:
pi_application - Log-Application of the applied Message
pi_message - Log Message

fatal

  public  fatal(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_message CLOB)
Logs a Message to a specific Application with the programable FATAL Log-Level.

This Message applies to the given Log-Topic

Parameters:
pi_application - Log-Application of the applied Message
pi_message - Log Message

error

  public  error(pi_application pst_application_name, 
pi_message CLOB)
Logs a Message to a specific Application with the programable ERROR Log-Level
Parameters:
pi_application - Log-Application of the applied Message
pi_message - Log Message

error

  public  error(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_message CLOB)
Logs a Message to a specific Application with the programable ERROR Log-Level.

This Message applies to the given Log-Topic

Parameters:
pi_application - Log-Application of the applied Message
pi_message - Log Message

warn

  public  warn(pi_application pst_application_name, 
pi_message CLOB)
Logs a Message to a specific Application with the programable WARN Log-Level
Parameters:
pi_application - Log-Application of the applied Message
pi_message - Log Message

warn

  public  warn(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_message CLOB)
Logs a Message to a specific Application with the programable WARN Log-Level.

This Message applies to the given Log-Topic

Parameters:
pi_application - Log-Application of the applied Message
pi_message - Log Message

info

  public  info(pi_application pst_application_name, 
pi_message CLOB)
Logs a Message to a specific Application with the programable INFO Log-Level
Parameters:
pi_application - Log-Application of the applied Message
pi_message - Log Message

info

  public  info(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_message CLOB)
Logs a Message to a specific Application with the programable INFO Log-Level.

This Message applies to the given Log-Topic

Parameters:
pi_application - Log-Application of the applied Message
pi_message - Log Message

debug

  public  debug(pi_application pst_application_name, 
pi_message CLOB)
Logs a Message to a specific Application with the programable DEBUG Log-Level
Parameters:
pi_application - Log-Application of the applied Message
pi_message - Log Message

debug

  public  debug(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_message CLOB)
Logs a Message to a specific Application with the programable DEBUG Log-Level.

This Message applies to the given Log-Topic

Parameters:
pi_application - Log-Application of the applied Message
pi_message - Log Message

trace

  public  trace(pi_application pst_application_name, 
pi_message CLOB)
Logs a Message to a specific Application with the programable TRACE Log-Level
Parameters:
pi_application - Log-Application of the applied Message
pi_message - Log Message

trace

  public  trace(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_message CLOB)
Logs a Message to a specific Application with the programable TRACE Log-Level.

This Message applies to the given Log-Topic

Parameters:
pi_application - Log-Application of the applied Message
pi_message - Log Message

start_log_transaction

  public pst_log_transaction start_log_transaction(pi_application pst_application_name)
Starts a new Log-Transaction to the specific Log-Application
Parameters:
pi_application - Log-Application the Transaction applies to
Returns:
Number of the Log-Transaction

join_log_transaction

  public  join_log_transaction(pi_application pst_application_name, 
pi_transaction_id pst_log_transaction)
Joins an open Log-Transaction with a Log-Transaction Number got by START_LOG_TRANSACTION
Parameters:
pi_application - Log-Application which the Log-Transaction Number applies to
pi_transaction_id - Log-Transaction Number by START_LOG_TRANSACTION

end_log_transaction

  public  end_log_transaction(pi_application pst_application_name)
Stops the actual open Log-Transaction to the specified Application
Parameters:
pi_application - Log-Application where the actual Transaction should be stopped

is_trace_enabled

  public BOOLEAN is_trace_enabled(pi_application pst_application_name)
Is the TRACE-Mode enabled at the specified Application.

In fact that means, is the maximum Log-Level of the Log-Application higher or equal to the programmable Log-Level TRACE

Parameters:
pi_application - Log-Application to be checked
Returns:
  • TRUE ... TRACE-Mode is enabled
  • FALSE ... TRACE-Mode is not enabled

is_debug_enabled

  public BOOLEAN is_debug_enabled(pi_application pst_application_name)
Is the DEBUG-Mode enabled at the specified Application.

In fact that means, is the maximum Log-Level of the Log-Application higher or equal to the programmable Log-Level DEBUG

Parameters:
pi_application - Log-Application to be checked
Returns:
  • TRUE ... DEBUG-Mode is enabled
  • FALSE ... DEBUG-Mode is not enabled

is_info_enabled

  public BOOLEAN is_info_enabled(pi_application pst_application_name)
Is the INFO-Mode enabled at the specified Application.

In fact that means, is the maximum Log-Level of the Log-Application higher or equal to the programmable Log-Level INFO

Parameters:
pi_application - Log-Application to be checked
Returns:
  • TRUE ... INFO-Mode is enabled
  • FALSE ... INFO-Mode is not enabled

is_warn_enabled

  public BOOLEAN is_warn_enabled(pi_application pst_application_name)
Is the WARN-Mode enabled at the specified Application.

In fact that means, is the maximum Log-Level of the Log-Application higher or equal to the programmable Log-Level WARN

Parameters:
pi_application - Log-Application to be checked
Returns:
  • TRUE ... WARN-Mode is enabled
  • FALSE ... WARN-Mode is not enabled

is_error_enabled

  public BOOLEAN is_error_enabled(pi_application pst_application_name)
Is the ERROR-Mode enabled at the specified Application.

In fact that means, is the maximum Log-Level of the Log-Application higher or equal to the programmable Log-Level ERROR

Parameters:
pi_application - Log-Application to be checked
Returns:
  • TRUE ... ERROR-Mode is enabled
  • FALSE ... ERROR-Mode is not enabled

is_fatal_enabled

  public BOOLEAN is_fatal_enabled(pi_application pst_application_name)
Is the FATAL-Mode enabled at the specified Application.

In fact that means, is the maximum Log-Level of the Log-Application higher or equal to the programmable Log-Level FATAL

Parameters:
pi_application - Log-Application to be checked
Returns:
  • TRUE ... FATAL-Mode is enabled
  • FALSE ... FATAL-Mode is not enabled

is_log_level_enabled

  public BOOLEAN is_log_level_enabled(pi_application pst_application_name, 
pi_log_level VARCHAR2)
Is the specified Log-Level enabled at the specified Application.

In fact that means, is the maximum Log-Level of the Log-Application higher or equal to the given Log-Level.

Parameters:
pi_application - Log-Application to be checked
Returns:
  • TRUE ... given Log-Level is enabled
  • FALSE ... given Log-Level is not enabled

handle_exception

  public  handle_exception(pi_application pst_application_name, 
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception (
      'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log

  public  handle_exception_and_log(pi_application pst_application_name, 
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments,
pi_log_level VARCHAR2 DEFAULT NULL)
Raises a named Exception to the specified Application and logs it to the specified Application.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
pi_log_level - optional Log-Level for the Exception Log. If omitted or the Value is NULL the Exception Log-Level of the Application will be taken
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log

  public  handle_exception_and_log(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments,
pi_log_level VARCHAR2 DEFAULT NULL)
Raises a named Exception to the specified Application and logs it to the specified Application.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'A Log Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
pi_log_level - optional Log-Level for the Exception Log. If omitted or the Value is NULL the Exception Log-Level of the Application will be taken
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log_fatal

  public  handle_exception_and_log_fatal(pi_application pst_application_name, 
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level FATAL.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log_fatal

  public  handle_exception_and_log_fatal(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level FATAL.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'A Log Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log_error

  public  handle_exception_and_log_error(pi_application pst_application_name, 
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level ERROR.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log_error

  public  handle_exception_and_log_error(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level ERROR.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'A Log Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log_warn

  public  handle_exception_and_log_warn(pi_application pst_application_name, 
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level WARN.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log_warn

  public  handle_exception_and_log_warn(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level WARN.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'A Log Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log_info

  public  handle_exception_and_log_info(pi_application pst_application_name, 
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level INFO.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log_info

  public  handle_exception_and_log_info(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level INFO.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'A Log Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log_debug

  public  handle_exception_and_log_debug(pi_application pst_application_name, 
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level DEBUG.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log_debug

  public  handle_exception_and_log_debug(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level DEBUG.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'A Log Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log_trace

  public  handle_exception_and_log_trace(pi_application pst_application_name, 
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level TRACE.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

handle_exception_and_log_trace

  public  handle_exception_and_log_trace(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Raises a named Exception to the specified Application and logs it to the specified Application with the programmable Log-Level TRACE.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Error at Calculation Step %1: Wrong Value %2. Allowed Values: %3
    PKG_LEHS.handle_exception_and_log (
      'Log Application'
     ,'A Log Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,v_wrong_value
       ,v_allowed_values
      )
    )
 
Parameters:
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert

  public  assert(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments,
pi_log BOOLEAN DEFAULT TRUE,
pi_log_level VARCHAR2 DEFAULT NULL)
Checks the Assertion to TRUE and raises a named Exception to the specified Application if the Assertion fails.

If the Assertion fails then the Exception to the given Error Name will be raised.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 

Optionally if you set the Parameter pi_log to TRUE (Default: TRUE) then a failed Assertion will also be logged with the Exception of Parameter pi_log_level.
If the Parameter pi_log_level will be omitted (or explicitly given NULL) then the Exception Log-Level of the Log-Application will be taken.

Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
pi_log - Should a failed Assertion also be logged?
pi_log_level - optional Log-Level for the Exception Log. If omitted or the Value is NULL the Exception Log-Level of the Application will be taken
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert

  public  assert(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments,
pi_log_level VARCHAR2 DEFAULT NULL)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails.

If the Assertion fails then the Exception to the given Error Name will be raised.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'some Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 

By calling this Procedure a failed Assertion will always be logged with the Log-Level of Parameter pi_log_level because you give a Log-Topic. If the Parameter pi_log_level has be omitted (or been explicitly set to NULL) then the Exception Log-Level of the Log-Application will be taken.

Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
pi_log_level - optional Log-Level for the Exception Log. If omitted or the Value is NULL the Exception Log-Level of the Application will be taken
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert_fatal

  public  assert_fatal(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level FATAL.

If the Assertion fails then the Exception to the given Error Name will be raised.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,'some Topic'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 
Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert_fatal

  public  assert_fatal(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level FATAL.

If the Assertion fails then the Exception to the given Error Name will be raised.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'some Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 
Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert_error

  public  assert_error(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level ERROR.

If the Assertion fails then the Exception to the given Error Name will be raised.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,'some Topic'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 
Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert_error

  public  assert_error(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level ERROR.

If the Assertion fails then the Exception to the given Error Name will be raised.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'some Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 
Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert_warn

  public  assert_warn(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level WARN.

If the Assertion fails then the Exception to the given Error Name will be raised.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,'some Topic'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 
Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert_warn

  public  assert_warn(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level WARN.

If the Assertion fails then the Exception to the given Error Name will be raised.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'some Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 
Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert_info

  public  assert_info(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level INFO.

If the Assertion fails then the Exception to the given Error Name will be raised.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,'some Topic'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 
Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert_info

  public  assert_info(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level INFO.

If the Assertion fails then the Exception to the given Error Name will be raised.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'some Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 
Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert_debug

  public  assert_debug(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level DEBUG.

If the Assertion fails then the Exception to the given Error Name will be raised.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,'some Topic'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 
Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert_debug

  public  assert_debug(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level DEBUG.

If the Assertion fails then the Exception to the given Error Name will be raised.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'some Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 
Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert_trace

  public  assert_trace(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level TRACE.

If the Assertion fails then the Exception to the given Error Name will be raised.

The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'CALC_STEP_WRONG_VALUE'
     ,'some Topic'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 
Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

assert_trace

  public  assert_trace(pi_assertion BOOLEAN, 
pi_application pst_application_name,
pi_topic VARCHAR2,
pi_error_name pst_error_name,
pi_error_arguments pt_error_arguments)
Checks the Assertion to TRUE and raises a named Exception to the specified Application and logs it to the specified Application if the Assertion fails with the programmable Log-Level TRACE.

If the Assertion fails then the Exception to the given Error Name will be raised.

The Exception Message will be applied to the given Log-Topic.
The List of dynamic Content will be used to replace the Placeholder within the Exception Message with the real Values during the Runtime.

Example:

    ...
    -- Message for Exception CALC_STEP_WRONG_VALUE:
    -- Assertion failed Step %1: %2
    PKG_LEHS.assert (
      v_variable IS NOT NULL
     ,'Log Application'
     ,'some Topic'
     ,'CALC_STEP_WRONG_VALUE'
     ,PKG_LEHS.pt_error_arguments (
        TO_CHAR(1)
       ,'v_variable IS NULL'
      )
    )
 
Parameters:
pi_assertion - Assertion to be TRUE
pi_application - Name of the Application the named Exception applies to
pi_topic - Log-Topic the Exception Message applies to at the Log
pi_error_name - Name of the named Exception
pi_error_arguments - List of the dynamic Content
Throws:
ORA-20??? - User defined Exception as deposited to the named Exception

log_exception

  public  log_exception(pi_application pst_application_name, 
pi_topic VARCHAR2 DEFAULT NULL,
pi_log_app_exception BOOLEAN DEFAULT FALSE,
pi_log_level VARCHAR2 DEFAULT NULL)
Logs an unhandled, unnamed Exception to the specified Application.

The Exception Message will be assigned to the given Log-Topic.
This Procedure should be called at the End of every Procedure of the Application. Example

   CREATE OR REPLACE PROCEDURE xyz IS
     ...
   BEGIN
     ..
   EXCEPTION
     WHEN OTHERS THEN
       PKG_LEHS.log_exception ('App1', 'Topic1');
       RAISE;
   END;
 
Parameters:
pi_application - Application the Exception Message should be logged to
pi_topic - Log-Topic the logged Exception Message should be assigned to
pi_log_app_exception - Should a user defined named Exception of the Application be logged? (Default: FALSE)
If NULL then the Default will be taken.
pi_log_level - optional Log-Level for the Exception Log. If omitted or the Value is NULL the Exception Log-Level of the Application will be taken

log_exception_fatal

  public  log_exception_fatal(pi_application pst_application_name, 
pi_topic VARCHAR2 DEFAULT NULL,
pi_log_app_exception BOOLEAN DEFAULT FALSE)
Logs an unhandled, unnamed Exception to the specified Application and logs it with the programmable Log-Level FATAL.

The Exception Message will be assigned to the given Log-Topic.
This Procedure should be called at the End of every Procedure of the Application. Example

   CREATE OR REPLACE PROCEDURE xyz IS
     ...
   BEGIN
     ..
   EXCEPTION
     WHEN OTHERS THEN
       PKG_LEHS.log_exception ('App1', 'Topic1');
       RAISE;
   END;
 
Parameters:
pi_application - Application the Exception Message should be logged to
pi_topic - Log-Topic the logged Exception Message should be assigned to
pi_log_app_exception - Should a user defined named Exception of the Application be logged? (Default: FALSE)
If NULL then the Default will be taken.

log_exception_error

  public  log_exception_error(pi_application pst_application_name, 
pi_topic VARCHAR2 DEFAULT NULL,
pi_log_app_exception BOOLEAN DEFAULT FALSE)
Logs an unhandled, unnamed Exception to the specified Application and logs it with the programmable Log-Level ERROR.

The Exception Message will be assigned to the given Log-Topic.
This Procedure should be called at the End of every Procedure of the Application. Example

   CREATE OR REPLACE PROCEDURE xyz IS
     ...
   BEGIN
     ..
   EXCEPTION
     WHEN OTHERS THEN
       PKG_LEHS.log_exception ('App1', 'Topic1');
       RAISE;
   END;
 
Parameters:
pi_application - Application the Exception Message should be logged to
pi_topic - Log-Topic the logged Exception Message should be assigned to
pi_log_app_exception - Should a user defined named Exception of the Application be logged? (Default: FALSE)
If NULL then the Default will be taken.

log_exception_warn

  public  log_exception_warn(pi_application pst_application_name, 
pi_topic VARCHAR2 DEFAULT NULL,
pi_log_app_exception BOOLEAN DEFAULT FALSE)
Logs an unhandled, unnamed Exception to the specified Application and logs it with the programmable Log-Level WARN.

The Exception Message will be assigned to the given Log-Topic.
This Procedure should be called at the End of every Procedure of the Application. Example

   CREATE OR REPLACE PROCEDURE xyz IS
     ...
   BEGIN
     ..
   EXCEPTION
     WHEN OTHERS THEN
       PKG_LEHS.log_exception ('App1', 'Topic1');
       RAISE;
   END;
 
Parameters:
pi_application - Application the Exception Message should be logged to
pi_topic - Log-Topic the logged Exception Message should be assigned to
pi_log_app_exception - Should a user defined named Exception of the Application be logged? (Default: FALSE)
If NULL then the Default will be taken.

log_exception_info

  public  log_exception_info(pi_application pst_application_name, 
pi_topic VARCHAR2 DEFAULT NULL,
pi_log_app_exception BOOLEAN DEFAULT FALSE)
Logs an unhandled, unnamed Exception to the specified Application and logs it with the programmable Log-Level INFO.

The Exception Message will be assigned to the given Log-Topic.
This Procedure should be called at the End of every Procedure of the Application. Example

   CREATE OR REPLACE PROCEDURE xyz IS
     ...
   BEGIN
     ..
   EXCEPTION
     WHEN OTHERS THEN
       PKG_LEHS.log_exception ('App1', 'Topic1');
       RAISE;
   END;
 
Parameters:
pi_application - Application the Exception Message should be logged to
pi_topic - Log-Topic the logged Exception Message should be assigned to
pi_log_app_exception - Should a user defined named Exception of the Application be logged? (Default: FALSE)
If NULL then the Default will be taken.

log_exception_debug

  public  log_exception_debug(pi_application pst_application_name, 
pi_topic VARCHAR2 DEFAULT NULL,
pi_log_app_exception BOOLEAN DEFAULT FALSE)
Logs an unhandled, unnamed Exception to the specified Application and logs it with the programmable Log-Level DEBUG.

The Exception Message will be assigned to the given Log-Topic.
This Procedure should be called at the End of every Procedure of the Application. Example

   CREATE OR REPLACE PROCEDURE xyz IS
     ...
   BEGIN
     ..
   EXCEPTION
     WHEN OTHERS THEN
       PKG_LEHS.log_exception ('App1', 'Topic1');
       RAISE;
   END;
 
Parameters:
pi_application - Application the Exception Message should be logged to
pi_topic - Log-Topic the logged Exception Message should be assigned to
pi_log_app_exception - Should a user defined named Exception of the Application be logged? (Default: FALSE)
If NULL then the Default will be taken.

log_exception_trace

  public  log_exception_trace(pi_application pst_application_name, 
pi_topic VARCHAR2 DEFAULT NULL,
pi_log_app_exception BOOLEAN DEFAULT FALSE)
Logs an unhandled, unnamed Exception to the specified Application and logs it with the programmable Log-Level TRACE.

The Exception Message will be assigned to the given Log-Topic.
This Procedure should be called at the End of every Procedure of the Application. Example

   CREATE OR REPLACE PROCEDURE xyz IS
     ...
   BEGIN
     ..
   EXCEPTION
     WHEN OTHERS THEN
       PKG_LEHS.log_exception ('App1', 'Topic1');
       RAISE;
   END;
 
Parameters:
pi_application - Application the Exception Message should be logged to
pi_topic - Log-Topic the logged Exception Message should be assigned to
pi_log_app_exception - Should a user defined named Exception of the Application be logged? (Default: FALSE)
If NULL then the Default will be taken.

is_named_exception

  public BOOLEAN is_named_exception(pi_application pst_application_name, 
pi_error_code BINARY_INTEGER)
Does the given Error Code correspond to any named Exception of the specified Application?
Parameters:
pi_application - Log-Application the Error Code should be checked against
pi_error_code - Error Code as got by the BuiltIn-Function SQLCODE
Returns:
  • TRUE ... The Error-Code is assigned to a registered named Exception of the specified Application
  • FALSE ... The Error-Code is not assigned to any registered named Exception of the specified Application

is_named_exception

  public BOOLEAN is_named_exception(pi_application pst_application_name, 
pi_error_code BINARY_INTEGER,
pi_error_name pst_error_name)
Does the given Error Code correspond to the given named Exception of the specified Application?
Parameters:
pi_application - Log-Application the Error Code should be checked against the named Exception
pi_error_code - Error Code as got by the BuiltIn-Function SQLCODE
pi_error_name - named Exception of the specified Application to be checked
Returns:
  • TRUE ... The Error-Code is assigned to the given named Exception of the specified Application
  • FALSE ... The Error-Code is not assigned to the given named Exception of the specified Application

add_transaction_key

  public  add_transaction_key(pi_application pst_application_name, 
pi_transaction_id pst_log_transaction,
pi_key VARCHAR2,
pi_value CLOB)
Adds an alphanumeric Key to the given Log-Transaction.

Additional Log-Transaction Keys can be found by the View USER_LEHS_TRANSACTIONS.

Parameters:
pi_application - Log-Application the Keyword should be added
pi_transaction_id - Transaction-ID the Keyword should be added
pi_key - Name of the Key
pi_value - Value of the Key
Throws:
ORA-20001 - [MISSING PARAMETER] missing mandatory Parameter
ORA-20008 - [LOG TRANSACTION NOT EXISTS] The given Log-Transaction doesn't exist to the specified Log-Application
ORA-20008 - [LOG TRANSACTION NOT OPEN] The specified Log-Transaction is no longer in State OPEN for the specified Log-Application

add_transaction_key

  public  add_transaction_key(pi_application pst_application_name, 
pi_transaction_id pst_log_transaction,
pi_key VARCHAR2,
pi_value VARCHAR2)
Adds an alphanumeric Key to the given Log-Transaction.

Additional Log-Transaction Keys can be found by the View USER_LEHS_TRANSACTIONS.

Parameters:
pi_application - Log-Application the Keyword should be added
pi_transaction_id - Transaction-ID the Keyword should be added
pi_key - Name of the Key
pi_value - Value of the Key
Throws:
ORA-20001 - [MISSING PARAMETER] missing mandatory Parameter
ORA-20008 - [LOG TRANSACTION NOT EXISTS] The given Log-Transaction doesn't exist to the specified Log-Application
ORA-20008 - [LOG TRANSACTION NOT OPEN] The specified Log-Transaction is no longer in State OPEN for the specified Log-Application

add_transaction_key

  public  add_transaction_key(pi_application pst_application_name, 
pi_transaction_id pst_log_transaction,
pi_key VARCHAR2,
pi_value NUMBER)
Adds a numeric Key to the given Log-Transaction.

Additional Log-Transaction Keys can be found by the View USER_LEHS_TRANSACTIONS.

Within the View USER_LEHS_TRANSACTIONS the Value will be formatted automatically with the builtin Function TO_CHAR, which takes advantage of the actual Session-Parameter NLS_NUMERIC_CHARACTERS.

Parameters:
pi_application - Log-Application the Keyword should be added
pi_transaction_id - Transaction-ID the Keyword should be added
pi_key - Name of the Key
pi_value - Value of the Key
Throws:
ORA-20001 - [MISSING PARAMETER] missing mandatory Parameter
ORA-20008 - [LOG TRANSACTION NOT EXISTS] The given Log-Transaction doesn't exist to the specified Log-Application
ORA-20008 - [LOG TRANSACTION NOT OPEN] The specified Log-Transaction is no longer in State OPEN for the specified Log-Application

add_transaction_key

  public  add_transaction_key(pi_application pst_application_name, 
pi_transaction_id pst_log_transaction,
pi_key VARCHAR2,
pi_value DATE)
Adds a Date Key to the given Log-Transaction.

Additional Log-Transaction Keys can be found by the View USER_LEHS_TRANSACTIONS.

Within the View USER_LEHS_TRANSACTIONS the Value will be formatted automatically with the builtin Function TO_CHAR, which takes advantage of the actual Session-Parameter NLS_DATE_FORMAT.

Parameters:
pi_application - Log-Application the Keyword should be added
pi_transaction_id - Transaction-ID the Keyword should be added
pi_key - Name of the Key
pi_value - Value of the Key
Throws:
ORA-20001 - [MISSING PARAMETER] missing mandatory Parameter
ORA-20008 - [LOG TRANSACTION NOT EXISTS] The given Log-Transaction doesn't exist to the specified Log-Application
ORA-20008 - [LOG TRANSACTION NOT OPEN] The specified Log-Transaction is no longer in State OPEN for the specified Log-Application

add_transaction_key

  public  add_transaction_key(pi_application pst_application_name, 
pi_transaction_id pst_log_transaction,
pi_key VARCHAR2,
pi_value DSINTERVAL_UNCONSTRAINED)
Adds a Day to Second Interval Key to the given Log-Transaction.

Additional Log-Transaction Keys can be found by the View USER_LEHS_TRANSACTIONS.

Within the View USER_LEHS_TRANSACTIONS the Value will be formatted automatically with the builtin Function TO_CHAR, but unfortunately there is no separate Session-Parameter where you can configure the Format of the Character Conversion of this Parameter.

Parameters:
pi_application - Log-Application the Keyword should be added
pi_transaction_id - Transaction-ID the Keyword should be added
pi_key - Name of the Key
pi_value - Value of the Key
Throws:
ORA-20001 - [MISSING PARAMETER] missing mandatory Parameter
ORA-20008 - [LOG TRANSACTION NOT EXISTS] The given Log-Transaction doesn't exist to the specified Log-Application
ORA-20008 - [LOG TRANSACTION NOT OPEN] The specified Log-Transaction is no longer in State OPEN for the specified Log-Application

add_transaction_key

  public  add_transaction_key(pi_application pst_application_name, 
pi_transaction_id pst_log_transaction,
pi_key VARCHAR2,
pi_value YMINTERVAL_UNCONSTRAINED)
Adds a Year to Month Interval Key to the given Log-Transaction.

Additional Log-Transaction Keys can be found by the View USER_LEHS_TRANSACTIONS.

Within the View USER_LEHS_TRANSACTIONS the Value will be formatted automatically with the builtin Function TO_CHAR, but unfortunately there is no separate Session-Parameter where you can configure the Format of the Character Conversion of this Parameter.

Parameters:
pi_application - Log-Application the Keyword should be added
pi_transaction_id - Transaction-ID the Keyword should be added
pi_key - Name of the Key
pi_value - Value of the Key
Throws:
ORA-20001 - [MISSING PARAMETER] missing mandatory Parameter
ORA-20008 - [LOG TRANSACTION NOT EXISTS] The given Log-Transaction doesn't exist to the specified Log-Application
ORA-20008 - [LOG TRANSACTION NOT OPEN] The specified Log-Transaction is no longer in State OPEN for the specified Log-Application

add_transaction_key

  public  add_transaction_key(pi_application pst_application_name, 
pi_transaction_id pst_log_transaction,
pi_key VARCHAR2,
pi_value TIMESTAMP_UNCONSTRAINED)
Adds a Timestamp Key to the given Log-Transaction.

Additional Log-Transaction Keys can be found by the View USER_LEHS_TRANSACTIONS.

Within the View USER_LEHS_TRANSACTIONS the Date-Value will be formatted automatically with the builtin Function TO_CHAR, which takes advantage of the actual Session-Parameter NLS_TIMESTAMP_FORMAT.

Parameters:
pi_application - Log-Application the Keyword should be added
pi_transaction_id - Transaction-ID the Keyword should be added
pi_key - Name of the Key
pi_value - Value of the Key
Throws:
ORA-20001 - [MISSING PARAMETER] missing mandatory Parameter
ORA-20008 - [LOG TRANSACTION NOT EXISTS] The given Log-Transaction doesn't exist to the specified Log-Application
ORA-20008 - [LOG TRANSACTION NOT OPEN] The specified Log-Transaction is no longer in State OPEN for the specified Log-Application

add_topic

  public  add_topic(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_topic_parent VARCHAR2,
pi_topic_predecessor VARCHAR2)
Adds a new Log-Topic to the specified Application.

If the Topic already exists to this Application it would only be moved under the hierarchical Level of pi_topic_parent after the Topic pi_topic_predecessor

Parameters:
pi_application - Log-Application the Log-Topic should be created to
pi_topic - Name of the new Topic
pi_topic_parent - Name of the parent Topic the new Topic should be arranged below
pi_topic_predecessor - Name of the predecessor Topic the new Topic should be arranged after
If the predecessing Topic should have an other parent Topic than the new Topic the Parent Topic of the predecessing Topic would be taken instead.

add_topic

  public  add_topic(pi_application pst_application_name, 
pi_topic VARCHAR2,
pi_topic_parent VARCHAR2,
pi_position BINARY_INTEGER DEFAULT NULL)
Adds a new Log-Topic to the specified Application.

If the Topic already exists to this Application it would only be moved to the new Position specified by pi_position under the hierarchical Level as pi_topic_parent

Parameters:
pi_application - Log-Application the Log-Topic should be created to
pi_topic - Name of the new Topic
pi_topic_parent - Name of the parent Topic the new Topic should be arranged below
pi_position - Position of the new Topic within the horizontal Order (0,1 = first Position, NULL = last Position)

add_message

  public  add_message(pi_application pst_application_name, 
pi_error_name pst_error_name,
pi_error_code BINARY_INTEGER,
pi_message CLOB,
pi_show_error_stack BOOLEAN DEFAULT TRUE,
pi_nls_language VARCHAR2 DEFAULT pc_default_language)
Add a new or change an existing Exception Message for the specified Application.
Parameters:
pi_application - Application the Exception Message should be added/changed
pi_error_name - Error Name of the Exception Message (named Exception) The Error Name will always be uppercased automatically.
pi_error_code - Error Code the Exception Message will be assigned to. (Should between ORA-20999 and ORA-20000)
pi_message - parametrized Exception Message (Placeholder for Parameters are %1 to %9).
pi_show_error_stack - When the named Exception will be raised should any existing Error-Stack also be raised with this named Exception (look at BuiltIn-Function RAISE_APPLICATION_ERROR, 3rd Parameter
(Default: TRUE)
pi_nls_language - NLS-Language of the Exception Message. Default or NULL: AMERICAN

get_last_exception_name

  public PKG_LEHS.pst_error_name get_last_exception_name(pi_application PKG_LEHS.pst_application_name)

resync

  public  resync()
Resynchronize the internal Buffer Cache (useful, when the Data of the Log-System has been changed.

resync_on_modification

  public  resync_on_modification()
Resynchronize the internal Buffer Cache when the Log-Application has been modified by PKG_LEHS_SYSTEM.

If no change has been made then the buffer will not be refreshed


get_version

  public VARCHAR2 get_version()
Returns the Version of LEHS
Returns:
Version of LEHS

LEHS - Log- and Exception Handling System for ORACLE