andy/mip
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Scheme Changes:

Browse Source 
Replaced Access_Controls with APEX_AUTHORISATION
Created POSTCODES, ERROR_LOGS and SYSTEM_CONFIGURATION.
Added missing columns to ENQUIRIES, REGULATORS, etc.
Added views V_PROFILE_RT_CODE_FOR_ENRO.vw, V_PARTY_RELATIONSHIPS.vw, V_LATEST_RT_CODE_FOR_ENRO.vw.

Modules:

Added cout_err.pck, cout_system_configuration.pck.

Data:

Added Data/Demo files
Added Data/Seed files for postcodes, regions and DatabaseItemToFunctionalSpecificationReference.csv

Documentation:

Added Documentation/pldoc for plsqldoc-generated files.
Added Documentation/SupportingDocumentation/Regions to hold region definition information.

git-svn-id: http://locode01.ad.dom/svn/WEBMIP/trunk@2890 248e525c-4dfb-0310-94bc-949c084e9493
This commit is contained in:
hardya
2007-11-27 11:48:13 +00:00
parent 2a490afbbc
commit 2920f4d016
49 changed files with 18360 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
Documentation/SupportingDocumentation/Regions/Asset ownership by job type and Network.xls Normal file
View File

Binary file not shown.

BIN
Documentation/SupportingDocumentation/Regions/Charges document APRIL 2007 (2).doc Normal file
View File

Binary file not shown.

BIN
Documentation/SupportingDocumentation/Regions/GDSC - Postcode.pdf Normal file
View File

Binary file not shown.

BIN
Documentation/SupportingDocumentation/Regions/NationalGridMeteringChargesfrom1stApril2007.pdf Normal file
View File

Binary file not shown.

BIN
Documentation/SupportingDocumentation/Regions/Unit Rates Comparison NGN Final.xls Normal file
View File

Binary file not shown.

BIN
Documentation/SupportingDocumentation/Regions/Unit Rates Comparison Scotland Final.xls Normal file
View File

Binary file not shown.

BIN
Documentation/SupportingDocumentation/Regions/Unit Rates Comparison Southern Final.xls Normal file
View File

Binary file not shown.

BIN
Documentation/SupportingDocumentation/Regions/Unit Rates ComparisonWWUFinal.xls Normal file
View File

Binary file not shown.

BIN
Documentation/SupportingDocumentation/Regions/zvoutcode.xls Normal file
View File

Binary file not shown.

BIN
Documentation/SupportingDocumentation/Regions/zvpostcode.xls Normal file
View File

Binary file not shown.

153
Documentation/pldoc/V_LATEST_RT_CODE_FOR_ENRO.html Normal file
View File

@@ -0,0 +1,153 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
<TITLE>View V_LATEST_RT_CODE_FOR_ENRO</TITLE>
<META name="object" content="VIEW">
<META name="name" content="V_LATEST_RT_CODE_FOR_ENRO">
<META name="description" content="">
<META name="columns" content="PRTY_ID RT_CODE START_DATE END_DATE ENQU_ID">
</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">View V_LATEST_RT_CODE_FOR_ENRO</P>
</TD></TR></TABLE>
<HR>
<A NAME="Columns"></A>
<TABLE CLASS="SUB_TABLE"><TR><TD CLASS="SUB_TITLE">
Columns
</TD></TR></TABLE>
<TABLE CLASS="SIMPLE_TABLE">
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Name
</U>
</TD>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Type
</U>
</TD>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Optional
</U>
</TD>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Default
</U>
</TD>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Comments
</U>
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
PRTY_ID
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
NUMBER
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
RT_CODE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
VARCHAR2(80)
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
START_DATE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
DATE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
END_DATE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
DATE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
Y
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
ENQU_ID
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
NUMBER
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
</TABLE>
<HR>
<A NAME="SQL"></A>
<TABLE CLASS="SUB_TABLE"><TR><TD CLASS="SUB_TITLE">
SQL
</TD></TR></TABLE><PRE CLASS="DECL_TEXT">
CREATE OR REPLACE VIEW V_LATEST_RT_CODE_FOR_ENRO AS
SELECT prty_id
,rt_code
,start_date
,end_date
,enqu_id
FROM (SELECT enro.*
,MAX(start_date) over(PARTITION BY rt_code, enqu_id) AS max_date_rt_code
FROM enquiry_roles enro)
WHERE start_date = max_date_rt_code;
</PRE>
<P>&nbsp;</P>
<P>&nbsp;</P>
</BODY>
</HTML>

227
Documentation/pldoc/V_PARTY_RELATIONSHIPS.html Normal file
View File

