Files
mip/Documentation/pldoc/cout_system_configuration.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

270 lines
7.6 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_system_configuration</TITLE>
<META name="object" content="PACKAGE">
<META name="name" content="cout_system_configuration">
<META name="description" content="Package containing the common utility system configuration routines used by the Access Manager application">
</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_system_configuration</P>
Package containing the common utility system configuration routines used by the Access Manager application<br>
<BR>
<A NAME="Version"></A>
<TABLE CLASS="MAIN_TABLE"><TR><TD CLASS="LIST_TITLE">
Version
</TD></TR></TABLE>
<TABLE CLASS="MAIN_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
$Revision: $
</TD></TR>
</TABLE>
<BR>
<A NAME="Author"></A>
<TABLE CLASS="MAIN_TABLE"><TR><TD CLASS="LIST_TITLE">
Author
</TD></TR></TABLE>
<TABLE CLASS="MAIN_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Andy Hardy
</TD></TR>
</TABLE>
<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="#add_configuration_item_date">add_configuration_item_date</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Add a date configuration item
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#add_configuration_item">add_configuration_item</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Add a non-date configuration item
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#get_configuration_item_date">get_configuration_item_date</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Get a date configuration item
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#get_configuration_item">get_configuration_item</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Get a configuration item
</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_date_format">g_date_format</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Default date format for stored configuration items
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="g_date_format"></A>
<P CLASS="TYPE_TITLE">
g_date_format
</P>
<PRE CLASS="DECL_TEXT">
g_date_format CONSTANT VARCHAR2(80) := 'DD/MM/YYYY HH24:MI:SS';
</PRE>
<P CLASS="DESC_TEXT">
Default date format for stored configuration items<br>
<BR>
</P>
<HR>
<A NAME="add_configuration_item_date"></A>
<P CLASS="TYPE_TITLE">
add_configuration_item_date
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE add_configuration_item_date(p_parameter IN system_configuration.parameter%TYPE
,p_value IN DATE
,p_description IN system_configuration.description%TYPE := NULL)
</PRE>
<P CLASS="DESC_TEXT">
Add a date configuration item<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_parameter&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The name of the configuration item<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_value&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The value to be given to the configuration item<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_description&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The description of the configuration item<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="add_configuration_item"></A>
<P CLASS="TYPE_TITLE">
add_configuration_item
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE add_configuration_item(p_parameter IN system_configuration.parameter%TYPE
,p_value IN system_configuration.VALUE%TYPE DEFAULT NULL
,p_description IN system_configuration.description%TYPE := NULL)
</PRE>
<P CLASS="DESC_TEXT">
Add a non-date configuration item<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_parameter&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The name of the configuration item<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_value&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The value to be given to the configuration item<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_description&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The description of the configuration item<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="get_configuration_item_date"></A>
<P CLASS="TYPE_TITLE">
get_configuration_item_date
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION get_configuration_item_date(p_parameter IN system_configuration.parameter%TYPE)
RETURN DATE
</PRE>
<P CLASS="DESC_TEXT">
Get a date configuration item<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_parameter&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The name of the configuration item to be retrieved<br>
</TD></TR>
</TABLE>
<BR>
<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%>
Value of the configuration item as a date<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="get_configuration_item"></A>
<P CLASS="TYPE_TITLE">
get_configuration_item
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION get_configuration_item(p_parameter IN system_configuration.parameter%TYPE)
RETURN system_configuration.VALUE%TYPE
</PRE>
<P CLASS="DESC_TEXT">
Get a configuration item<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_parameter&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The name of the configuration item to be retrieved<br>
</TD></TR>
</TABLE>
<BR>
<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%>
Value of the configuration item<br>
</TD></TR>
</TABLE>
<BR>
<P>&nbsp;</P>
<P>&nbsp;</P>
</BODY>
</HTML>