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

471 lines
13 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 mip_quotation</TITLE>
<META name="object" content="PACKAGE">
<META name="name" content="mip_quotation">
<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 mip_quotation</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="#ready_for_quote">ready_for_quote</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Determines whether the given enquiry is ready to quote for i.e.
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#ready_for_quote2">ready_for_quote</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Determines whether the given enquiry is ready to quote for i.e.
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#produce_quotes">produce_quotes</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Generate quotes in response to a 'request for quote' against an enquiry
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#return_mandatory_messages">return_mandatory_messages</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#make_quote_available">make_quote_available</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Make quote available
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#accept_quote">accept_quote</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Accept a quote
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#reject_quote">reject_quote</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Reject a quote
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#reject_all_quotes">reject_all_quotes</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Reject all quotes associated with enquiry
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#select_quote">select_quote</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Select a quote for detailed quotation
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#lapse_quote">lapse_quote</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Lapse a quote
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#lapse_quotes_job">lapse_quotes_job</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="ready_for_quote"></A>
<P CLASS="TYPE_TITLE">
ready_for_quote
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION ready_for_quote(p_enqu_id IN enquiries.id%TYPE) RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Determines whether the given enquiry is ready to quote for i.e. have all the mandatory fields been completed<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_enqu_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the id of the enquiry to be checked<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%>
TRUE if the enquiry can be quoted for<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="ready_for_quote2"></A>
<P CLASS="TYPE_TITLE">
ready_for_quote
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE ready_for_quote(p_enqu_id IN enquiries.id%TYPE
,p_mandatory_checks OUT mip_mandatory.t_mandatory_checks
,p_enquiry_is_ready OUT BOOLEAN)
</PRE>
<P CLASS="DESC_TEXT">
Determines whether the given enquiry is ready to quote for i.e. have all the mandatory fields been completed<br>
&nbsp;<br>
&nbsp;%p_mandatory_checks contains reasons for the enquiry *not* being ready to quote for<br>
&nbsp;%p_quote_is_ready TRUE if the enquiry can be quoted for<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_enqu_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the id of the enquiry to be checked<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="produce_quotes"></A>
<P CLASS="TYPE_TITLE">
produce_quotes
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE produce_quotes(p_enqu_id IN enquiries.id%TYPE
,p_rfq_prty_id IN parties.id%TYPE
,p_owner_prty_id IN parties.id%TYPE DEFAULT NULL)
</PRE>
<P CLASS="DESC_TEXT">
Generate quotes in response to a 'request for quote' against an enquiry<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_enqu_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the id of the enquiry to be checked<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_prty_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the id of the party that requested the quotes<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_owner_prty_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the id of party that owns the quotes (defaults to the requestor)<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="return_mandatory_messages"></A>
<P CLASS="TYPE_TITLE">
return_mandatory_messages
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION return_mandatory_messages(p_enqu_id IN enquiries.id%TYPE)
RETURN VARCHAR2
</PRE>
<HR>
<A NAME="make_quote_available"></A>
<P CLASS="TYPE_TITLE">
make_quote_available
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE make_quote_available(p_qute_id IN quotes.id%TYPE)
</PRE>
<P CLASS="DESC_TEXT">
Make quote available<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_qute_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
id of the quote to be marked as available<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="accept_quote"></A>
<P CLASS="TYPE_TITLE">
accept_quote
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE accept_quote(p_qute_id IN quotes.id%TYPE
,p_description quote_events.description%TYPE DEFAULT NULL
,p_event_date IN DATE DEFAULT SYSDATE)
</PRE>
<P CLASS="DESC_TEXT">
Accept a quote<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_qute_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
id of the quote to be accepted<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%>
optional description to be recorded with the event<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_event_date&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
optional date for this event (defaults to now)<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="reject_quote"></A>
<P CLASS="TYPE_TITLE">
reject_quote
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE reject_quote(p_qute_id IN quotes.id%TYPE
,p_description quote_events.description%TYPE DEFAULT NULL
,p_event_date IN DATE DEFAULT SYSDATE)
</PRE>
<P CLASS="DESC_TEXT">
Reject a quote<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_qute_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
id of the quote to be rejected<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%>
optional description to be recorded with the event<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_event_date&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
optional date for this event (defaults to now)<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="reject_all_quotes"></A>
<P CLASS="TYPE_TITLE">
reject_all_quotes
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE reject_all_quotes(p_enqu_id IN enquiries.id%TYPE
,p_description quote_events.description%TYPE DEFAULT NULL
,p_event_date IN DATE DEFAULT SYSDATE)
</PRE>
<P CLASS="DESC_TEXT">
Reject all quotes associated with enquiry<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_enqu_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
id of the enquiry for qhich all quotes are to be rejected<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%>
optional description to be recorded with the event<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_event_date&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
optional date for this event (defaults to now)<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="select_quote"></A>
<P CLASS="TYPE_TITLE">
select_quote
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE select_quote(p_qute_id IN quotes.id%TYPE
,p_description quote_events.description%TYPE DEFAULT NULL
,p_event_date IN DATE DEFAULT SYSDATE)
</PRE>
<P CLASS="DESC_TEXT">
Select a quote for detailed quotation<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_qute_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
id of the quote to be selected<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%>
optional description to be recorded with the event<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_event_date&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
optional date for this event (defaults to now)<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="lapse_quote"></A>
<P CLASS="TYPE_TITLE">
lapse_quote
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE lapse_quote(p_qute_id IN quotes.id%TYPE
,p_description quote_events.description%TYPE DEFAULT NULL
,p_event_date IN DATE DEFAULT SYSDATE)
</PRE>
<P CLASS="DESC_TEXT">
Lapse a quote<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_qute_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
id of the quote to be selected<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%>
optional description to be recorded with the event<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_event_date&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
optional date for this event (defaults to now)<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="lapse_quotes_job"></A>
<P CLASS="TYPE_TITLE">
lapse_quotes_job
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE lapse_quotes_job
</PRE>
<P>&nbsp;</P>
<P>&nbsp;</P>
</BODY>
</HTML>