@@ -0,0 +1,227 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
<TITLE>View V_PARTY_RELATIONSHIPS</TITLE>
<META name="object" content="VIEW">
<META name="name" content="V_PARTY_RELATIONSHIPS">
<META name="description" content="">
<META name="columns" content="FROM_PARL_PRTY_ID FROM_RT_CODE TO_PARL_PRTY_ID TO_RT_CODE DESCRIPTION EFFECTIVE_START EFFECTIVE_END">
</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">View V_PARTY_RELATIONSHIPS</P>
</TD></TR></TABLE>
<HR>
<A NAME="Columns"></A>
<TABLE CLASS="SUB_TABLE"><TR><TD CLASS="SUB_TITLE">
Columns
</TD></TR></TABLE>
<TABLE CLASS="SIMPLE_TABLE">
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Name
</U>
</TD>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Type
</U>
</TD>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Optional
</U>
</TD>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Default
</U>
</TD>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Comments
</U>
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
FROM_PARL_PRTY_ID
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
NUMBER
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
FROM_RT_CODE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
VARCHAR2(80)
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
TO_PARL_PRTY_ID
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
NUMBER
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
TO_RT_CODE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
VARCHAR2(80)
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
DESCRIPTION
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
VARCHAR2(80)
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
Y
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
EFFECTIVE_START
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
DATE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
Y
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
EFFECTIVE_END
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
DATE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
Y
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
</TABLE>
<HR>
<A NAME="SQL"></A>
<TABLE CLASS="SUB_TABLE"><TR><TD CLASS="SUB_TITLE">
SQL
</TD></TR></TABLE><PRE CLASS="DECL_TEXT">
CREATE OR REPLACE VIEW V_PARTY_RELATIONSHIPS AS
SELECT from_parl.prty_id AS from_parl_prty_id
,prtp.from_rt_code
,to_parl.prty_id AS to_parl_prty_id
,prtp.to_rt_code
,prtp.description
,greatest(from_parl.start_date
,prel.start_date
,to_parl.start_date) AS effective_start
,least(nvl(from_parl.end_date
,to_date('31-dec-2099'
,'dd-mon-yyyy'))
,nvl(to_parl.end_date
,to_date('31-dec-2099'
,'dd-mon-yyyy'))
,nvl(prel.end_date
,to_date('31-dec-2099'
,'dd-mon-yyyy'))) AS effective_end
FROM (SELECT prty.first_name
,prty.last_name
,prty.username
,parl.prty_id
,parl.rt_code
,parl.id
,parl.start_date
,parl.end_date
FROM parties prty
,party_roles parl
WHERE parl.prty_id = prty.id) from_parl
,(SELECT prty.first_name
,prty.last_name
,prty.username
,parl.prty_id
,parl.rt_code
,parl.id
,parl.start_date
,parl.end_date
FROM parties prty
,party_roles parl
WHERE parl.prty_id = prty.id) to_parl
,party_relationship_types prtp
,party_relationships prel
WHERE prel.from_parl_id = from_parl.id
AND prel.from_parl_prty_id = from_parl.prty_id
AND prel.from_parl_rt_code = from_parl.rt_code
AND prel.to_parl_id = to_parl.id
AND prel.to_parl_prty_id = to_parl.prty_id
AND prel.to_parl_rt_code = to_parl.rt_code
AND prtp.from_rt_code = prel.from_parl_rt_code
AND prtp.to_rt_code = prel.to_parl_rt_code;
</PRE>
<P>&nbsp;</P>
<P>&nbsp;</P>
</BODY>
</HTML>

175
Documentation/pldoc/V_PROFILE_RT_CODE_FOR_ENRO.html Normal file
View File

