DBA Data[Home] [Help]

PACKAGE: APPS.HR_INTEGRATION_UTILS

Source


1 PACKAGE hr_integration_utils AUTHID CURRENT_USER AS
2 /* $Header: hrintutl.pkh 115.7 2004/09/01 04:07:24 mroberts noship $ */
3 --
4 -- -------------------------------------------------------------------------
5 -- |----------------------< fetch_other_params >---------------------------|
6 -- -------------------------------------------------------------------------
7 --
8 -- Description:
9 --
10 --   For a particular form, determines the parameter list in the BNE schema
11 --   for that form, and then the integrators associated with that
12 --   parameter list.  These are returned as parameters for the call to
13 --   Web ADI.
14 --
15 -- -------------------------------------------------------------------------
16 FUNCTION fetch_other_params(p_form_name IN varchar2) RETURN varchar2;
17 --
18 FUNCTION fetch_other_letter_params(p_letter IN varchar2) RETURN varchar2;
19 --
20 --
21 -- -------------------------------------------------------------------------
22 -- |--------------------------< store_sql >--------------------------------|
23 -- -------------------------------------------------------------------------
24 --
25 -- Description:
26 --
27 --  Takes some SQL and stores it in the BNE schema, using BNE api.  Uses
28 --  dynamic SQL to remove the dependency on BNE schema.
29 --
30 -- -------------------------------------------------------------------------
31 FUNCTION store_sql(p_sql IN varchar2, p_date in varchar2) RETURN varchar2;
32 --
33 -- -------------------------------------------------------------------------
34 -- |----------------------< add_or_update_session >------------------------|
35 -- -------------------------------------------------------------------------
36 --
37 -- Description:
38 --
39 --  Takes a date, and adds a row to fnd_sessions table for the current
40 --  session, or updates the date in the table, if a row already exists.
41 --  This enables Web ADI queries to be performed against date effective
42 --  views.
43 --
44 -- -------------------------------------------------------------------------
45 PROCEDURE add_or_update_session(p_sess_date in date);
46 --
47 -- -------------------------------------------------------------------------
48 -- |------------------< add_hr_param_list_to_content >---------------------|
49 -- -------------------------------------------------------------------------
50 --
51 -- Description:
52 --
53 --  For the given content, update the content with this parameter list.
54 --  Required for all Contents to be used from Forms.
55 --
56 -- -------------------------------------------------------------------------
57 PROCEDURE add_hr_param_list_to_content(p_application_id in number
58                                       ,p_content_code   in varchar2);
59 --
60 -- -------------------------------------------------------------------------
61 -- |-------------------< add_hr_upload_list_to_integ >---------------------|
62 -- -------------------------------------------------------------------------
63 --
64 -- Description:
65 --
66 -- For the given integrator, update the metadata with this parameter list.
67 --
68 -- -------------------------------------------------------------------------
69 PROCEDURE add_hr_upload_list_to_integ(p_application_id in number
70                                      ,p_integrator_code   in varchar2);
71 --
72 -- ------------------------------------------------------------------------
73 -- | -----------------< register_integrator_to_form >---------------------|
74 -- ------------------------------------------------------------------------
75 --
76 -- Description:
77 --
78 --  Takes an integrator id, and a form name, and registers the integrator
79 --  for use on that form.
80 --  The param list for the form MUST exist.
81 --
82 -- ------------------------------------------------------------------------
83 PROCEDURE register_integrator_to_form(p_integrator    in varchar2
84                                      ,p_form_name     in varchar2);
85 --
86 -- ------------------------------------------------------------------------
87 -- | ---------------------< process_where_clause >------------------------|
88 -- ------------------------------------------------------------------------
89 --
90 -- Description:
91 --
92 --  Takes the FROM and WHERE clause, replaces FROM clause with an ALIAS
93 --  and alters references to base table to the alias.
94 --
95 -- ------------------------------------------------------------------------
96 FUNCTION process_where_clause(p_where_clause IN varchar2) RETURN varchar2;
97 --
98 -- ------------------------------------------------------------------------
99 -- |------------------------<add_sql_to_content >-------------------------|
100 -- ------------------------------------------------------------------------
101 --
102 -- Description:
103 --
104 --   Takes a SQL statement, and some parameters for that SQL statement,
105 --   and stores it in the BNE schema, then creates a parameter list for
106 --   parameters, and definitions if necessary.  This is then assigned to
107 --   the content also.
108 --
109 -- ------------------------------------------------------------------------
110 PROCEDURE add_sql_to_content
111   (p_application_id    in number
112   ,p_intg_user_name    in varchar2
113   ,p_sql               in varchar2
114   ,p_param1_name       in varchar2 default NULL
115   ,p_param1_type       in varchar2 default NULL
116   ,p_param1_prompt     in varchar2 default NULL
117   ,p_param2_name       in varchar2 default NULL
118   ,p_param2_type       in varchar2 default NULL
119   ,p_param2_prompt     in varchar2 default NULL
120   ,p_param3_name       in varchar2 default NULL
121   ,p_param3_type       in varchar2 default NULL
122   ,p_param3_prompt     in varchar2 default NULL
123   ,p_param4_name       in varchar2 default NULL
124   ,p_param4_type       in varchar2 default NULL
125   ,p_param4_prompt     in varchar2 default NULL
126   ,p_param5_name       in varchar2 default NULL
127   ,p_param5_type       in varchar2 default NULL
128   ,p_param5_prompt     in varchar2 default NULL
129   );
130 --
131 -- ------------------------------------------------------------------------
132 -- |----------------------< hr_disable_integrator >-----------------------|
133 -- ------------------------------------------------------------------------
134 --
135 -- Description:
136 --
137 --  Allows a customer to disable any customer defined integrator, by
138 --  setting its enabled flag, and altering the user integrator name.
139 --  The integrator will also be removed from any parameter lists.
140 --
141 -- -----------------------------------------------------------------------
142 PROCEDURE hr_disable_integrator
143   (p_application_short_name  in varchar2
144   ,p_integrator_user_name    in varchar2
145   ,p_disable                 in varchar2);
146 --
147 -- ----------------------------------------------------------------------------
148 -- |-------------------< hr_create_resp_association >-------------------------|
149 -- ----------------------------------------------------------------------------
150 --
151 -- Description:
152 --   Called to populate an entry in the HR_ADI_INTG_RESP table, which is
153 --   a table holding associations between integrators and responsibilities.
154 --
155 -- ----------------------------------------------------------------------------
156 PROCEDURE hr_create_resp_association
157   (p_intg_application     IN varchar2
158   ,p_integrator_user_name IN varchar2
159   ,p_resp_application     IN varchar2
160   ,p_responsibility_name  IN varchar2);
161 --
162 -- ----------------------------------------------------------------------------
163 -- |--------------------< hr_upd_or_del_resp_association >--------------------|
164 -- ----------------------------------------------------------------------------
165 --
166 -- Description:
167 --   Called to update or delete an entry in the HR_ADI_INTG_RESP table.  If
168 --   the resp associated with an integrator is updated to NULL, then it is
169 --   removed from the table.  Otherwise, the resp_application_id and resp_name
170 --   fields are updated.
171 --
172 -- ----------------------------------------------------------------------------
173 PROCEDURE hr_upd_or_del_resp_association
174   (p_resp_association_id IN number
175   ,p_resp_application    IN varchar2 default null
176   ,p_responsibility_name IN varchar2 default null
177   );
178 --
179 --
180 -- +--------------------------------------------------------------------------+
181 -- |--------------------< hr_maint_form_func_association >--------------------|
182 -- +--------------------------------------------------------------------------+
183 --
184 -- Description:
185 --   Called to create, update or delete entries in the BNE schema delivered
186 --   to allow form functions to be associated with integrators.
187 --
188 -- +--------------------------------------------------------------------------+
189 PROCEDURE hr_maint_form_func_association
190   (p_intg_application     IN varchar2
191   ,p_integrator_user_name IN varchar2
192   ,p_security_value       IN varchar2
193   );
194 --
195 FUNCTION fetchname
196   (p_number IN number
197   ,p_application_id IN number
198   ,p_param_list_code IN varchar2) RETURN varchar2;
199 --
200 FUNCTION fetchtype
201   (p_number IN number
202   ,p_application_id IN number
203   ,p_param_list_code IN varchar2) RETURN varchar2;
204 --
205 FUNCTION fetchprompt
206   (p_number IN number
207   ,p_application_id IN number
208   ,p_param_list_code IN varchar2) RETURN varchar2;
209 --
210 END hr_integration_utils;