1 PACKAGE zpb_acval_pvt AS
2 /* $Header: ZPBACVLS.pls 120.0.12010.4 2006/08/03 11:54:24 appldev noship $ */
3
4 g_req_child_nodes CONSTANT number := 0;
5
6 QUERY_OBJECT_PATH CONSTANT varchar2(17) := 'QUERY_OBJECT_PATH';
7 QUERY_OBJECT_NAME CONSTANT varchar2(17) := 'QUERY_OBJECT_NAME';
8 MAX_LENGTH CONSTANT number := 32000;
9
10
11 -- this procedure returns 'Y' n the OUT parameter if the changes can
12 -- be applied to the current run of the BP. Otherwise it will return 'N' in the
13 -- OUT parameter
14 PROCEDURE validate_currentrun (
15 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type,
16 x_changeCurrentRun OUT NOCOPY VARCHAR2) ;
17
18
19
20 -- this procedure returns can return 4 different values in the output variable
21 -- 0: both queries are identical
22 -- 1: first query is a subset of second
23 -- 2: second query is a subset of first
24 -- 3: both queries are different
25 PROCEDURE compare_line_members(p_first_query IN varchar2,
26 p_second_query IN varchar2,
27 x_equal OUT NOCOPY integer);
28 -- this procedure initializes the solve objects from the
29 -- shared aw. These objects will be used by the validation routines that
30 -- will be called by FWK subsequent to this call
31 PROCEDURE initialize_solve_object(
32 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type);
33
34
35
36 -- this procedure detaches all attached aw. It is called by fwk code to detach
37 -- all the aw that were used by the validation api's
38 PROCEDURE detach_aw(p_data_aw IN varchar2);
39
40
41 -- This procedure validates that the line members in Solve are identical
42 -- to the line members in the data model
43 --
44 -- it returns 1 output variable
45 -- x_comparision: this variable is a boolean and can contain either
46 -- 'Y' or 'N'
47 PROCEDURE val_solve_eq_model(
48 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type,
49 x_comparision OUT NOCOPY VARCHAR2);
50
51
52
53 -- This procedure validates that all the loaded line members in
54 -- the Solve definition are part of a Load Data task
55 --
56 -- it returns 2 output variables
57 -- x_isvalid: this variable is a boolean and can contain either
58 -- 'Y' or 'N'
59 -- x_task_name: this variable will contain a list of all
60 -- line member of source type LOADED which does not
61 -- exist in a LOAD DATA task
62 PROCEDURE val_solve_eq_data_load(
63 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type,
64 x_isvalid OUT NOCOPY VARCHAR2,
65 x_dim_members OUT NOCOPY VARCHAR2);
66
67 -- This procedure validates that all the line members in a Load Data
68 -- task are defined as LOADED in the Solve definition
69 --
70 -- it returns 3 output variables
71 -- x_isvalid: this variable is a boolean and can contain either
72 -- 'Y' or 'N'
73 -- x_task_name: this variable will contain a list of all
74 -- LOAD DATA tasks that have a line member which does not
75 -- exist in the Solve definition with source type LOADED
76 -- x_dim_members: list of line members which exist in a LOAD DATA task
77 -- but do not exist in the Solve definition with source
78 -- type LOADED
79 PROCEDURE val_solve_gt_than_load(
80 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type,
81 x_isvalid OUT NOCOPY VARCHAR2,
82 x_task_name OUT NOCOPY VARCHAR2,
83 x_dim_members OUT NOCOPY VARCHAR2);
84
85
86
87
88 -- This procedure validates that every Generate Template task contains
89 -- at least one line member of source type INPUT
90 --
91 -- it returns 2 output variables
92 -- x_isvalid: this variable is a boolean and can contain either
93 -- 'Y' or 'N'
94 -- x_invalid_tasks_list: this variable will contain a list of all
95 -- generate template tasks that do not have
96 -- a line member of source type INPUT
97 PROCEDURE validate_generate_worksheet(
98 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type,
99 x_isvalid OUT NOCOPY VARCHAR2 ,
100 x_invalid_tasks_list OUT NOCOPY VARCHAR2);
101
102
103
104 -- this procedure validates the solve input levels
105 --
106 --
107 -- it returns 2 output variables
108 -- x_isvalid: this variable is a boolean and can contain either
109 -- 'Y' or 'N'
110 -- x_invalid_dim_list: this variable will contain a list
111 -- of invalid input dimensions if the x_isvalid
112 -- is equal to 'N' i.e validation failed
113 -- x_invalid_linemem_list: this variable will contain a list
114 -- of invalid line member ids if the x_isvalid
115 -- is equal to 'N' i.e validation failed
116 PROCEDURE validate_input_selections(
117 p_api_version IN NUMBER,
118 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
119 p_commit IN VARCHAR2 := FND_API.G_FALSE,
120 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
121 x_return_status OUT NOCOPY VARCHAR2 ,
122 x_msg_count OUT NOCOPY NUMBER,
123 x_msg_data OUT NOCOPY VARCHAR2,
124 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type,
125 p_inputDims IN VARCHAR2,
126 x_isvalid OUT NOCOPY VARCHAR2,
127 x_invalid_dim_list OUT NOCOPY VARCHAR2,
128 x_invalid_linemem_list OUT NOCOPY VARCHAR2);
129
130
131
132 -- this procedure validates the solve input and output levels .
133 -- it ensures that they are defined and share a hierarchy
134 -- it returns 2 output variables
135 -- x_isvalid: this variable is a boolean and can contain either
136 -- 'Y' or 'N'
137 -- x_invalid_linemem_list: this variable will contain a list
138 -- of invalid line member ids if the x_isvalid
139 -- is equal to 'N' i.e validation failed
140 PROCEDURE validate_solve_levels(
141 p_api_version IN NUMBER,
142 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
143 p_commit IN VARCHAR2 := FND_API.G_FALSE,
144 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
145 x_return_status OUT NOCOPY VARCHAR2 ,
146 x_msg_count OUT NOCOPY NUMBER,
147 x_msg_data OUT NOCOPY VARCHAR2,
148 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type,
149 p_outputDims IN VARCHAR2,
150 x_isvalid OUT NOCOPY VARCHAR2,
151 x_invalid_linemem_list OUT NOCOPY VARCHAR2);
152
153
154 -- this procedure validates the template lines are a subset of the
155 -- model lines
156 --
157 --
158 -- it returns 2 output variables
159 -- x_isvalid: this variable is a boolean and can contain either
160 -- 'Y' or 'N'
161 -- x_invalid_task_list: this variable will contain a list
162 -- of generate tasks which are invalid i.e.
163 -- contain lines that are not in the model
164 PROCEDURE val_template_le_model(
165 p_api_version IN NUMBER,
166 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
167 p_commit IN VARCHAR2 := FND_API.G_FALSE,
168 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
169 x_return_status OUT NOCOPY VARCHAR2 ,
170 x_msg_count OUT NOCOPY NUMBER,
171 x_msg_data OUT NOCOPY VARCHAR2,
172 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type,
173 x_isvalid OUT NOCOPY VARCHAR2,
174 x_invalid_tasks_list OUT NOCOPY VARCHAR2);
175
176 -- this procedure returns two possible output values
177 -- 'Y': The union of Line Members of ALL Generate Template Tasks is equal to the
178 -- NON_INITIALIZED inputted line members of Solve
179 -- 'N': The union of Line Members of ALL Generate Template Tasks is different from the
180 -- NON_INITIALIZED inputted line members of Solve
181 procedure val_solveinp_eq_gentemp(
182 p_api_version IN NUMBER,
183 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
184 p_commit IN VARCHAR2 := FND_API.G_FALSE,
185 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
186 x_return_status OUT NOCOPY VARCHAR2 ,
187 x_msg_count OUT NOCOPY NUMBER,
188 x_msg_data OUT NOCOPY VARCHAR2,
189 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type,
190 x_isvalid OUT NOCOPY VARCHAR2,
191 x_dim_members OUT NOCOPY VARCHAR2);
192
193
194
195 -- this procedure validates the solve input and output levels .
196 -- it ensures that they share a hierarchy and the input level
197 -- is not lower than the output level
198 -- it returns 2 output variables
199 -- x_isvalid: this variable is a boolean and can contain either
200 -- 'Y' or 'N'
201 -- x_invalid_linemem_list: this variable will contain a list
202 -- of invalid line member ids if the x_isvalid
203 -- is equal to 'N' i.e validation failed
204 PROCEDURE val_solve_input_higher_levels(
205 p_api_version IN NUMBER,
206 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
207 p_commit IN VARCHAR2 := FND_API.G_FALSE,
208 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
209 x_return_status OUT NOCOPY VARCHAR2 ,
210 x_msg_count OUT NOCOPY NUMBER,
211 x_msg_data OUT NOCOPY VARCHAR2,
212 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type,
213 x_isvalid OUT NOCOPY VARCHAR2,
214 x_invalid_linemem_list OUT NOCOPY VARCHAR2);
215
216 -- this procedure validates the solve output levels
217 --
218 --
219 -- it returns 2 output variables
220 -- x_isvalid: this variable is a boolean and can contain either
221 -- 'Y' or 'N'
222 -- x_invalid_dim_list: this variable will contain a list
223 -- of invalid input dimensions if the x_isvalid
224 -- is equal to 'N' i.e validation failed
225 -- x_invalid_linemem_list: this variable will contain a list
226 -- of invalid line member ids if the x_isvalid
227 -- is equal to 'N' i.e validation failed
228 PROCEDURE validate_output_selections(
229 p_api_version IN NUMBER,
230 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
231 p_commit IN VARCHAR2 := FND_API.G_FALSE,
232 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
233 x_return_status OUT NOCOPY VARCHAR2 ,
234 x_msg_count OUT NOCOPY NUMBER,
235 x_msg_data OUT NOCOPY VARCHAR2,
236 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type,
237 p_outputDims IN VARCHAR2,
238 x_isvalid OUT NOCOPY VARCHAR2,
239 x_invalid_dim_list OUT NOCOPY VARCHAR2,
240 x_invalid_linemem_list OUT NOCOPY VARCHAR2);
241
242 -- this procedure validates that the solve input and output selections .
243 -- share a hierarchy with the horizon start and end levels
244 -- it returns 1 output variable
245 -- x_isvalid: this variable is a boolean and can contain either
246 -- 'Y' or 'N'
247 PROCEDURE val_solve_hrzselections(
248 p_api_version IN NUMBER,
249 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
250 p_commit IN VARCHAR2 := FND_API.G_FALSE,
251 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
252 x_return_status OUT NOCOPY VARCHAR2 ,
253 x_msg_count OUT NOCOPY NUMBER,
254 x_msg_data OUT NOCOPY VARCHAR2,
255 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type,
256 p_hrz_level IN VARCHAR2,
257 x_isvalid OUT NOCOPY VARCHAR2);
258
259 -- To delete view for an active instance
260 -- and clean up its worksheets
261
262 PROCEDURE delete_view(
263 p_analysis_cycle_id IN zpb_analysis_cycles.analysis_cycle_id%type);
264
265 PROCEDURE has_validation_errors(
266 itemtype IN varchar2,
267 itemkey IN varchar2,
268 actid IN number,
269 funcmode IN varchar2,
270 resultout OUT nocopy varchar2);
271
272 END zpb_acval_pvt;