@@ -0,0 +1,175 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
<TITLE>View V_PROFILE_RT_CODE_FOR_ENRO</TITLE>
<META name="object" content="VIEW">
<META name="name" content="V_PROFILE_RT_CODE_FOR_ENRO">
<META name="description" content="">
<META name="columns" content="PRTY_ID RT_CODE START_DATE END_DATE NEXT_START_DATE ENQU_ID">
</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">View V_PROFILE_RT_CODE_FOR_ENRO</P>
</TD></TR></TABLE>
<HR>
<A NAME="Columns"></A>
<TABLE CLASS="SUB_TABLE"><TR><TD CLASS="SUB_TITLE">
Columns
</TD></TR></TABLE>
<TABLE CLASS="SIMPLE_TABLE">
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Name
</U>
</TD>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Type
</U>
</TD>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Optional
</U>
</TD>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Default
</U>
</TD>
<TD VALIGN="TOP" CLASS="LIST_ITEM"><U>
Comments
</U>
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">PRTY_ID</A>
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
NUMBER
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">RT_CODE</A>
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
VARCHAR2(80)
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">START_DATE</A>
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
DATE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">END_DATE</A>
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
DATE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
Y
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
NEXT_START_DATE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
DATE
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
Y
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
<TR>
<TD VALIGN="TOP" CLASS="LIST_ITEM">
<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">ENQU_ID</A>
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
NUMBER
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
Y
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
<TD VALIGN="TOP" CLASS="DESC_TEXT">
&nbsp;
</TD>
</TR>
</TABLE>
<HR>
<A NAME="SQL"></A>
<TABLE CLASS="SUB_TABLE"><TR><TD CLASS="SUB_TITLE">
SQL
</TD></TR></TABLE><PRE CLASS="DECL_TEXT">
CREATE OR REPLACE VIEW V_PROFILE_RT_CODE_FOR_ENRO AS
SELECT <A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">prty_id</A>
,<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">rt_code</A>
,<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">start_date</A>
,<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">end_date</A>
,next_start_date
,<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">enqu_id</A>
FROM (SELECT enro.prty_id
,enro.rt_code
,enro.start_date
,enro.end_date
,<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">enqu_id</A>
,lead(<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">start_date</A>
,1) over(PARTITION BY <A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">rt_code</A>, <A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">enqu_id</A> ORDER BY <A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">start_date</A>) AS next_start_date
FROM enquiry_roles enro);
</PRE>
<P>&nbsp;</P>
<P>&nbsp;</P>
</BODY>
</HTML>

12
Documentation/pldoc/frame.html Normal file
View File

@@ -0,0 +1,12 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<link REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
<title>PL/SQL Doc - Index</title>
</HEAD>
<!-- frames -->
<FRAMESET COLS="250px,*" BORDER=1 FRAMEBORDER=2 FRAMESPACING=0>
<FRAME NAME="index" SRC="frame_index.html" MARGINWIDTH="0" MARGINHEIGHT="0" SCROLLING="auto" FRAMEBORDER="0">
<FRAME NAME="body" SRC="frame_home.html" MARGINWIDTH="0" MARGINHEIGHT="0" SCROLLING="auto" FRAMEBORDER="0">
</FRAMESET>
</HTML>

10
Documentation/pldoc/frame_home.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
<title>PL/SQL Doc - Index</title>
</head>
<body>
</body>
</html>

47
Documentation/pldoc/frame_index.html Normal file
View File

@@ -0,0 +1,47 @@
<TABLE CLASS="SUB_TABLE"><TR>
<TD CLASS="SUB_TITLE" nowrap>&nbsp;Packages</TD></TR></TABLE>
<TABLE CLASS="SUB_TABLE">
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM" nowrap>
&nbsp;&nbsp;&nbsp;<A HREF="mip_regions.html" TITLE="">mip_regions</A>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM" nowrap>
&nbsp;&nbsp;&nbsp;<A HREF="mip_security.html" TITLE="Handle authentication and authorization processes for the MIP project">mip_security</A>
</TD></TR>
</TABLE>
<TABLE CLASS="SUB_TABLE"><TR>
<TD CLASS="SUB_TITLE" nowrap>&nbsp;Package bodies</TD></TR></TABLE>
<TABLE CLASS="SUB_TABLE">
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM" nowrap>
&nbsp;&nbsp;&nbsp;<A HREF="mip_regions.body.html" TITLE="">mip_regions</A>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM" nowrap>
&nbsp;&nbsp;&nbsp;<A HREF="mip_security.body.html" TITLE="">mip_security</A>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM" nowrap>
&nbsp;&nbsp;&nbsp;<A HREF="mip_table_constraints.body.html" TITLE="Used for a function-based unique index on enquiries.rt_code">mip_table_constraints</A>
</TD></TR>
</TABLE>
<TABLE CLASS="SUB_TABLE"><TR>
<TD CLASS="SUB_TITLE" nowrap>&nbsp;Views</TD></TR></TABLE>
<TABLE CLASS="SUB_TABLE">
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM" nowrap>
&nbsp;&nbsp;&nbsp;<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html" TITLE="">V_LATEST_RT_CODE_FOR_ENRO</A>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM" nowrap>
&nbsp;&nbsp;&nbsp;<A HREF="V_PARTY_RELATIONSHIPS.html" TITLE="">V_PARTY_RELATIONSHIPS</A>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM" nowrap>
&nbsp;&nbsp;&nbsp;<A HREF="V_PROFILE_RT_CODE_FOR_ENRO.html" TITLE="">V_PROFILE_RT_CODE_FOR_ENRO</A>
</TD></TR>
</TABLE>

73
Documentation/pldoc/index.html Normal file
View File

@@ -0,0 +1,73 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
<title>PL/SQL Doc - Index</title>
</head>
<body>
<!--You can create your own header here-->
<!--plsqldoc_start-->
<HR>
<A NAME="PACKAGES"></A>
<TABLE CLASS="SUB_TABLE"><TR>
<TD CLASS="SUB_TITLE">Packages</TD></TR></TABLE>
<TABLE CLASS="SUB_TABLE">
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="mip_regions.html">mip_regions</A>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%></TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="mip_security.html">mip_security</A>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>Handle authentication and authorization processes for the MIP project</TD></TR>
</TABLE>
<HR>
<A NAME="PACKAGE_BODIES"></A>
<TABLE CLASS="SUB_TABLE"><TR>
<TD CLASS="SUB_TITLE">Package bodies</TD></TR></TABLE>
<TABLE CLASS="SUB_TABLE">
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="mip_regions.body.html">mip_regions</A>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%></TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="mip_security.body.html">mip_security</A>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%></TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="mip_table_constraints.body.html">mip_table_constraints</A>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>Used for a function-based unique index on enquiries.rt_code</TD></TR>
</TABLE>
<HR>
<A NAME="VIEWS"></A>
<TABLE CLASS="SUB_TABLE"><TR>
<TD CLASS="SUB_TITLE">Views</TD></TR></TABLE>
<TABLE CLASS="SUB_TABLE">
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="V_LATEST_RT_CODE_FOR_ENRO.html">V_LATEST_RT_CODE_FOR_ENRO</A>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%></TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="V_PARTY_RELATIONSHIPS.html">V_PARTY_RELATIONSHIPS</A>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%></TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="V_PROFILE_RT_CODE_FOR_ENRO.html">V_PROFILE_RT_CODE_FOR_ENRO</A>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%></TD></TR>
</TABLE>
<!--plsqldoc_end-->
<p>&nbsp;</p>
<p>&nbsp;</p>
</table>
</body>
</html>

214
Documentation/pldoc/mip_regions.body.html Normal file
View File

@@ -0,0 +1,214 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
<TITLE>Package body mip_regions</TITLE>
<META name="object" content="PACKAGE BODY">
<META name="name" content="mip_regions">
<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 body mip_regions</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="#reformat_postcode_string">reformat_postcode_string</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Attempts to determine whether general the format the given string to match a standard postcode format
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#valid_postcode_format">valid_postcode_format</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Attempts to validate that the format of the given string matches a standard postcode format
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#get_region_for_postcode">get_region_for_postcode</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Find the region with which the given postcode is associated
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="reformat_postcode_string"></A>
<P CLASS="TYPE_TITLE">
reformat_postcode_string
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION reformat_postcode_string(p_string IN VARCHAR2) RETURN VARCHAR2
</PRE>
<P CLASS="DESC_TEXT">
Attempts to determine whether general the format the given string to match a standard postcode format<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_string&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the string whose format is 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%>
a known postcode format or NULL if the string did not match a known postcode format<br>
<TABLE CLASS="LIST_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
ANbNAA&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
e.g. M1 1AA<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
ANNbNAA&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
e.g. M60 1NW<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
AANbNAA&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
e.g. CR2 6XH<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
AANNbNAA&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
e.g. DN55 1PT<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
ANAbNAA&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
e.g. W1A 1HP<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
AANAbNAA&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
e.g. EC1A 1BB<br>
</TD></TR>
</TABLE>
<BR>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="valid_postcode_format"></A>
<P CLASS="TYPE_TITLE">
valid_postcode_format
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION valid_postcode_format(p_postcode IN VARCHAR2) RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Attempts to validate that the format of the given string matches a standard postcode format<br>
&nbsp;<br>
This includes the general format of the string, plus any restrictions on character values within the overall format.<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_string&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the string whose format is 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 given string matches a known postcode format<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="get_region_for_postcode"></A>
<P CLASS="TYPE_TITLE">
get_region_for_postcode
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION get_region_for_postcode(p_postcode IN VARCHAR2)
RETURN postcodes.regi_code%TYPE
</PRE>
<P CLASS="DESC_TEXT">
Find the region with which the given postcode is associated<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_postcode&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
correctly formatted postcode<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%>
region code<br>
</TD></TR>
</TABLE>
<BR>
<P>&nbsp;</P>
<P>&nbsp;</P>
</BODY>
</HTML>

78
Documentation/pldoc/mip_regions.html Normal file
View File

@@ -0,0 +1,78 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
<TITLE>Package mip_regions</TITLE>
<META name="object" content="PACKAGE">
<META name="name" content="mip_regions">
<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_regions</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="#valid_postcode_format">valid_postcode_format</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Attempts to validate that the format of the given string matches a standard postcode format
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="valid_postcode_format"></A>
<P CLASS="TYPE_TITLE">
valid_postcode_format
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION valid_postcode_format(p_postcode IN VARCHAR2) RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Attempts to validate that the format of the given string matches a standard postcode format<br>
&nbsp;<br>
This includes the general format of the string, plus any restrictions on character values within the overall format.<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_string&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the string whose format is 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 given string matches a known postcode format<br>
</TD></TR>
</TABLE>
<BR>
<P>&nbsp;</P>
<P>&nbsp;</P>
</BODY>
</HTML>

539
Documentation/pldoc/mip_security.body.html Normal file
View File

@@ -0,0 +1,539 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
<TITLE>Package body mip_security</TITLE>
<META name="object" content="PACKAGE BODY">
<META name="name" content="mip_security">
<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 body mip_security</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="#get_user_status">get_user_status</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#login">login</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Logs the user into the system and registers with APEX.
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#get_hash">get_hash</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Produce a 'password hash' from the given username and password
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#authenticate_user">authenticate_user</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Authenticates the given username and password
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#valid_user2">valid_user2</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Authenticates the given p_username and p_password
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#valid_user">valid_user</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Authenticates the given username and password
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#authorization">authorization</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Checks for authorization to access the given component
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#page_authorization">page_authorization</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Checks for <A HREF=#authorization>authorization</A> to access the given page
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#component_authorization">component_authorization</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Checks for <A HREF=#authorization>authorization</A> to access the given component
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#region_authorization">region_authorization</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Checks for <A HREF=#authorization>authorization</A> to access the given page
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#user_screen">user_screen</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#admin_screen">admin_screen</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#new_password">new_password</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#redirect_on_expired_account">redirect_on_expired_account</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="get_user_status"></A>
<P CLASS="TYPE_TITLE">
get_user_status
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION get_user_status(p_username IN VARCHAR2) RETURN VARCHAR2
</PRE>
<HR>
<A NAME="login"></A>
<P CLASS="TYPE_TITLE">
login
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE login(p_uname IN VARCHAR2
,p_password IN VARCHAR2
,p_session_id IN VARCHAR2
,p_flow_page IN VARCHAR2)
</PRE>
<P CLASS="DESC_TEXT">
Logs the user into the system and registers with APEX.<br>
&nbsp;<br>
if the user account is 'OPEN', log them in and flow to the requested page if the user account is 'EXPIRED', log them in and flow to the 'Change Password'&nbsp; page if the user account is 'LOCKED', log the user out and flow to the 'Locked' page<br>
<BR>
</P>
<HR>
<A NAME="get_hash"></A>
<P CLASS="TYPE_TITLE">
get_hash
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION get_hash(p_username IN VARCHAR2
,p_password IN VARCHAR2) RETURN VARCHAR2
</PRE>
<P CLASS="DESC_TEXT">
Produce a 'password hash' from the given username and password<br>
&nbsp;<br>
Uses the dbms_obfuscation_toolkit to produce the hash.<br>
<BR>
</P>
<HR>
<A NAME="authenticate_user"></A>
<P CLASS="TYPE_TITLE">
authenticate_user
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION authenticate_user(p_username IN VARCHAR2
,p_password IN VARCHAR2) RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Authenticates the given username and password<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%>
TRUE for authenticated username and password combination<br>
</TD></TR>
</TABLE>
<BR>
<A NAME="Replaces"></A>
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
Replaces
</TD></TR></TABLE>
<TABLE CLASS="LIST_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
<A HREF=#valid_user>valid_user</A>, <A HREF=#valid_user2>valid_user2</A>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="valid_user2"></A>
<P CLASS="TYPE_TITLE">
valid_user2
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE valid_user2(p_username IN VARCHAR2
,p_password IN VARCHAR2)
</PRE>
<P CLASS="DESC_TEXT">
Authenticates the given p_username and p_password<br>
&nbsp;<br>
Checks the <A HREF="passwords.html">passwords</A> table for a hash value matching that produced from the given p_username and p_password.<br>
<BR>
</P>
<A NAME="Raises"></A>
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
Raises
</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%>
-20000&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
when unable to authenticate<br>
</TD></TR>
</TABLE>
<BR>
<A NAME="Obsolete"></A>
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
Obsolete
</TD></TR></TABLE>
<TABLE CLASS="LIST_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Replaced by <A HREF=#authenticate_user>authenticate_user</A>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="valid_user"></A>
<P CLASS="TYPE_TITLE">
valid_user
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION valid_user(p_username IN VARCHAR2
,p_password IN VARCHAR2) RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Authenticates the given username and password<br>
<BR>
</P>
<A NAME="Obsolete"></A>
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
Obsolete
</TD></TR></TABLE>
<TABLE CLASS="LIST_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Replaced by <A HREF=#authenticate_user>authenticate_user</A>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="authorization"></A>
<P CLASS="TYPE_TITLE">
authorization
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION authorization(p_app_user IN VARCHAR2
,p_component_name IN apex_authorization.component_name%TYPE
,p_component_type IN apex_authorization.component_type%TYPE
,p_privilege IN apex_authorization.privilege%TYPE DEFAULT 'A')
RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Checks for authorization to access the given component<br>
&nbsp;<br>
&nbsp;<br>
Checks the roles assigned to the given p_app_user to see whether they are authorized to access the given component.<br>
&nbsp;<br>
If configuration item APEX_AUTHORIZATION_DEFAULT_MODE = PUBLIC, all components are considered to be accessible to all unless specifically listed in the apex_authorization table. Otherwise, the requested access must be listed in the apex_authorization table.<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_app_user&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
username<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_component_name&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
name of the component to be accessed<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_component_type&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the type of component to be accessed<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_privilege&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the access privilege being sought<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 given p_app_user is authorized<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="page_authorization"></A>
<P CLASS="TYPE_TITLE">
page_authorization
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION page_authorization(p_app_user IN VARCHAR2
,p_page_id IN NUMBER
,p_privilege IN apex_authorization.privilege%TYPE DEFAULT 'A')
RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Checks for <A HREF=#authorization>authorization</A> to access the given page<br>
&nbsp;<br>
Calls the <A HREF=#authorization>authorization</A> function to perform the check<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_app_user&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
username<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_page_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
page number to be accessed<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_privilege&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the access privilege being sought<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 given p_app_user is authorized<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="component_authorization"></A>
<P CLASS="TYPE_TITLE">
component_authorization
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION component_authorization(p_app_user IN VARCHAR2
,p_component_name IN apex_authorization.component_name%TYPE
,p_privilege IN apex_authorization.privilege%TYPE DEFAULT 'A')
RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Checks for <A HREF=#authorization>authorization</A> to access the given component<br>
&nbsp;<br>
Calls the <A HREF=#authorization>authorization</A> function to perform the check<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_app_user&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
username<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_component_name&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
name of the component to be accessed<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_privilege&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the access privilege being sought<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 given p_app_user is authorized<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="region_authorization"></A>
<P CLASS="TYPE_TITLE">
region_authorization
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION region_authorization(p_app_user IN VARCHAR2
,p_component_name IN apex_authorization.component_name%TYPE
,p_privilege IN apex_authorization.privilege%TYPE DEFAULT 'A')
RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Checks for <A HREF=#authorization>authorization</A> to access the given page<br>
&nbsp;<br>
Calls the <A HREF=#authorization>authorization</A> function to perform the check<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_app_user&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
username<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_component_name&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
name of the region to be accessed<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_privilege&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the access privilege being sought<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 given p_app_user is authorized<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="user_screen"></A>
<P CLASS="TYPE_TITLE">
user_screen
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION user_screen(p_username IN VARCHAR2) RETURN BOOLEAN
</PRE>
<HR>
<A NAME="admin_screen"></A>
<P CLASS="TYPE_TITLE">
admin_screen
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION admin_screen(p_username IN VARCHAR2) RETURN BOOLEAN
</PRE>
<HR>
<A NAME="new_password"></A>
<P CLASS="TYPE_TITLE">
new_password
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE new_password(p_username IN VARCHAR2
,p_password IN VARCHAR2)
</PRE>
<HR>
<A NAME="redirect_on_expired_account"></A>
<P CLASS="TYPE_TITLE">
redirect_on_expired_account
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE redirect_on_expired_account(p_username IN VARCHAR2)
</PRE>
<P>&nbsp;</P>
<P>&nbsp;</P>
</BODY>
</HTML>

433
Documentation/pldoc/mip_security.html Normal file
View File

@@ -0,0 +1,433 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
<TITLE>Package mip_security</TITLE>
<META name="object" content="PACKAGE">
<META name="name" content="mip_security">
<META name="description" content="Handle authentication and authorization processes for the MIP project">
</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_security</P>
Handle authentication and authorization processes for the MIP project<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="#login">login</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Perform user authentication and login An authenticated login for an expired password will result in flow to the 'Change Password' page.
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#get_hash">get_hash</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#valid_user2">valid_user2</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
%obs private function
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#valid_user">valid_user</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
%obs replaced by <A HREF=#authenticate_user>authenticate_user</A>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#authenticate_user">authenticate_user</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Authenticates the given username and password
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#user_screen">user_screen</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#admin_screen">admin_screen</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#new_password">new_password</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#page_authorization">page_authorization</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Authorize access to the given page
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#component_authorization">component_authorization</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Authorize access to the given component
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="TYPE_ITEM">
<A HREF="#region_authorization">region_authorization</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
Authorize access to the given region
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="login"></A>
<P CLASS="TYPE_TITLE">
login
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE login(p_uname IN VARCHAR2
,p_password IN VARCHAR2
,p_session_id IN VARCHAR2
,p_flow_page IN VARCHAR2)
</PRE>
<P CLASS="DESC_TEXT">
Perform user authentication and login An authenticated login for an expired password will result in flow to the 'Change Password' page.<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_uname&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
username<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_password&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
password<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_session_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
APEX session number<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_flow_page&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the app:page to which flow should pass on successful authentication<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="get_hash"></A>
<P CLASS="TYPE_TITLE">
get_hash
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION get_hash(p_username IN VARCHAR2
,p_password IN VARCHAR2) RETURN VARCHAR2
</PRE>
<HR>
<A NAME="valid_user2"></A>
<P CLASS="TYPE_TITLE">
valid_user2
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE valid_user2(p_username IN VARCHAR2
,p_password IN VARCHAR2)
</PRE>
<A NAME="Obsolete"></A>
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
Obsolete
</TD></TR></TABLE>
<TABLE CLASS="LIST_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
private function<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="valid_user"></A>
<P CLASS="TYPE_TITLE">
valid_user
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION valid_user(p_username IN VARCHAR2
,p_password IN VARCHAR2) RETURN BOOLEAN
</PRE>
<A NAME="Obsolete"></A>
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
Obsolete
</TD></TR></TABLE>
<TABLE CLASS="LIST_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
replaced by <A HREF=#authenticate_user>authenticate_user</A>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="authenticate_user"></A>
<P CLASS="TYPE_TITLE">
authenticate_user
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION authenticate_user(p_username IN VARCHAR2
,p_password IN VARCHAR2) RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Authenticates the given username and password<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%>
TRUE for authenticated username and password combination<br>
</TD></TR>
</TABLE>
<BR>
<A NAME="Replaces"></A>
<TABLE CLASS="LIST_TABLE"><TR><TD CLASS="LIST_TITLE">
Replaces
</TD></TR></TABLE>
<TABLE CLASS="LIST_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
<A HREF=#valid_user>valid_user</A>, <A HREF=#valid_user2>valid_user2</A>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="user_screen"></A>
<P CLASS="TYPE_TITLE">
user_screen
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION user_screen(p_username IN VARCHAR2) RETURN BOOLEAN
</PRE>
<HR>
<A NAME="admin_screen"></A>
<P CLASS="TYPE_TITLE">
admin_screen
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION admin_screen(p_username IN VARCHAR2) RETURN BOOLEAN
</PRE>
<HR>
<A NAME="new_password"></A>
<P CLASS="TYPE_TITLE">
new_password
</P>
<PRE CLASS="DECL_TEXT">
PROCEDURE new_password(p_username IN VARCHAR2
,p_password IN VARCHAR2)
</PRE>
<HR>
<A NAME="page_authorization"></A>
<P CLASS="TYPE_TITLE">
page_authorization
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION page_authorization(p_app_user IN VARCHAR2
,p_page_id IN NUMBER
,p_privilege IN apex_authorization.privilege%TYPE DEFAULT 'A')
RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Authorize access to the given page<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_app_user&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The name of the application user<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_page_id&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The page to be accessed<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_privilege&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The access privilege requested<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%>
Boolean value, true for access allowed<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="component_authorization"></A>
<P CLASS="TYPE_TITLE">
component_authorization
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION component_authorization(p_app_user IN VARCHAR2
,p_component_name IN apex_authorization.component_name%TYPE
,p_privilege IN apex_authorization.privilege%TYPE DEFAULT 'A')
RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Authorize access to the given component<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_app_user&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The name of the application user<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_component_name&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The name of the component to be accessed<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_privilege&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The access privilege requested<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%>
Boolean value, true for access allowed<br>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="region_authorization"></A>
<P CLASS="TYPE_TITLE">
region_authorization
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION region_authorization(p_app_user IN VARCHAR2
,p_component_name IN apex_authorization.component_name%TYPE
,p_privilege IN apex_authorization.privilege%TYPE DEFAULT 'A')
RETURN BOOLEAN
</PRE>
<P CLASS="DESC_TEXT">
Authorize access to the given region<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_app_user&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The name of the application user<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_component_name&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The name of the region to be accessed<br>
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_privilege&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
The access privilege requested<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%>
Boolean value, true for access allowed<br>
</TD></TR>
</TABLE>
<BR>
<P>&nbsp;</P>
<P>&nbsp;</P>
</BODY>
</HTML>

90
Documentation/pldoc/mip_table_constraints.body.html Normal file
View File

@@ -0,0 +1,90 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="plsqldoc.css">
<TITLE>Package body mip_table_constraints</TITLE>
<META name="object" content="PACKAGE BODY">
<META name="name" content="mip_table_constraints">
<META name="description" content="Used for a function-based unique index on enquiries.rt_code">
</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 body mip_table_constraints</P>
Used for a function-based unique index on enquiries.rt_code<br>
<BR>
<A NAME="Parameters"></A>
<TABLE CLASS="MAIN_TABLE"><TR><TD CLASS="LIST_TITLE">
Parameters
</TD></TR></TABLE>
<TABLE CLASS="MAIN_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
p_rt_code&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
the rt_code from the table row
</TD></TR>
</TABLE>
<BR>
<A NAME="Returns"></A>
<TABLE CLASS="MAIN_TABLE"><TR><TD CLASS="LIST_TITLE">
Returns
</TD></TR></TABLE>
<TABLE CLASS="MAIN_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
<TABLE CLASS="MAIN_TABLE">
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
1&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
for rt_code = 'ENQ OWN'
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
2&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
for rt_code = 'ENQ SUPP'
</TD></TR>
<TR><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
</TD><TD VALIGN="TOP" CLASS="LIST_ITEM" WIDTH=1%>
NULL&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
for al other values of rt_code
</TD></TR>
</TABLE>
<BR>
</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="#enq_rt_code">enq_rt_code</A>&nbsp;&nbsp;
</TD><TD CLASS="DESC_TEXT" WIDTH=95%>
</TD></TR>
</TABLE>
<BR>
<HR>
<A NAME="enq_rt_code"></A>
<P CLASS="TYPE_TITLE">
enq_rt_code
</P>
<PRE CLASS="DECL_TEXT">
FUNCTION enq_rt_code(p_rt_code IN enquiry_roles.rt_code%TYPE) RETURN NUMBER
</PRE>
<P>&nbsp;</P>
<P>&nbsp;</P>
</BODY>
</HTML>

164
Documentation/pldoc/plsqldoc.css Normal file
View File

@@ -0,0 +1,164 @@
/* PL/SQL Developer, plsqldoc styles */
BODY
{
font-family: Verdana,Arial,Helvetica,sans-serif;
background-color : #ECECEC;
font-size: 12px;
font-weight: normal;
font-style: normal;
margin-left: 15px;
margin-top: 25px;
}
A {color: #333300; text-decoration: underline;}
A:active {color: #2020C0; text-decoration: underline;}
A:hover {color: #4040C0; text-decoration: underline;}
A:visited {color: #101060; text-decoration: underline;}
/* Style for Title of document (Package ...) */
.MAIN_TITLE
{
font-family: Verdana,Arial,Helvetica,sans-serif;
font-size : medium;
color: #992266;
font-weight: bold;
margin-bottom: 12px;
}
/* Style for smaller Titles (Program Units, Exceptions, ...) */
.SUB_TITLE
{
font-family: Verdana,Arial,Helvetica,sans-serif;
font-size: medium;
color: #992266;
font-weight: normal;
margin-bottom: 12px;
}
/* Type name in description */
.TYPE_TITLE
{
font-family: Verdana,Arial,Helvetica,sans-serif;
font-size: small;
color: #992266;
font-weight: bold;
margin-bottom: 0px;
}
/* Type name in list */
.TYPE_ITEM
{
font-family: Verdana,Arial,Helvetica,sans-serif;
font-size: x-small;
color: #101060;
font-weight: bold;
margin-bottom: 0px;
}
/* 'See Also' list title */
.LIST_TITLE
{
font-family: Verdana,Arial,Helvetica,sans-serif;
font-size: small;
color: #301080;
font-weight: bold;
font-style: normal;
margin-bottom: 0px;
}
/* 'See Also' list item description */
.LIST_ITEM
{
font-family: Verdana,Arial,Helvetica,sans-serif;
font-size: x-small;
color: #101060;
font-weight: bold;
margin-bottom: 0px;
}
/* Description */
.DESC_TEXT
{
font-family: Verdana,Arial,Helvetica,sans-serif;
font-size: x-small;
color: #101060;
font-weight: normal;
margin-bottom: 0px;
}
/* Formatted text */
.DECL_TEXT
{
font-family: Courier;
font-size: x-small;
color: #101080;
font-weight: normal;
margin-bottom : 0px;
}
/* Table that holds the Title of the document */
.MAIN_TABLE
{
font-family: Verdana,Arial,Tahoma,Helvetica,sans-serif;
font-size: x-small;
font-weight: normal;
font-style: normal;
background-color: #E0E0E0;
width: 100%;
}
/* Table that holds Program Units list */
.SUB_TABLE
{
font-family: Verdana,Arial,Tahoma,Helvetica,sans-serif;
font-size: x-small;
font-weight: normal;
font-style: normal;
background-color: #E8E8E8;
VALIGN: "TOP";
width: 100%;
}
/* Table that holds the See Also list */
.LIST_TABLE
{
font-family: Verdana,Arial,Tahoma,Helvetica,sans-serif;
font-size: x-small;
font-weight: normal;
font-style: normal;
background-color: #ECECEC;
width: 100%;
}
/* Table that holds the See Also list */
.SIMPLE_TABLE
{
font-family: Verdana,Arial,Tahoma,Helvetica,sans-serif;
font-size: x-small;
font-weight: normal;
font-style: normal;
}

21
Documentation/pldoc/plsqldoc.ini Normal file
View File

@@ -0,0 +1,21 @@
UseFrames=0
StrictComments=1
IncludeSynopsis=1
Format=1
TabSize=4
LinePrefixes=
CrossReferences=2
FileWithDB=0
FileWithOwner=0
PathWithDB=0
PathWithOwner=0
NameWithDB=0
NameWithOwner=0
AutoGenerate=2
ParamPrefix="%param"
ParamDataType=1
[CustomTags]
spec=Specification
rep=Replaces
obs=Obsolete