7311d92835
Documentation/Design/DatabaseItemToFunctionalSpecificationReference.xls - add rule O-M5 Documentation/pldoc - regenerated Modules/mip_helper_special_cases.pck - make reference to Tripartite rule O-M5 (handled by mip_quotation.pck and mip_tripartite.pck Schema - removed DATA_ITEM_ROLES_IMPORT, added views of enquiries and quote statuses git-svn-id: http://locode01.ad.dom/svn/WEBMIP/trunk@3354 248e525c-4dfb-0310-94bc-949c084e9493
383 lines
11 KiB
HTML
383 lines
11 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<HTML>
|
|
<HEAD>
|
|
<LINK REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
|
|
<TITLE>Package cout_err</TITLE>
|
|
<META name="object" content="PACKAGE">
|
|
<META name="name" content="cout_err">
|
|
<META name="description" content="">
|
|
</HEAD>
|
|
<BODY>
|
|
<TABLE WIDTH="100%"><TR>
|
|
<TD><P ALIGN="LEFT"><STRONG><SMALL></SMALL></STRONG></TD>
|
|
<TD><P ALIGN="RIGHT"><STRONG><SMALL><A HREF="index.html">index</A></SMALL></STRONG></TD>
|
|
</TR></TABLE>
|
|
<TABLE CLASS="MAIN_TABLE"><TR><TD CLASS="DESC_TEXT">
|
|
<P CLASS="MAIN_TITLE">Package cout_err</P>
|
|
|
|
<BR>
|
|
</TD></TR></TABLE>
|
|
<HR>
|
|
<A NAME="Program units"></A>
|
|
<TABLE CLASS="SUB_TABLE"><TR><TD CLASS="SUB_TITLE">
|
|
Program units
|
|
</TD></TR></TABLE>
|
|
<TABLE CLASS="SUB_TABLE">
|
|
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
|
|
<A HREF="#report_and_stop">report_and_stop</A>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
Reports the error and RAISES an exception to halt program execution
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
|
|
<A HREF="#report_and_go">report_and_go</A>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
Reports the error and continues program execution
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
|
|
<A HREF="#logto">logto</A>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
Allows the specification of the log destination
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
|
|
<A HREF="#logging_to">logging_to</A>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
Returns the current log destination.
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
|
|
<A HREF="#about">about</A>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
Return an identification string to link to the source control system.
|
|
</TD></TR>
|
|
</TABLE>
|
|
<BR>
|
|
<A NAME="Types"></A>
|
|
<TABLE CLASS="SUB_TABLE"><TR><TD CLASS="SUB_TITLE">
|
|
Types
|
|
</TD></TR></TABLE>
|
|
<TABLE CLASS="SUB_TABLE">
|
|
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
|
|
<A HREF="#g_t_substitution_list">g_t_substitution_list</A>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
Specifies the substitution values that could be passed into any generated error message
|
|
</TD></TR>
|
|
</TABLE>
|
|
<BR>
|
|
<A NAME="Variables"></A>
|
|
<TABLE CLASS="SUB_TABLE"><TR><TD CLASS="SUB_TITLE">
|
|
Variables
|
|
</TD></TR></TABLE>
|
|
<TABLE CLASS="SUB_TABLE">
|
|
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
|
|
<A HREF="#c_empty_substitution_list">c_empty_substitution_list</A>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
|
|
</TD></TR>
|
|
</TABLE>
|
|
<BR>
|
|
<A NAME="Constants"></A>
|
|
<TABLE CLASS="SUB_TABLE"><TR><TD CLASS="SUB_TITLE">
|
|
Constants
|
|
</TD></TR></TABLE>
|
|
<TABLE CLASS="SUB_TABLE">
|
|
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
|
|
<A HREF="#g_header">g_header</A>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
|
|
<A HREF="#g_revision">g_revision</A>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
|
|
<A HREF="#c_table">c_table</A>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
Specifies logging to be table-based (ERROR_LOGS), this the default log method.
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
|
|
<A HREF="#c_file">c_file</A>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
Specifies logging to be file-based.
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
|
|
<A HREF="#c_screen">c_screen</A>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
Specifies logging to be screen-based.
|
|
</TD></TR>
|
|
</TABLE>
|
|
<BR>
|
|
<HR>
|
|
<A NAME="g_header"></A>
|
|
<P CLASS="TYPE_TITLE">
|
|
g_header
|
|
</P>
|
|
<PRE CLASS="DECL_TEXT">
|
|
g_header CONSTANT VARCHAR2(160) := '$Header: /Isle Of Grain/Database/PLSQL/cout_err.pck 3 1/04/05 16:13 Hardya $';
|
|
</PRE>
|
|
<HR>
|
|
<A NAME="g_revision"></A>
|
|
<P CLASS="TYPE_TITLE">
|
|
g_revision
|
|
</P>
|
|
<PRE CLASS="DECL_TEXT">
|
|
g_revision CONSTANT VARCHAR2(160) := '$Revision: 3 $';
|
|
</PRE>
|
|
<HR>
|
|
<A NAME="c_table"></A>
|
|
<P CLASS="TYPE_TITLE">
|
|
c_table
|
|
</P>
|
|
<PRE CLASS="DECL_TEXT">
|
|
c_table CONSTANT PLS_INTEGER := 1;
|
|
</PRE>
|
|
<P CLASS="DESC_TEXT">
|
|
Specifies logging to be table-based (ERROR_LOGS), this the default log method.<br>
|
|
|
|
<BR>
|
|
</P>
|
|
<HR>
|
|
<A NAME="c_file"></A>
|
|
<P CLASS="TYPE_TITLE">
|
|
c_file
|
|
</P>
|
|
<PRE CLASS="DECL_TEXT">
|
|
c_file CONSTANT PLS_INTEGER := 2;
|
|
</PRE>
|
|
<P CLASS="DESC_TEXT">
|
|
Specifies logging to be file-based.<br>
|
|
|
|
<BR>
|
|
</P>
|
|
<HR>
|
|
<A NAME="c_screen"></A>
|
|
<P CLASS="TYPE_TITLE">
|
|
c_screen
|
|
</P>
|
|
<PRE CLASS="DECL_TEXT">
|
|
c_screen CONSTANT PLS_INTEGER := 3;
|
|
</PRE>
|
|
<P CLASS="DESC_TEXT">
|
|
Specifies logging to be screen-based.<br>
|
|
|
|
<BR>
|
|
</P>
|
|
<HR>
|
|
<A NAME="g_t_substitution_list"></A>
|
|
<P CLASS="TYPE_TITLE">
|
|
g_t_substitution_list
|
|
</P>
|
|
<PRE CLASS="DECL_TEXT">
|
|
TYPE g_t_substitution_list IS TABLE OF VARCHAR2(80) INDEX BY BINARY_INTEGER;
|
|
</PRE>
|
|
<P CLASS="DESC_TEXT">
|
|
Specifies the substitution values that could be passed into any generated error message<br>
|
|
|
|
<BR>
|
|
</P>
|
|
<HR>
|
|
<A NAME="c_empty_substitution_list"></A>
|
|
<P CLASS="TYPE_TITLE">
|
|
c_empty_substitution_list
|
|
</P>
|
|
<PRE CLASS="DECL_TEXT">
|
|
c_empty_substitution_list g_t_substitution_list;
|
|
</PRE>
|
|
<HR>
|
|
<A NAME="report_and_stop"></A>
|
|
<P CLASS="TYPE_TITLE">
|
|
report_and_stop
|
|
</P>
|
|
<PRE CLASS="DECL_TEXT">
|
|
PROCEDURE report_and_stop(p_exception_number IN INTEGER := SQLCODE
|
|
,p_exception_message IN VARCHAR2 := NULL
|
|
,p_substitution_list IN <A HREF=#g_t_substitution_list>g_t_substitution_list</A> := <A HREF=#c_empty_substitution_list>c_empty_substitution_list</A>
|
|
,p_helper_call_level IN NUMBER := 0
|
|
,p_error_group IN VARCHAR2 := 'APPLICATION'
|
|
,p_severity IN VARCHAR2 := 'E'
|
|
,p_source IN VARCHAR2 := NULL)
|
|
|
|
</PRE>
|
|
<P CLASS="DESC_TEXT">
|
|
Reports the error and RAISES an exception to halt program execution<br>
|
|
|
|
<BR>
|
|
</P>
|
|
<A NAME="Parameters"></A>
|
|
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
|
|
Parameters
|
|
</TD></TR></TABLE>
|
|
<TABLE CLASS="LIST_TABLE">
|
|
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
p_exception_number
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
The exception to be raised, defaults to SQLCODE<br>
|
|
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
p_exception_message
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
The message to be logged, defaults to the matching message from EXCEPTION_MESSAGES<br>
|
|
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
p_helper_call
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
If TRUE, indicates that this report is being produced through a helper function<br>
|
|
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
p_error_group
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
The error group that this error should be reported as a part of<br>
|
|
|
|
</TD></TR>
|
|
</TABLE>
|
|
<BR>
|
|
<HR>
|
|
<A NAME="report_and_go"></A>
|
|
<P CLASS="TYPE_TITLE">
|
|
report_and_go
|
|
</P>
|
|
<PRE CLASS="DECL_TEXT">
|
|
PROCEDURE report_and_go(p_exception_number IN INTEGER := SQLCODE
|
|
,p_exception_message IN VARCHAR2 := NULL
|
|
,p_substitution_list IN <A HREF=#g_t_substitution_list>g_t_substitution_list</A> := <A HREF=#c_empty_substitution_list>c_empty_substitution_list</A>
|
|
,p_helper_call_level IN NUMBER := 0
|
|
,p_error_group IN VARCHAR2 := 'APPLICATION'
|
|
,p_severity IN VARCHAR2 := 'E'
|
|
,p_source IN VARCHAR2 := NULL)
|
|
|
|
</PRE>
|
|
<P CLASS="DESC_TEXT">
|
|
Reports the error and continues program execution<br>
|
|
|
|
<BR>
|
|
</P>
|
|
<A NAME="Parameters"></A>
|
|
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
|
|
Parameters
|
|
</TD></TR></TABLE>
|
|
<TABLE CLASS="LIST_TABLE">
|
|
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
p_exception_number
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
The exception to be raised, defaults to SQLCODE<br>
|
|
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
p_exception_message
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
The message to be logged, defaults to the matching message from EXCEPTION_MESSAGES<br>
|
|
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
p_helper_call
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
If TRUE, indicates that this report is being produced through a helper function<br>
|
|
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
p_error_group
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
The error group that this error should be reported as a part of<br>
|
|
|
|
</TD></TR>
|
|
</TABLE>
|
|
<BR>
|
|
<HR>
|
|
<A NAME="logto"></A>
|
|
<P CLASS="TYPE_TITLE">
|
|
logto
|
|
</P>
|
|
<PRE CLASS="DECL_TEXT">
|
|
PROCEDURE logto(p_target IN PLS_INTEGER
|
|
,p_dir IN VARCHAR2 := NULL
|
|
,p_file IN VARCHAR2 := NULL)
|
|
|
|
</PRE>
|
|
<P CLASS="DESC_TEXT">
|
|
Allows the specification of the log destination<br>
|
|
|
|
<BR>
|
|
</P>
|
|
<A NAME="Parameters"></A>
|
|
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
|
|
Parameters
|
|
</TD></TR></TABLE>
|
|
<TABLE CLASS="LIST_TABLE">
|
|
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
p_target
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
The destination (as defined by the constants <A HREF=#c_table>c_table</A>, <A HREF=#c_file>c_file</A> and <A HREF=#c_screen>c_screen</A>
|
|
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
p_dir
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
If file has been chosen, allows the log directory to be specified<br>
|
|
|
|
</TD></TR>
|
|
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
p_file
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
If file has been chosen, allows the log filename to be specified<br>
|
|
|
|
</TD></TR>
|
|
</TABLE>
|
|
<BR>
|
|
<HR>
|
|
<A NAME="logging_to"></A>
|
|
<P CLASS="TYPE_TITLE">
|
|
logging_to
|
|
</P>
|
|
<PRE CLASS="DECL_TEXT">
|
|
FUNCTION logging_to RETURN PLS_INTEGER
|
|
|
|
</PRE>
|
|
<P CLASS="DESC_TEXT">
|
|
Returns the current log destination.<br>
|
|
|
|
<BR>
|
|
</P>
|
|
<A NAME="Returns"></A>
|
|
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
|
|
Returns
|
|
</TD></TR></TABLE>
|
|
<TABLE CLASS="LIST_TABLE">
|
|
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
|
|
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
|
|
Returns a value matching <A HREF=#c_table>c_table</A>, <A HREF=#c_file>c_file</A> or <A HREF=#c_screen>c_screen</A>
|
|
|
|
</TD></TR>
|
|
</TABLE>
|
|
<BR>
|
|
<HR>
|
|
<A NAME="about"></A>
|
|
<P CLASS="TYPE_TITLE">
|
|
about
|
|
</P>
|
|
<PRE CLASS="DECL_TEXT">
|
|
FUNCTION about RETURN VARCHAR2
|
|
|
|
</PRE>
|
|
<P CLASS="DESC_TEXT">
|
|
Return an identification string to link to the source control system.<br>
|
|
|
|
<BR>
|
|
</P>
|
|
<P> </P>
|
|
<P> </P>
|
|
</BODY>
|
|
</HTML>
|