DBA Data[Home] [Help]

PACKAGE: APPS.JAI_PO_WF_UTIL_PUB

Source


1 PACKAGE JAI_PO_WF_UTIL_PUB AUTHID CURRENT_USER AS
2 /* $Header: jainpowfut.pls 120.3 2010/12/28 18:16:23 erma noship $ */
3 --+=======================================================================+
4 --|               Copyright (c) 1998 Oracle Corporation                   |
5 --|                       Redwood Shores, CA, USA                         |
6 --|                         All rights reserved.                          |
7 --+=======================================================================+
8 --| FILENAME                                                              |
9 --|     jainpowfut.pls                                                    |
10 --|                                                                       |
11 --| DESCRIPTION                                                           |
12 --|     This is the utility package for IL po notification.               |
13 --|                                                                       |
14 --|                                                                       |
15 --| PROCEDURE LIST                                                        |
16 --|      PROCEDURE Get_Req_Curr_Conv_Rate                                 |
17 --|      PROCEDURE Get_Currency_Convertion_Rate                           |
18 --|      PROCEDURE Get_Jai_Tax_Amount                                     |
19 --|      PROCEDURE Get_Jai_New_Tax_Amount                                 |
20 --|      PROCEDURE Populate_Session_GT                                    |
21 --|      FUNCTION  Get_Tax_Region                                         |
22 --|      FUNCTION  Get_Poreq_Tax                                          |
23 --|      FUNCTION  Get_Jai_Req_Tax_Disp                                   |
24 --|      FUNCTION  Get_Jai_Tax_Disp                                       |
25 --|      FUNCTION  Get_Jai_Open_Form_Command                              |
26 --|                                                                       |
27 --| HISTORY                                                               |
28 --|     2009/02/11 Eric Ma   Created                                      |
29 --|                                                                       |
30 --+======================================================================*/
31 
32   -- Public constant declarations
33   GV_MODULE_PREFIX             VARCHAR2 (100) := 'jai.plsql.JAI_PO_WF_UTIL_PUB';
34   G_PO_DOC_TYPE       CONSTANT VARCHAR2  (20) := 'PO';
35   G_REQ_DOC_TYPE      CONSTANT VARCHAR2  (20) := 'REQUISITION';
36   G_REL_DOC_TYPE      CONSTANT VARCHAR2  (20) := 'RELEASE';
37 
38   -- Public function and procedure declarations
39 
40   --==========================================================================
41   --    PROCEDURE   NAME:
42   --
43   --    Get_Req_Curr_Conv_Rate                     Public
44   --
45   --  DESCRIPTION:
46   --
47   --    This procedure is used to get the conversion rate for a Requsition line
48   --
49   --  PARAMETERS:
50   --      In: pn_req_header_id      IN   NUMBER               req header id
51   --          pn_req_line_id        IN   NUMBER               req line id
52   --          pv_tax_currency       IN   VARCHAR2             tax currency code
53   --          xn_conversion_rate    OUT  NUMBER               conversion  rate
54   --  DESIGN REFERENCES:
55   --
56   --
57   --  CHANGE HISTORY:
58   --
59   --           15-APR-2009   Eric Ma  created
60   --==========================================================================
61 
62   PROCEDURE Get_Req_Curr_Conv_Rate
63   ( pn_req_header_id     IN NUMBER
64   , pn_req_line_id       IN NUMBER
65   , pv_tax_currency      IN VARCHAR2
66   , xn_conversion_rate   OUT NOCOPY NUMBER
67   );
68 
69   --==========================================================================
70   --    PROCEDURE   NAME:
71   --
72   --    Get_Currency_Convertion_Rate                     Public
73   --
74   --  DESCRIPTION:
75   --
76   --    This procedure is used to get the conversion rate for PO/PA
77   --
78   --  PARAMETERS:
79   --      In: pn_document_id      IN   NUMBER               PO/PA header id
80   --          pv_tax_currency     IN   VARCHAR2             tax currency code
81   --          xn_conversion_rate  OUT  NUMBER               conversion  rate
82   --  DESIGN REFERENCES:
83   --
84   --
85   --  CHANGE HISTORY:
86   --
87   --           15-APR-2009   Eric Ma  created
88   --==========================================================================
89   PROCEDURE Get_Currency_Convertion_Rate
90   ( pn_document_id   IN NUMBER
91   , pv_tax_currency  IN VARCHAR2
92   , xn_conversion_rate OUT NOCOPY NUMBER
93   );
94 
95  --==========================================================================
96   --    PROCEDURE   NAME:
97   --
98   --    Get_Jai_Tax_Amount                     Public
99   --
100   --  DESCRIPTION:
101   --
102   --    This procedure is used to get the exclusive tax amount and non recoverable exclusive tax
103   --    amount for a PO,PR or a RELEASE
104   --
105   --  PARAMETERS:
106   --      In: pv_document_type         IN VARCHAR2,                       document type  : requisition,po,release
107   --          pn_document_id           IN NUMBER,                         document_id    : req header id,po header id
108   --          pn_release_num           IN NUMBER DEFAULT NULL,            release nmuber : for release,it receive release number
109   --          xn_excl_tax_amount      OUT NOCOPY NUMBER,                  exclusive tax amount for the document
110   --          xn_excl_nr_tax_amount   OUT NOCOPY NUMBER                   exclusive non recoverable tax amount for the document
111   --  DESIGN REFERENCES:
112   --
113   --
114   --  CHANGE HISTORY:
115   --
116   --           10-FEB-2009   Eric Ma  created
117   --==========================================================================
118   PROCEDURE Get_Jai_Tax_Amount
119   ( pv_document_type       IN VARCHAR2,
120     pn_document_id         IN NUMBER,
121     pn_requisition_line_id IN NUMBER DEFAULT NULL,
122     xn_excl_tax_amount     OUT NOCOPY NUMBER,
123     xn_excl_nr_tax_amount  OUT NOCOPY NUMBER
124   );
125 
126   --==========================================================================
127   --    PROCEDURE   NAME:
128   --
129   --    Get_Tax_Amount_Info                     Public
130   --
131   --  DESCRIPTION:
132   --
133   --    This procedure is used to get the exclusive tax amount and non recoverable exclusive tax
134   --    amount for a given tax id and tax amount
135   --
136   --  PARAMETERS:
137   --      In: pn_tax_id            IN   NUMBER               tax identifier
138   --          pn_tax_amount        IN   NUMBER               tax amount
139   --          pn_conver_rate       IN   NUMBER DEFAULT 1     converstion rate between different currency
140   --          pn_rounding_factor   IN   NUMBER DEFAULT NULL  rounding factor
141   --          x_excl_tax_amount    OUT  NUMBER               exclusive tax amount
142   --          x_excl_nr_tax_amount OUT  NUMBER               exclusive non recoverable tax amount
143   --          pn_trx_rec_flag      IN   VARCHAR2             The modvat flat in tax transaction level
144   --  DESIGN REFERENCES:
145   --
146   --
147   --  CHANGE HISTORY:
148   --
149   --           10-FEB-2009   Eric Ma  created
150   --==========================================================================
151   PROCEDURE  Get_Tax_Amount_Info
152   ( pn_tax_id             IN NUMBER
153   , pn_tax_amount         IN NUMBER
154   , pn_conver_rate        IN NUMBER DEFAULT 1
155   , pn_rounding_factor    IN NUMBER DEFAULT NULL
156   , xn_excl_tax_amount    OUT NOCOPY NUMBER
157   , xn_excl_nr_tax_amount OUT NOCOPY NUMBER
158   , pn_trx_rec_flag	      IN VARCHAR2 DEFAULT 'N'   -- add by Xiao Lv for MADVAT flag on 25-Mar-2009
159   , xv_tax_type           OUT NOCOPY VARCHAR2       -- add by Eric Ma for bug10426971 on 28-Dec-2010
160   );
161 
162   --==========================================================================
163   --    PROCEDURE   NAME:
164   --
165   --    Get_Tax_Region                     Public
166   --
167   --  DESCRIPTION:
168   --
169   --    This procedure is used to return the tax region code
170   --
171   --  PARAMETERS:
172   --      In: pv_document_type      IN   VARCHAR2     document type
173   --          pn_document_id        IN   NUMBER       document header id
174   --          pn_org_id             IN   NUMBER       organization id
175   --  DESIGN REFERENCES:
176   --
177   --
178   --  CHANGE HISTORY:
179   --
180   --           15-APR-2009   Eric Ma  created
181   --==========================================================================
182   FUNCTION Get_Tax_Region
183   ( pv_document_type      IN VARCHAR2  DEFAULT NULL
184   , pn_document_id        IN NUMBER    DEFAULT NULL
185   , pn_org_id             IN NUMBER    DEFAULT NULL
186   ) RETURN VARCHAR2;
187 
188 
189  --==========================================================================
190   --    FUNCTION   NAME:
191   --
192   --    Get_Poreq_Tax                     Public
193   --
194   --  DESCRIPTION:
195   --    get po requisition tax
196   --
197   --  PARAMETERS:
198   --      In: pv_document_type          IN   VARCHAR2        po type
199   --          pn_document_id            IN   NUMBER      req header id,po header id
200   --          pn_release_num            IN   NUMBER      release num
201   --          pn_line_id                IN   NUMBER        po line id
202   --          pn_line_location_id       IN   NUMBER        po line location id
203   --  DESIGN REFERENCES:
204   --
205   --
206   --  CHANGE HISTORY:
207   --
208   --           13-Apr-2009   Xiao Lv  created
209   --==========================================================================
210   FUNCTION Get_Poreq_Tax
211 	( pv_document_type       IN VARCHAR2
212   , pn_document_id         IN NUMBER
213   , pn_release_num         IN NUMBER DEFAULT NULL
214   , pn_line_id		         IN NUMBER DEFAULT NULL
215   , pn_line_location_id    IN NUMBER DEFAULT NULL
216 	) RETURN NUMBER;
217 
218 
219   --==========================================================================
220   --    PROCEDURE   NAME:
221   --
222   --    Get_Jai_New_Tax_Amount                     Public
223   --
224   --  DESCRIPTION:
225   --
226   --    This procedure is used to get the exclusive tax amount and non recoverable exclusive tax
227   --    amount for a PO,PR or a RELEASE
228   --
229   --  PARAMETERS:
230   --      In: pv_document_type         IN VARCHAR2,                       document type  : requisition,po,release
231   --          pn_document_id           IN NUMBER,                         document_id    : req header id,po header id
232   --          pn_release_num           IN NUMBER DEFAULT NULL,            release nmuber : for release,it receive release number
233   --          xn_excl_tax_amount      OUT NOCOPY NUMBER,                  exclusive tax amount for the document
234   --          xn_excl_nr_tax_amount   OUT NOCOPY NUMBER                   exclusive non recoverable tax amount for the document
235   --  DESIGN REFERENCES:
236   --
237   --
238   --  CHANGE HISTORY:
239   --
240   --           7-Apr-2009   Xiao Lv  created
241   --==========================================================================
242   PROCEDURE Get_Jai_New_Tax_Amount
243   ( pv_document_type       IN VARCHAR2,
244     pn_document_id         IN NUMBER,
245     pn_chg_request_group_id  IN NUMBER,
246     xn_excl_tax_amount     OUT NOCOPY NUMBER,
247     xn_excl_nr_tax_amount  OUT NOCOPY NUMBER
248   );
249 
250  --==========================================================================
251   --    FUNCTION   NAME:
252   --
253   --    Get_Jai_Req_Tax_Disp                     Public
254   --
255   --  DESCRIPTION:
256   --    Return the formatted non-recoverable tax for display
257   --
258   --  PARAMETERS:
259   --      In: pn_jai_excl_nr_tax      IN   NUMBER        non recoverable tax amount
260   --          pv_total_tax_dsp        IN   VARCHAR2      total tax amount for display
261   --          pv_currency_code        IN   VARCHAR2      currency code used for formating
262   --          pv_currency_mask        IN   VARCHAR       formatted mask used by fnd_currency function
263   --  DESIGN REFERENCES:
264   --
265   --
266   --  CHANGE HISTORY:
267   --
268   --           8-Apr-2009   Eric Ma  created
269   --==========================================================================
270   FUNCTION Get_Jai_Req_Tax_Disp
271   ( pn_jai_excl_nr_tax IN NUMBER
272   , pv_total_tax_dsp   IN VARCHAR2
273   , pv_currency_code   IN VARCHAR2
274   , pv_currency_mask   IN VARCHAR2
275   ) RETURN VARCHAR2;
276 
277  --==========================================================================
278   --    FUNCTION   NAME:
279   --
280   --    Get_Jai_Tax_Disp                     Public
281   --
282   --  DESCRIPTION:
283   --    Return the formatted tax amount for display
284   --
285   --  PARAMETERS:
286   --      In: pn_tax_amount           IN   NUMBER        tax amount
287   --          pv_currency_code        IN   VARCHAR2      currency code used for formating
288   --          pv_currency_mask        IN   VARCHAR       formatted mask used by fnd_currency function
289   --  DESIGN REFERENCES:
290   --
291   --
292   --  CHANGE HISTORY:
293   --
294   --           8-Apr-2009   Eric Ma  created
295   --==========================================================================
296   FUNCTION Get_Jai_Tax_Disp
297   ( pn_tax_amount IN NUMBER
298   , pv_currency_code   IN VARCHAR2
299   , pv_currency_mask   IN VARCHAR2
300   ) RETURN VARCHAR2;
301 
302   --==========================================================================
303   --    FUNCTION   NAME:
304   --
305   --    Get_Jai_Open_Form_command                     Public
306   --
307   --  DESCRIPTION:
308   --    Return the open form command for each document type
309   --
310   --  PARAMETERS:
311   --      In: pv_document_type        IN   VARCHAR2      document type
312   --  DESIGN REFERENCES:
313   --
314   --  CHANGE HISTORY:
315   --
316   --           13-Apr-2009   Eric Ma  created
317   --==========================================================================
318 
319   Function Get_Jai_Open_Form_Command( pv_document_type VARCHAR2 )
320   RETURN VARCHAR2;
321 
322 --==========================================================================
323   --    PROCEDURE   NAME:
324   --
325   --    Populate_Session_GT                     Public
326   --
327   --  DESCRIPTION:
328   --    Populate_session_gt will insert IL tax amount into session table
329   --
330   --  PARAMETERS:
331   --      In: p_document_id          IN   NUMBER        req header id,po header id
332   --          p_document_type        IN   VARCHAR2      po type
333   --          p_document_subtype     IN   VARCHAR2
334   --          x_session_gt_key       IN   NUMBER
335   --  DESIGN REFERENCES:
336   --
337   --
338   --  CHANGE HISTORY:
339   --
340   --           13-Apr-2009   Xiao Lv  created
341   --==========================================================================
342 
343   PROCEDURE Populate_Session_GT(
344 	   p_document_id         IN     NUMBER
345 	,  p_document_type       IN     VARCHAR2
346 	,  p_document_subtype    IN     VARCHAR2
347 	,  x_session_gt_key      IN     NUMBER
348 	) ;
349 
350 
351 
352 END JAI_PO_WF_UTIL_PUB;