DBA Data[Home] [Help]

PACKAGE: APPS.GL_DAILY_RATES_PKG

Source


1 PACKAGE GL_DAILY_RATES_PKG as
2 /* $Header: glirtdys.pls 120.7 2005/05/05 01:21:14 kvora ship $ */
3 --
4 -- Package
5 --   gl_daily_rates_pkg
6 -- Purpose
7 --   To contain validation and insertion routines for gl_daily_rates
8 -- History
9 --   07-29-97	W Wong		Created
10 
11   --
12   -- Procedure
13   --  Insert_Row
14   --
15   -- Purpose
16   --   Inserts two rows into gl_daily_rates:
17   --   one for the original conversion rate ( From Currency -> To Currency )
18   --   one for the inverse conversion rate  ( To Currency   -> From Currency )
19   --
20   -- History
21   --   07-29-97	W Wong		Created
22   --
23   -- Arguments
24   --   All the columns of the table GL_DAILY_RATES and
25   --   X_Average_Balances_Used	 		Average Balances Used
26   --   X_Euro_Currency				Currency Code of EURO
27   --
28   -- Example
29   --   gl_daily_rates.Insert_Row(....);
30   --
31   -- Notes
32   --
33 PROCEDURE Insert_Row(X_Rowid                         IN OUT NOCOPY VARCHAR2,
34 		     X_Inverse_Rowid                 IN OUT NOCOPY VARCHAR2,
35                      X_From_Currency                        VARCHAR2,
36                      X_To_Currency                          VARCHAR2,
37                      X_Conversion_Date                      DATE,
38                      X_Conversion_Type                      VARCHAR2,
39                      X_Conversion_Rate                      NUMBER,
40                      X_Inverse_Conversion_Rate              NUMBER,
41 		     X_Status_Code        	     IN OUT NOCOPY VARCHAR2,
42                      X_Creation_Date                        DATE,
43                      X_Created_By                           NUMBER,
44                      X_Last_Update_Date                     DATE,
45                      X_Last_Updated_By                      NUMBER,
46                      X_Last_Update_Login                    NUMBER,
47                      X_Context                              VARCHAR2,
48                      X_Attribute1                           VARCHAR2,
49                      X_Attribute2                           VARCHAR2,
50                      X_Attribute3                           VARCHAR2,
51                      X_Attribute4                           VARCHAR2,
52                      X_Attribute5                           VARCHAR2,
53                      X_Attribute6                           VARCHAR2,
54                      X_Attribute7                           VARCHAR2,
55                      X_Attribute8                           VARCHAR2,
56                      X_Attribute9                           VARCHAR2,
57                      X_Attribute10                          VARCHAR2,
58                      X_Attribute11                          VARCHAR2,
59                      X_Attribute12                          VARCHAR2,
60                      X_Attribute13                          VARCHAR2,
61                      X_Attribute14                          VARCHAR2,
62                      X_Attribute15                          VARCHAR2,
63 		     X_Average_Balances_Used		    VARCHAR2,
64 		     X_Euro_Currency			    VARCHAR2
65                      );
66   --
67   -- Procedure
68   --  Lock_Row
69   --
70   -- Purpose
71   --   Locks a pair of rows in gl_daily_rates
72   --
73   -- History
74   --   07-29-97	W Wong		Created
75   --
76   -- Arguments
77   --   All the columns of the table GL_DAILY_RATES
78   --
79   -- Example
80   --   gl_daily_rates.Lock_Row(....);
81   --
82   -- Notes
83   --
84 PROCEDURE Lock_Row(X_Rowid                                VARCHAR2,
85 		   X_Inverse_Rowid			  VARCHAR2,
86                    X_From_Currency                        VARCHAR2,
87                    X_To_Currency                          VARCHAR2,
88                    X_Conversion_Date                      DATE,
89                    X_Conversion_Type                      VARCHAR2,
90                    X_Conversion_Rate                      NUMBER,
91                    X_Inverse_Conversion_Rate              NUMBER,
92 		   X_Status_Code        		  VARCHAR2,
93                    X_Creation_Date                        DATE,
94                    X_Created_By                           NUMBER,
95                    X_Last_Update_Date                     DATE,
96                    X_Last_Updated_By                      NUMBER,
97                    X_Last_Update_Login                    NUMBER,
98                    X_Context                              VARCHAR2,
99                    X_Attribute1                           VARCHAR2,
100                    X_Attribute2                           VARCHAR2,
101                    X_Attribute3                           VARCHAR2,
102                    X_Attribute4                           VARCHAR2,
103                    X_Attribute5                           VARCHAR2,
104                    X_Attribute6                           VARCHAR2,
105                    X_Attribute7                           VARCHAR2,
106                    X_Attribute8                           VARCHAR2,
107                    X_Attribute9                           VARCHAR2,
108                    X_Attribute10                          VARCHAR2,
109                    X_Attribute11                          VARCHAR2,
110                    X_Attribute12                          VARCHAR2,
111                    X_Attribute13                          VARCHAR2,
112                    X_Attribute14                          VARCHAR2,
113                    X_Attribute15                          VARCHAR2
114                    );
115   --
116   -- Procedure
117   --
118   --  Update_Row
119   --
120   -- Purpose
121   --   Updates a pair of rows in gl_daily_rates.
122   --
123   -- History
124   --   07-29-97	W Wong		Created
125   --
126   -- Arguments
127   --   All the columns of the table GL_DAILY_RATES and
128   --   X_Average_Balances_Used	 		Average Balances Used
129   --   X_Euro_Currency				Currency Code of EURO
130   --
131   -- Example
132   --   gl_daily_rates.Update_Row(....);
133   --
134   -- Notes
135   --
136 PROCEDURE Update_Row(X_Rowid                                VARCHAR2,
137                      X_Inverse_Rowid                        VARCHAR2,
138                      X_From_Currency                        VARCHAR2,
139                      X_To_Currency                          VARCHAR2,
140                      X_Conversion_Date                      DATE,
141                      X_Conversion_Type                      VARCHAR2,
142                      X_Conversion_Rate                      NUMBER,
143                      X_Inverse_Conversion_Rate              NUMBER,
144 		     X_Status_Code        	     IN OUT NOCOPY VARCHAR2,
145                      X_Creation_Date                        DATE,
146                      X_Created_By                           NUMBER,
147                      X_Last_Update_Date                     DATE,
148                      X_Last_Updated_By                      NUMBER,
149                      X_Last_Update_Login                    NUMBER,
150                      X_Context                              VARCHAR2,
151                      X_Attribute1                           VARCHAR2,
152                      X_Attribute2                           VARCHAR2,
153                      X_Attribute3                           VARCHAR2,
154                      X_Attribute4                           VARCHAR2,
155                      X_Attribute5                           VARCHAR2,
156                      X_Attribute6                           VARCHAR2,
157                      X_Attribute7                           VARCHAR2,
158                      X_Attribute8                           VARCHAR2,
159                      X_Attribute9                           VARCHAR2,
160                      X_Attribute10                          VARCHAR2,
161                      X_Attribute11                          VARCHAR2,
162                      X_Attribute12                          VARCHAR2,
163                      X_Attribute13                          VARCHAR2,
164                      X_Attribute14                          VARCHAR2,
165                      X_Attribute15                          VARCHAR2,
166 		     X_Average_Balances_Used		    VARCHAR2,
167 		     X_Euro_Currency			    VARCHAR2
168                      );
169   --
170   -- Procedure
171   --
172   --  Delete_Row
173   --
174   -- Purpose
175   --   Deletes a row from gl_daily_rates
176   --
177   -- History
178   --   07-29-97	W Wong		Created
179   --
180   -- Arguments
181   --    X_Rowid         	Rowid of the row with conversion rate
182   --    X_Inverse_Rowid		Rowid of the row with inverse conversion rate
183   --    X_From_Currency		From Currency
184   --    X_To_Currency		To Currency
185   --    X_Conversion_Type	Conversion Type
186   --    X_Conversion_Date	Conversion Date
187   --    X_Status_Code		Status Code
188   --    X_Average_Balances_Used Average Balance Used Flag
189   --    X_Euro_Currency		Currency code of the Euro currency
190   --
191   -- Example
192   --   gl_daily_rates.delete_row('...');
193   --
194   -- Notes
195   --
196 PROCEDURE Delete_Row(X_Rowid    	                    VARCHAR2,
197                      X_Inverse_Rowid	                    VARCHAR2,
198 		     X_From_Currency			    VARCHAR2,
199 		     X_To_Currency			    VARCHAR2,
200 		     X_Conversion_Type			    VARCHAR2,
201 		     X_Conversion_Date			    DATE,
202 		     X_Status_Code        	     IN OUT NOCOPY VARCHAR2,
203 		     X_Average_Balances_Used		    VARCHAR2,
204 		     X_Euro_Currency			    VARCHAR2
205 		     );
206 
207   --
208   -- Procedure
209   --   Check_Unique
210   --
211   -- Purpose
212   --   Checks to make sure that gl_daily_rates is unique.
213   --
214   -- History
215   --   07-29-97	W Wong		Created
216   --
217   -- Arguments
218   --   X_Rowid                   	The row ID
219   --   X_From_Currency			From Currency
220   --   X_To_Currency			To Currency
221   --   X_Conversion_Date		Conversion Date
222   --   X_Conversion_Type		Conversion Type
223   --
224   -- Example
225   --   gl_daily_rates.check_unique(...);
226   --
227   -- Notes
228   --
229 PROCEDURE Check_Unique(X_Rowid                  VARCHAR2,
230                        X_From_Currency          VARCHAR2,
231                        X_To_Currency            VARCHAR2,
232                        X_Conversion_Date        DATE,
233                        X_Conversion_Type        VARCHAR2);
234 
235   --
236   -- Function
237   --   Used_In_Ledger
238   --
239   -- Purpose
240   --   Checks if the specified currency and conversion type is
241   --   being used by any average ledgers.
242   --
243   -- History
244   --   08-06-97	W Wong	Created
245   --
246   -- Arguments
247   --   X_From_Currency                  From Currency
248   --   X_To_Currency                    To Currency
249   --   X_Conversion_Type                Conversion Type
250   --   X_Euro_Currency			Currency code for the EURO currency
251   --   X_Conversion_Date		Conversion Date
252   --
253   -- Example
254   --   gl_daily_rates.used_in_ledger(...)
255   --
256   -- Notes
257   --
258 FUNCTION Used_In_Ledger( X_From_Currency          VARCHAR2,
259 		         X_To_Currency            VARCHAR2,
260                          X_Conversion_Type        VARCHAR2,
261 			 X_Euro_Currency          VARCHAR2,
262 			 X_Conversion_Date        DATE ) RETURN BOOLEAN;
263 
264 
265  --
266   -- Procedure
267   --  Insert_DateRange
268   --
269   -- Purpose
270   --   Inserts rows into gl_daily_rates_interface:
271   --
272   -- History
273   --   09-07-00	K Chang		Created
274   --
275   -- Arguments
276   --   All the columns of the table GL_DAILY_RATES_INTERFACE
277   --
278   -- Example
279   --   gl_daily_rates.Insert_DateRange(....);
280   --
281   -- Notes
282   --
283 PROCEDURE Insert_DateRange(X_From_Currency                        VARCHAR2,
284                            X_To_Currency                          VARCHAR2,
285                            X_From_Conversion_Date                 DATE,
286                            X_To_Conversion_Date                   DATE,
287                            X_User_Conversion_Type                 VARCHAR2,
288                            X_Conversion_Rate                      NUMBER,
289                            X_Mode_Flag                            VARCHAR2,
290                      	   X_Inverse_Conversion_Rate              NUMBER,
291                      	   X_User_Id                              NUMBER,
292                      	   X_Launch_Rate_Change                   VARCHAR2,
293                      	   X_Error_Code                           VARCHAR2,
294                      	   X_Context                              VARCHAR2,
295                      	   X_Attribute1                           VARCHAR2,
296                      	   X_Attribute2                           VARCHAR2,
297                      	   X_Attribute3                           VARCHAR2,
298                      	   X_Attribute4                           VARCHAR2,
299                      	   X_Attribute5                           VARCHAR2,
300                      	   X_Attribute6                           VARCHAR2,
301                      	   X_Attribute7                           VARCHAR2,
302                      	   X_Attribute8                           VARCHAR2,
303                      	   X_Attribute9                           VARCHAR2,
304                      	   X_Attribute10                          VARCHAR2,
305                      	   X_Attribute11                          VARCHAR2,
306                      	   X_Attribute12                          VARCHAR2,
307                      	   X_Attribute13                          VARCHAR2,
308                      	   X_Attribute14                          VARCHAR2,
309                      	   X_Attribute15                          VARCHAR2,
310 		     	   X_Used_For_AB_Translation		  VARCHAR2
311                      );
312 
313   --
314   -- Procedure
315   --  Validate_DailyRates
316   --
317   -- Purpose
318   --   This procedure is created for Ispeed Daily Rates API.
319   --   It validate the following:
320   --   o From_Currency and To_Currency are not the same
321   --   o From_Currency and To_Currency:
322   --     a. Currency exists in the FND_CURRENCIES table
323   --     b. Currency is enabled
324   --     c. Currency is not out of date
325   --     d. Currency is not an EMU currency
326   --   o Range of dates specified does not exceeds 366 days
327   --
328   -- History
329   --   09-06-00	K Chang		Created
330   --
331   -- Arguments
332   --  X_From_Currency		From Currency
333   --  X_To_Currency		To Currency
334   --  X_Converson_Date          Conversion Date
335   --  X_Conversion_Type         Conversion Type
336   --  X_From_Conversion_Date    From Conversion Date
337   --  X_To_Conversion_Date      To Conversion Date
338   --
339   -- Example
340   --   gl_daily_rates_pkg.Validate_DailyRates(....);
341   --
342   -- Notes
343   --
344   PROCEDURE Validate_DailyRates(X_From_Currency             VARCHAR2,
345                      X_To_Currency                          VARCHAR2,
346 		     X_Conversion_Date                      DATE,
347                      X_Conversion_Type                      VARCHAR2,
348 		     X_From_Conversion_Date		    DATE,
349                      X_To_Conversion_Date  		    DATE
350  );
351 
352   --
353   -- Function
354   --  Submit_Conc_Request
355   --
356   -- Purpose
357   --   Launch Conversion Rate Change concurrent program for
358   --   Ispeed Daily Rates API
359   --
360   -- History
361   --   09-06-00	K Chang		Created
362   --
363   -- Arguments
367   --   gl_daily_rates_pkg.Submit_Conc_Request(....);
364   --
365   --
366   -- Example
368   --
369   -- Notes
370   --
371   FUNCTION submit_conc_request RETURN NUMBER;
372 
373   --
374   -- Procedure
375   --  Upload_Row
376   --
377   -- Purpose
378   --   Inserts two rows into gl_daily_rates for Ispeed daily rates API:
379   --   one for the original conversion rate ( From Currency -> To Currency )
380   --   one for the inverse conversion rate  ( To Currency   -> From Currency )
381   --
382   -- History
383   --   09-21-00	K Chang		Created
384   --
385   -- Arguments
386   --   All the columns of the table GL_DAILY_RATES and
387   --   X_Average_Balances_Used	 		Average Balances Used
388   --   X_Euro_Currency				Currency Code of EURO
389   --
390   -- Example
391   --   gl_daily_rates.Upload_Row(....);
392   --
393   -- Notes
394   --
395 PROCEDURE Upload_Row(X_Rowid                         IN OUT NOCOPY VARCHAR2,
396 		     X_Inverse_Rowid                 IN OUT NOCOPY VARCHAR2,
397                      X_From_Currency                        VARCHAR2,
398                      X_To_Currency                          VARCHAR2,
399                      X_Conversion_Date                      DATE,
400                      X_Conversion_Type                      VARCHAR2,
401                      X_Conversion_Rate                      NUMBER,
402                      X_Inverse_Conversion_Rate              NUMBER,
403 		     X_Status_Code        	     IN OUT NOCOPY VARCHAR2,
404                      X_Creation_Date                        DATE,
405                      X_Created_By                           NUMBER,
406                      X_Last_Update_Date                     DATE,
407                      X_Last_Updated_By                      NUMBER,
408                      X_Last_Update_Login                    NUMBER,
409                      X_Context                              VARCHAR2,
410                      X_Attribute1                           VARCHAR2,
411                      X_Attribute2                           VARCHAR2,
412                      X_Attribute3                           VARCHAR2,
413                      X_Attribute4                           VARCHAR2,
414                      X_Attribute5                           VARCHAR2,
415                      X_Attribute6                           VARCHAR2,
416                      X_Attribute7                           VARCHAR2,
417                      X_Attribute8                           VARCHAR2,
418                      X_Attribute9                           VARCHAR2,
419                      X_Attribute10                          VARCHAR2,
420                      X_Attribute11                          VARCHAR2,
421                      X_Attribute12                          VARCHAR2,
422                      X_Attribute13                          VARCHAR2,
423                      X_Attribute14                          VARCHAR2,
424                      X_Attribute15                          VARCHAR2,
425 		     X_Average_Balances_Used		    VARCHAR2,
426 		     X_Euro_Currency			    VARCHAR2
427                      );
428 
429 END GL_DAILY_RATES_PKG;