andy/mip
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Files
master
mip/Documentation/pldoc/cout_assert.html
hardya 7311d92835 Seed/enst.ctl - add INVALID status 
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
2008-01-22 17:59:56 +00:00

430 lines
14 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
<TITLE>Package cout_assert</TITLE>
<META name="object" content="PACKAGE">
<META name="name" content="cout_assert">
<META name="description" content="Package of assertion routines to make it easy to validate assumptions in a declarative fashion.">
</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_assert</P>
Package of assertion routines to make it easy to validate assumptions in a declarative fashion.<br>
<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="#istrue">istrue</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Asserts whether the given p_condition is true
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#isnotnull">isnotnull</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Asserts whether the given p_value IS NOT NULL
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#isnotnull2">isnotnull</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Asserts whether the given p_value IS NOT NULL
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#isnotnull3">isnotnull</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Asserts whether the given p_value IS NOT NULL
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#isnotnull4">isnotnull</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Asserts whether the given p_value IS NOT NULL
</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>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</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>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="g_t_substitution_list"></A>
<P CLASS="TYPE_TITLE">
g_t_substitution_list
</P>
<PRE CLASS="DECL_TEXT">
SUBTYPE g_t_substitution_list IS cout_err.g_t_substitution_list;
</PRE>
<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="istrue"></A>
<P CLASS="TYPE_TITLE">
istrue
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE istrue(p_condition IN BOOLEAN
,p_message IN VARCHAR2
,p_raise_exception IN BOOLEAN := TRUE
,p_exception IN NUMBER := -6502
,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 := 1)
</PRE>
<P CLASS="DESC_TEXT">
Asserts whether the given p_condition is true<br>
<BR>
</P>
<A NAME="Usage"></A>
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
Usage
</TD></TR></TABLE>
<TABLE CLASS="LIST_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
cout_assert.istrue(p_inmo_type IN ('CR', 'CU', 'INMO', 'CA', 'CT'),p_message =&gt; 'Invalid inmo_type passed');<br>
</TD></TR>
</TABLE>
<BR>
<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_condition&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The condition to be asserted as TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_message&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The message to be displayed when the assertion is NOT TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_raise_exception&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Requests that an exception be raised if the assertion is NOT TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_exception&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The exception to be raised, if requested<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_subsitution_list&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Table of values to be substituted into the generated exception message<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_helper_call_level&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
If being used by a 'helper' procedure, indicates the call above the curremt call to be reported<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="isnotnull"></A>
<P CLASS="TYPE_TITLE">
isnotnull
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE isnotnull(p_value IN VARCHAR2
,p_message IN VARCHAR2
,p_raise_exception IN BOOLEAN := TRUE
,p_exception IN NUMBER := -6502
,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>)
</PRE>
<P CLASS="DESC_TEXT">
Asserts whether the given p_value IS NOT NULL<br>
<BR>
</P>
<A NAME="Usage"></A>
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
Usage
</TD></TR></TABLE>
<TABLE CLASS="LIST_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
cout_assert.isnotnull(p_value =&gt; l_inst_id,p_message =&gt; 'Inventory statement not found');<br>
</TD></TR>
</TABLE>
<BR>
<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_condition&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The condition to be asserted as TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_message&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The message to be displayed when the assertion is NOT TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_raise_exception&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Requests that an exception be raised if the assertion is NOT TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_exception&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The exception to be raised, if requested<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_subsitution_list&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Table of values to be substituted into the generated exception message<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="isnotnull2"></A>
<P CLASS="TYPE_TITLE">
isnotnull
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE isnotnull(p_value IN DATE
,p_message IN VARCHAR2
,p_raise_exception IN BOOLEAN := TRUE
,p_exception IN NUMBER := -6502
,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>)
</PRE>
<P CLASS="DESC_TEXT">
Asserts whether the given p_value IS NOT NULL<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_condition&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The condition to be asserted as TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_message&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The message to be displayed when the assertion is NOT TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_raise_exception&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Requests that an exception be raised if the assertion is NOT TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_exception&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The exception to be raised, if requested<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_subsitution_list&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Table of values to be substituted into the generated exception message<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="isnotnull3"></A>
<P CLASS="TYPE_TITLE">
isnotnull
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE isnotnull(p_value IN NUMBER
,p_message IN VARCHAR2
,p_raise_exception IN BOOLEAN := TRUE
,p_exception IN NUMBER := -6502
,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>)
</PRE>
<P CLASS="DESC_TEXT">
Asserts whether the given p_value IS NOT NULL<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_condition&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The condition to be asserted as TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_message&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The message to be displayed when the assertion is NOT TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_raise_exception&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Requests that an exception be raised if the assertion is NOT TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_exception&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The exception to be raised, if requested<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_subsitution_list&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Table of values to be substituted into the generated exception message<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="isnotnull4"></A>
<P CLASS="TYPE_TITLE">
isnotnull
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE isnotnull(p_value IN BOOLEAN
,p_message IN VARCHAR2
,p_raise_exception IN BOOLEAN := TRUE
,p_exception IN NUMBER := -6502
,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>)
</PRE>
<P CLASS="DESC_TEXT">
Asserts whether the given p_value IS NOT NULL<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_condition&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The condition to be asserted as TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_message&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The message to be displayed when the assertion is NOT TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_raise_exception&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Requests that an exception be raised if the assertion is NOT TRUE<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_exception&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The exception to be raised, if requested<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_subsitution_list&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Table of values to be substituted into the generated exception message<br>
</TD></TR>
</TABLE>
<BR>
<P>&nbsp;</P>
<P>&nbsp;</P>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink