set define '^'
set verify off
prompt ...wwv_flow_templates_util


Rem    SCRIPT ARGUMENTS
Rem
Rem    MODIFIED   (MM/DD/YYYY)
Rem     mhichwa    08/18/1999 - Created
Rem     mhichwa    11/08/1999 - Added fetch_tab_info
Rem     mhichwa    11/29/1999 - Added copy_template procedure
Rem     mhichwa    11/30/1999 - Added template_success_procedure assignment
Rem     mhichwa    12/02/1999 - Moved g_template from body to spec
Rem     mhichwa    12/12/1999 - Added set_user_template_preference, get_user_template_preference
Rem     mhichwa    12/28/2000 - Added p_copy_from_flow_id to copy_template
Rem     mhichwa    02/01/2000 - Added copy plug template
Rem     mhichwa    02/06/2000 - Added copy row template
Rem     mhichwa    12/03/2000 - Added copy list template
Rem     mhichwa    12/17/2000 - Added get_template_id to break dependancy on template_name
Rem     mhichwa    12/17/2000 - Changed datatype of g_template from varchar2 to number
Rem     mhichwa    12/17/2000 - Changed fetch_tab_info to take a number in
Rem     mhichwa    12/17/2000 - Added procedure set_page_template_names_2_ids
Rem     mhichwa    01/21/2001 - Added get_template_name
Rem     mhichwa    03/11/2001 - Added grant to public
Rem     mhichwa    10/08/2001 - Added copy field template
Rem     cbcho      02/18/2002 - Added p_to_template_id on copy_plug
Rem     cbcho      02/22/2002 - Added p_to_template_id on all copy template procedures
Rem     cbcho      05/06/2002 - Added copy menu template
Rem     cbcho      06/06/2002 - Added replace procedures to replace templates
Rem     mhichwa    06/06/2002 - Added p_show_error arguments
Rem     cbcho      07/02/2002 - Added page_template_popup_preview
Rem     cbcho      07/18/2002 - Added copy and replace button template
Rem     krlice     05/25/2004 - Added Calendar
Rem     skutz      06/14/2004 - Added theme_id and theme_class_id to copy procedures
Rem     skutz      06/14/2004 - Added copy_popup_api
Rem     sspadafo   12/17/2005 - Removed procedures set_flow_template_names_2_ids, migrate_region_template_names, migrate_page_template_names (Bugs 4873426,4873405)
Rem     cbcho      04/06/2006 - Added procedure substitution_strings (large PL/SQL move from 4000:4655)
Rem     cbcho      04/06/2006 - Renamed substitution_strings to list_template_sub_str
Rem     cbcho      04/06/2006 - Added breadcrumb_template_sub_str (large PL/SQL move from 4000:289)
Rem     cbcho      04/07/2006 - Added label_template_sub_str (large PL/SQL move from 4000:85)
Rem     cbcho      04/07/2006 - Added button_template_sub_str (large PL/SQL move from 4000:204)
Rem     cbcho      04/07/2006 - Added page_template_utilization (large PL/SQL move from 4000:4029)


create or replace package wwv_flow_templates_util
as
--  Copyright (c) Oracle Corporation 1999 - 2002. All Rights Reserved.
--
--    DESCRIPTION
--      Flow template rendering engine
--
--    SECURITY
--      Publicly executable
--
--    RUNTIME DEPLOYMENT: YES
--
--    NOTES
--      This program shows an html page header and footer.
--      Templates can have the following pound sign "#" based substitutions:
--      1. #TITLE#           -- HTML body title
--      2. #NAVIGATION_BAR#  -- Location of navigation Bar
--      3. #FORM_OPEN#       -- Opens HTML form used by flows
--      4. #FORM_CLOSE#      -- Closes HTML form opened
--      5. #SUCCESS_MESSAGE# -- If set by flow engine display here
--      Templates can also reference any flow variable using &VARIABLE syntax
--      Tab templates use #TAB_TEXT#
--


-------------------
-- Global Variables
--
g_template  number := null;


------------------------------------
-- Template Procedures and Functions
--

function get_template_id (
    p_template_name    in varchar2)
    return number
    ;

function get_page_template_name (
    p_template_id      in varchar2 default null)
    return varchar2
    ;

procedure fetch_tab_info (
    p_template_id      in number)
    ;

function get_header (
    p_template_name    in varchar2,
    p_page_title       in varchar2 default null)
    return varchar2
    ;

function get_footer (
    p_template_name    in varchar2)
    return varchar2
    ;

procedure copy_template (
    p_copy_from_flow_id  in number,
    p_flow_id            in varchar2,
    p_from_template_id   in number,
    p_to_theme_id        in number default null,
    p_to_template_name   in varchar2 default null,
    p_to_template_id     in number default null,
    p_show_errors        in boolean default true );

procedure copy_plug (
    p_copy_from_flow_id  in number,
    p_flow_id            in varchar2,
    p_from_template_id   in number,
    p_to_theme_id        in number default null,
    p_to_template_name   in varchar2 default null,
    p_to_template_id     in number default null,
    p_show_errors        in boolean default true)
    ;

procedure copy_row_template (
    p_copy_from_flow_id  in number,
    p_to_flow_id         in varchar2,
    p_from_template_id   in number,
    p_to_theme_id        in number default null,
    p_to_template_name   in varchar2 default null,
    p_to_template_id     in number default null,
    p_show_errors        in boolean default true)
    ;

procedure copy_list_template (
    p_copy_from_flow_id  in number,
    p_to_flow_id         in number,
    p_from_template_id   in number,
    p_to_theme_id        in number default null,
    p_to_template_name   in varchar2 default null,
    p_to_template_id     in number default null,
    p_show_errors        in boolean default true)
    ;

procedure copy_field_template (
    p_copy_from_flow_id  in number,
    p_flow_id            in varchar2,
    p_from_template_id   in number,
    p_to_theme_id        in number default null,
    p_to_template_name   in varchar2 default null,
    p_to_template_id     in number default null,
    p_show_errors        in boolean default true)
    ;

procedure copy_menu_template (
    p_copy_from_flow_id  in number,
    p_flow_id            in varchar2,
    p_from_template_id   in number,
    p_to_theme_id        in number default null,
    p_to_template_name   in varchar2 default null,
    p_to_template_id     in number default null,
    p_show_errors        in boolean default true)
    ;

procedure copy_button_template (
    p_copy_from_flow_id  in number,
    p_flow_id            in varchar2,
    p_from_template_id   in number,
    p_to_theme_id        in number default null,
    p_to_template_name   in varchar2 default null,
    p_to_template_id     in number default null,
    p_show_errors        in boolean default true)
    ;

procedure copy_calendar_template (
    p_copy_from_flow_id  in number,
    p_flow_id            in varchar2,
    p_from_template_id   in number,
    p_to_theme_id        in number default null,
    p_to_template_name   in varchar2 default null,
    p_to_template_id     in number default null,
    p_show_errors        in boolean default true)
    ;

procedure copy_popup_template (
    p_copy_from_flow_id  in number,
    p_flow_id            in varchar2,
    p_from_template_id   in number,
    p_to_theme_id        in number default null,
    p_to_template_name   in varchar2 default null,
    p_to_template_id     in number default null,
    p_show_errors        in boolean default true)
    ;

procedure set_user_template_preference (
    p_flow_id               in number,
    p_user_id               in varchar2,
    p_template_name         in varchar2 default null,
    p_printer_template_name in varchar2 default null)
    ;

function get_user_template_preference (
    p_flow_id               in number,
    p_user_id               in varchar2,
    p_template_type         in varchar2 default 'STANDARD')
    return varchar2
    ;

--------------------------------------------------------------------
-- utility functions for backward compatability and upgrade services
--

procedure set_page_template_names_2_ids (
    p_flow_id               in number,
    p_page_id               in number)
    ;

procedure set_page_region_names_2_ids (
    p_flow_id               in number,
    p_page_id               in number)
    ;

procedure replace_template (
    p_from_flow_id       in number,
    p_to_flow_id         in varchar2,
    p_from_template_id   in number,
    p_to_template_id     in number)
    ;

procedure replace_region_template (
    p_from_flow_id       in number,
    p_to_flow_id         in varchar2,
    p_from_template_id   in number,
    p_to_template_id     in number)
    ;

procedure replace_report_template (
    p_from_flow_id       in number,
    p_to_flow_id         in varchar2,
    p_from_template_id   in number,
    p_to_template_id     in number)
    ;

procedure replace_list_template (
    p_from_flow_id       in number,
    p_to_flow_id         in number,
    p_from_template_id   in number,
    p_to_template_id     in number)
    ;

procedure replace_field_template (
    p_from_flow_id       in number,
    p_to_flow_id         in varchar2,
    p_from_template_id   in number,
    p_to_template_id     in number)
    ;

procedure replace_menu_template (
    p_from_flow_id       in number,
    p_to_flow_id         in varchar2,
    p_from_template_id   in number,
    p_to_template_id     in number)
    ;

procedure replace_popup_lov_template (
    p_from_flow_id       in number,
    p_to_flow_id         in varchar2,
    p_from_template_id   in number,
    p_to_template_id     in number)
    ;

procedure replace_button_template (
    p_from_flow_id       in number,
    p_to_flow_id         in varchar2,
    p_from_template_id   in number,
    p_to_template_id     in number)
    ;

procedure replace_calendar_template (
    p_from_flow_id       in number,
    p_to_flow_id         in varchar2,
    p_from_template_id   in number,
    p_to_template_id     in number)
    ;

procedure page_template_popup_preview (
    p_flow               in number,
    p_template           in varchar2 default null,
    p_template_id        in number default null,
    p_passback           in varchar2 default null)
    ;

procedure list_template_sub_str (
    p_list_template_id in number default null)
    ;

procedure breadcrumb_template_sub_str (
    p_template_id   in number default null)
    ;
    
procedure label_template_sub_str (
    p_template_id in number default null)
    ;
    
procedure button_template_sub_str (
    p_template_id in number default null)
    ;
    
procedure page_template_utilization (
    p_flow_id      in number default null,
    p_template_id  in number default null)
    ;    
end wwv_flow_templates_util;
/
show errors


grant execute on WWV_FLOW_TEMPLATES_UTIL to public
/