DBA Data[Home] [Help]

PACKAGE: APPS.AHL_VWP_PRICE_PVT

Source


1 PACKAGE AHL_VWP_PRICE_PVT AUTHID CURRENT_USER AS
2 /* $Header: AHLVVPRS.pls 115.0 2003/10/17 17:57:28 yazhou noship $ */
3 -----------------------------------------------------------
4 -- PACKAGE
5 --    AHL_VWP_PRICE_PVT
6 --
7 -- PURPOSE
8 --    This package specification is a Private API for managing
9 --    APIs that integrate with Advanced Pricing
10 --    in Complex Maintainance, Repair and Overhauling(CMRO).
11 --
12 --    It defines the following APIs
13 --
14 --      Get_Task_Estimated_Price            (see below for specification)
15 --      Get_Job_Estimated_Price             (see below for specification)
16 --      Get_Job_Actual_Price                (see below for specification)
17 --      Get_Items_without_Price             (see below for specification)
18 --      Get_Item_Price                      (see below for specification)
19 --      Check_Item_for_Rt_Mat_Req           (see below for specification)
20 --      Check_Item_for_Prod_Mat_Req         (see below for specification)
21 --      Check_Item_for_Rt_Res_Req           (see below for specification)
22 --      Check_Item_for_Prod_Res_Req         (see below for specification)
23 --      Check_Item_for_Resource_Trans       (see below for specification)
24 --      Check_Item_for_Materials_Trans      (see below for specification)
25 
26 --
27 -- NOTES
28 --
29 --
30 -- HISTORY
31 -- 27-Aug-2003    yazhou      Created.
32 --------------------------------------------------------------------
33 
34 --------------------------------------------------------------------
35 --  Procedure name    : Get_Task_Estimated_Price
36 --  Type              : Private
37 --  Purpose           : To return estimated price for a given task.
38 --  Parameters  :
39 --
40 --  Standard OUT Parameters :
41 --   x_return_status        OUT     VARCHAR2     Required
42 --
43 --  Get_Task_Estimated_Price IN Parameters:
44 --   p_visit_task_id         IN  NUMBER     Required,
45 --   p_route_id              IN  NUMBER     Required,
46 --   p_price_list_id         IN  NUMBER     Required,
47 --   p_currency_code         IN  VARCHAR2   Required,
48 --   p_customer_id           IN  NUMBER     Required,
49 --   p_effective_date        IN  DATE       Required,
50 --   p_organization_id       IN  NUMBER     Required,
51 --
52 --  Get_Task_Estimated_Price OUT Parameters:
53 --   x_estimated_price       OUT  NUMBER     Required,
54 --
55 --  Version :
56 --      Initial Version   1.0
57 --------------------------------------------------------------------
58 PROCEDURE Get_Task_Estimated_Price
59     (p_visit_task_id        IN NUMBER,
60      p_route_id             IN NUMBER,
61      p_price_list_id        IN NUMBER,
62      p_customer_id          IN NUMBER,
63      p_currency_code        IN VARCHAR2,
64      p_effective_date       IN DATE,
65      p_organization_id      IN NUMBER,
66 
67      x_estimated_price      OUT NOCOPY NUMBER,
68      x_return_status        OUT NOCOPY VARCHAR2
69      );
70 
71 --------------------------------------------------------------------
72 --  Procedure name    : Get_Job_Estimated_Price
73 --  Type              : Private
74 --  Purpose           : To return estimated price for the job of a given task.
75 --  Parameters  :
76 --
77 --  Standard OUT Parameters :
78 --   x_return_status        OUT     VARCHAR2     Required
79 --
80 --  Get_Task_Estimated_Price IN Parameters:
81 --   p_visit_task_id         IN  NUMBER     Required,
82 --   p_price_list_id         IN  NUMBER     Required,
83 --   p_currency_code         IN  VARCHAR2   Required,
84 --   p_customer_id           IN  NUMBER     Required,
85 --
86 --  Get_Task_Estimated_Price OUT Parameters:
87 --   x_estimated_price       OUT  NUMBER     Required,
88 --
89 --  Version :
90 --      Initial Version   1.0
91 --------------------------------------------------------------------
92 PROCEDURE Get_Job_Estimated_Price
93     (p_visit_task_id        IN NUMBER,
94      p_price_list_id        IN NUMBER,
95      p_customer_id          IN NUMBER,
96      p_currency_code        IN VARCHAR2,
97 
98      x_estimated_price      OUT NOCOPY NUMBER,
99      x_return_status        OUT NOCOPY VARCHAR2
100      );
101 
102 --------------------------------------------------------------------
103 --  Procedure name    : Get_Job_Actual_Price
104 --  Type              : Private
105 --  Purpose           : To return actual price for the job of a given task.
106 --  Parameters  :
107 --
108 --  Standard OUT Parameters :
109 --   x_return_status        OUT     VARCHAR2     Required
110 --
111 --  Get_Task_Actual_Price IN Parameters:
112 --   p_visit_task_id         IN  NUMBER     Required,
113 --   p_price_list_id         IN  NUMBER     Required,
114 --   p_currency_code         IN  VARCHAR2   Required,
115 --   p_customer_id           IN  NUMBER     Required,
116 --
117 --  Get_Task_Actual_Price OUT Parameters:
118 --   x_actual_price          OUT  NUMBER     Required,
119 --
120 --  Version :
121 --      Initial Version   1.0
122 --------------------------------------------------------------------
123 PROCEDURE Get_Job_Actual_Price
124     (p_visit_task_id        IN NUMBER,
125      p_price_list_id        IN NUMBER,
126      p_customer_id          IN NUMBER,
127      p_currency_code        IN VARCHAR2,
128 
129      x_actual_price         OUT NOCOPY NUMBER,
130      x_return_status        OUT NOCOPY VARCHAR2
131      );
132 
133 --------------------------------------------------------------------
134 --  Procedure name    : Get_Item_Price
135 --  Type              : Private
136 --  Purpose           : To return price for a given item.
137 --  Parameters  :
138 --
139 --  Standard OUT Parameters :
140 --   x_return_status        OUT     VARCHAR2     Required
141 --
142 --  Get_Item_Price IN Parameters:
143 --   p_item_id               IN  NUMBER     Required,
144 --   p_price_list_id         IN  NUMBER     Required,
145 --   p_currency_code         IN  VARCHAR2   Required,
146 --   p_customer_id           IN  NUMBER     Required,
147 --   p_duration              IN NUMBER      Optional,
148 --   p_effective_date       IN  DATE       Required,
149 --   p_UOM_code              IN VARCHAR2    Required,
150 --
151 --  Get_Item_Price OUT Parameters:
152 --   x_item_price            OUT  NUMBER     Required, if return value is null
153 --                                          then item is not set up in price list
154 --
155 --  Version :
156 --      Initial Version   1.0
157 --------------------------------------------------------------------
158 PROCEDURE Get_Item_Price
159     (p_item_id              IN NUMBER,
160      p_price_list_id        IN NUMBER,
161      p_customer_id          IN NUMBER,
162      p_duration             IN NUMBER := 1,
163      p_currency_code        IN VARCHAR2,
164      p_effective_date       IN DATE,
165      p_UOM_code             IN VARCHAR2,
166 
167      x_item_price           OUT NOCOPY NUMBER,
168      x_return_status        OUT NOCOPY VARCHAR2
169      );
170 
171 --------------------------------------------------------------------
172 --  Procedure name    : Get_Items_without_Price
173 --  Type              : Private
174 --  Purpose           : To return items which are not set up in price list.
175 --  Parameters  :
176 --
177 --  Standard OUT Parameters :
178 --   x_return_status        OUT     VARCHAR2     Required
179 --
180 --  Get_Items_without_Price IN Parameters:
181 --   p_item_tbl               IN  AHL_VWP_RULES_PVT.Item_Tbl_Type     Required,
182 --   p_price_list_id         IN  NUMBER     Required,
183 --   p_currency_code         IN  VARCHAR2   Required,
184 --   p_customer_id           IN  NUMBER     Required,
185 
186 --
187 --  Get_Task_Estimated_Price OUT Parameters:
188 --   x_item_tbl            OUT  AHL_VWP_RULES_PVT.Item_Tbl_Type     Required
189 --
190 --  Version :
191 --      Initial Version   1.0
192 --------------------------------------------------------------------
193 PROCEDURE Get_Items_without_Price
194     (p_item_tbl             IN AHL_VWP_RULES_PVT.Item_Tbl_Type,
195      p_price_list_id        IN NUMBER,
196      p_customer_id          IN NUMBER,
197      p_currency_code        IN VARCHAR2,
198 
199      x_item_tbl             OUT NOCOPY AHL_VWP_RULES_PVT.Item_Tbl_Type,
200      x_return_status        OUT NOCOPY VARCHAR2
201      );
202 
203 --------------------------------------------------------------------
204 --  Procedure name    : Check_Item_for_Prod_Mat_Req
205 --  Type              : Private
206 --  Purpose           : To return items required for Material requirements of a given task.
207 --                      when job is not in draft status
208 --  Parameters  :
209 --
210 --  Standard OUT Parameters :
211 --   x_return_status        OUT     VARCHAR2     Required
212 --
213 --  Check_Item_for_Prod_Mat_Req IN Parameters:
214 --   p_visit_task_id         IN  NUMBER     Required,
215 --   p_route_id              IN  NUMBER     Required,
216 
217 --
218 --  Check_Item_for_Prod_Mat_Req OUT Parameters:
219 --   x_item_tbl            OUT  AHL_VWP_RULES_PVT.Item_Tbl_Type     Required
220 --
221 --  Version :
222 --      Initial Version   1.0
223 --------------------------------------------------------------------
224 PROCEDURE Check_Item_for_Prod_Mat_Req
225     (p_visit_task_id        IN NUMBER,
226 
227      x_item_tbl             OUT NOCOPY AHL_VWP_RULES_PVT.Item_Tbl_Type,
228      x_return_status        OUT NOCOPY VARCHAR2
229      );
230 
231 --------------------------------------------------------------------
232 --  Procedure name    : Check_Item_for_Rt_Mat_Req
233 --  Type              : Private
234 --  Purpose           : To return items required for Material requirements of a given task.
235 --                      when job is in Draft status
236 --  Parameters  :
237 --
238 --  Standard OUT Parameters :
239 --   x_return_status        OUT     VARCHAR2     Required
240 --
241 --  Check_Item_for_Rt_Mat_Req IN Parameters:
242 --   p_visit_task_id         IN  NUMBER     Required,
243 --   p_route_id              IN  NUMBER     Required,
244 --   p_effective_date        IN  DATE     Required,
245 
246 --
247 --  Check_Item_for_Rt_Mat_Req OUT Parameters:
248 --   x_item_tbl            OUT  AHL_VWP_RULES_PVT.Item_Tbl_Type     Required
249 --
250 --  Version :
251 --      Initial Version   1.0
252 --------------------------------------------------------------------
253 PROCEDURE Check_Item_for_Rt_Mat_Req
254     (p_visit_task_id        IN NUMBER,
255      p_route_id             IN NUMBER,
256      p_effective_date       IN DATE,
257 
258      x_item_tbl             OUT NOCOPY AHL_VWP_RULES_PVT.Item_Tbl_Type,
259      x_return_status        OUT NOCOPY VARCHAR2
260      );
261 
262 --------------------------------------------------------------------
263 --  Procedure name    : Check_Item_for_Prod_Res_Req
264 --  Type              : Private
265 --  Purpose           : To return items required for Resource requirements of a given task.
266 --                      when job is not in draft status
267 --  Parameters  :
268 --
269 --  Standard OUT Parameters :
270 --   x_return_status        OUT     VARCHAR2     Required
271 --
272 --  Check_Item_for_Prod_Res_Req IN Parameters:
273 --   p_visit_task_id         IN  NUMBER     Required,
274 --   p_route_id              IN  NUMBER     Required,
275 
276 --
277 --  Check_Item_for_Prod_Res_Req OUT Parameters:
278 --   x_item_tbl            OUT  AHL_VWP_RULES_PVT.Item_Tbl_Type     Required
279 --
280 --  Version :
281 --      Initial Version   1.0
282 --------------------------------------------------------------------
283 PROCEDURE Check_Item_for_Prod_Res_Req
284     (p_visit_task_id        IN NUMBER,
285 
286      x_item_tbl             OUT NOCOPY AHL_VWP_RULES_PVT.Item_Tbl_Type,
287      x_return_status        OUT NOCOPY VARCHAR2
288      );
289 
290 --------------------------------------------------------------------
291 --  Procedure name    : Check_Item_for_Rt_Res_Req
292 --  Type              : Private
293 --  Purpose           : To return items required for Resource requirements of a given task.
294 --                      when job is in Draft status
295 --  Parameters  :
296 --
297 --  Standard OUT Parameters :
298 --   x_return_status        OUT     VARCHAR2     Required
299 --
300 --  Check_Item_for_Rt_Res_Req IN Parameters:
301 --   p_visit_task_id         IN  NUMBER     Required,
302 --   p_route_id              IN  NUMBER     Required,
303 --   p_organization_id       IN  NUMBER     Required,
304 --   p_effective_date        IN  DATE     Required,
305 
306 --
307 --  Check_Item_for_Rt_Res_Req OUT Parameters:
308 --   x_item_tbl            OUT  AHL_VWP_RULES_PVT.Item_Tbl_Type     Required
309 --
310 --  Version :
311 --      Initial Version   1.0
312 --------------------------------------------------------------------
313 PROCEDURE Check_Item_for_Rt_Res_Req
314     (p_visit_task_id        IN NUMBER,
315      p_route_id             IN NUMBER,
316      p_organization_id      IN NUMBER,
317      p_effective_date       IN DATE,
318 
319      x_item_tbl             OUT NOCOPY AHL_VWP_RULES_PVT.Item_Tbl_Type,
320      x_return_status        OUT NOCOPY VARCHAR2
321      );
322 
323 --------------------------------------------------------------------
324 --  Procedure name    : Check_Item_for_Resource_Trans
325 --  Type              : Private
326 --  Purpose           : To return items required for Resource transactions of a given task.
327 --  Parameters  :
328 --
329 --  Standard OUT Parameters :
330 --   x_return_status        OUT     VARCHAR2     Required
331 --
332 --  Check_Item_for_Resource_Trans IN Parameters:
333 --   p_visit_task_id         IN  NUMBER     Required,
334 --
335 --  Check_Item_for_Resource_Trans OUT Parameters:
336 --   x_item_tbl            OUT  AHL_VWP_RULES_PVT.Item_Tbl_Type     Required
337 --
338 --  Version :
339 --      Initial Version   1.0
340 --------------------------------------------------------------------
341 PROCEDURE Check_Item_for_Resource_Trans
342     (p_visit_task_id        IN NUMBER,
343 
344      x_item_tbl             OUT NOCOPY AHL_VWP_RULES_PVT.Item_Tbl_Type,
345      x_return_status        OUT NOCOPY VARCHAR2
346      );
347 
348 --------------------------------------------------------------------
349 --  Procedure name    : Check_Item_for_Material_Trans
350 --  Type              : Private
351 --  Purpose           : To return items required for Mateiral transactions of a given task.
352 --  Parameters  :
353 --
354 --  Standard OUT Parameters :
355 --   x_return_status        OUT     VARCHAR2     Required
356 --
357 --  Check_Item_for_Material_Trans IN Parameters:
358 --   p_visit_task_id         IN  NUMBER     Required,
359 --
360 --  Check_Item_for_Material_Trans OUT Parameters:
361 --   x_item_tbl            OUT  AHL_VWP_RULES_PVT.Item_Tbl_Type     Required
362 --
363 --  Version :
364 --      Initial Version   1.0
365 --------------------------------------------------------------------
366 PROCEDURE Check_Item_for_Materials_Trans
367     (p_visit_task_id        IN NUMBER,
368 
369      x_item_tbl             OUT NOCOPY AHL_VWP_RULES_PVT.Item_Tbl_Type,
370      x_return_status        OUT NOCOPY VARCHAR2
371      );
372 
373 END AHL_VWP_PRICE_PVT;
374