DBA Data[Home] [Help]

PACKAGE: APPS.GL_BUDGET_ENTITIES_PKG

Source


1 PACKAGE gl_budget_entities_pkg AS
2 /* $Header: glibdors.pls 120.7 2005/05/05 01:01:54 kvora ship $ */
3 --
4 -- Package
5 --   gl_budget_entities_pkg
6 -- Purpose
7 --   To contain validation and insertion routines for gl_budget_entities
8 -- History
9 --   12-03-93  	D. J. Ogg	Created
10   --
11   -- Procedure
12   --   check_unique
13   -- Purpose
14   --   Checks to make sure that the name of the budget organization
15   --   is unique in this set of books.
16   -- History
17   --   12-03-93  D. J. Ogg    Created
18   --   05-22-96  U. Thimmappa Added code to detect duplicate bud org
19   --                          with status code = 'D'.
20   -- Arguments
21   --   lgr_id		The ledger id.
22   --   org_name 	The name of the budget organization
23   --   row_id		The current rowid
24   -- Example
25   --   gl_budget_entities_pkg.check_unique(2, 'Test1', 'ABD02334');
26   -- Notes
27   --
28   PROCEDURE check_unique(lgr_id NUMBER, org_name VARCHAR2, row_id VARCHAR2);
29 
30   --
31   -- Procedure
32   --   check_for_all
33   -- Purpose
34   --   Determines if there exists a budget organization
35   --   in this set of books named ALL (when the name is
36   --   converted to all caps) other than the one with rowid, row_id.
37   -- History
38   --   12-03-93  D. J. Ogg    Created
39   -- Arguments
40   --   lgr_id 		The ledger ID
41   --   row_id           The row to ignore in the search
42   -- Example
43   --   i := gl_budget_entities_pkg.check_for_all(2, 'ABD02334');
44   -- Notes
45   --
46   FUNCTION check_for_all(lgr_id NUMBER, row_id VARCHAR2) RETURN BOOLEAN;
47 
48   --
49   -- Procedure
50   --   has_ranges
51   -- Purpose
52   --   Determines if the budget organization has been assigned any
53   --   ranges.
54   -- History
55   --   12-03-93  D. J. Ogg    Created
56   -- Arguments
57   --   org_id		The ID of the budget organization
58   -- Example
59   --   i := gl_budget_entities_pkg.has_ranges(1000);
60   -- Notes
61   --
62   FUNCTION has_ranges(org_id NUMBER) RETURN BOOLEAN;
63 
64   --
65   -- Procedure
66   --   get_unique_id
67   -- Purpose
68   --   Gets a unique budget entity id
69   -- History
70   --   12-03-93  D. J. Ogg    Created
71   -- Arguments
72   --   none
73   -- Example
74   --   abid := gl_budget_entities_pkg.get_unique_id;
75   -- Notes
76   --
77   FUNCTION get_unique_id RETURN NUMBER;
78 
79   --
80   -- Procedure
81   --   lock_organization
82   -- Purpose
83   --   Locks the given budget organization
84   -- History
85   --   12-16-93  D. J. Ogg    Created
86   -- Arguments
87   --   org_id			The budget entity id
88   -- Example
89   --   lock_organization(1000);
90   -- Notes
91   --
92   PROCEDURE lock_organization(org_id NUMBER);
93 
94   --
95   -- Procedure
96   --   select_columns
97   -- Purpose
98   --   Used to select the name, password required flag, and
99   --   encrypted password.
100   -- History
101   --   21-MAR-94	DJOGG    Created
102   -- Arguments
103   --   entity_id	 	The ID of the budget entity.
104   --   entity_name       	The Name of the budget entity.
105   --   password_required_flag	A flag indicating whether or not the budget
106   --				password is required.
107   --   encrypted_password	The encrypted password
108   --   status			The budget entity status
109   -- Example
110   --   gl_budget_assignment_pkg.select_columns(2, ename);
111   -- Notes
112   --
113   PROCEDURE select_columns( entity_id			NUMBER,
114 			    entity_name			IN OUT NOCOPY VARCHAR2,
115 			    password_required_flag	IN OUT NOCOPY VARCHAR2,
116 			    encrypted_password		IN OUT NOCOPY VARCHAR2,
117 			    status_code			IN OUT NOCOPY VARCHAR2
118 			    );
119 
120 
121   --
122   -- Procedure
123   --   budget_and_account_seg_info
124   -- Purpose
125   --   Used to get current_budgetname and id, and the account segment name
126   -- History
127   --   5-MAR-95		K. Nigam    Created
128   -- Arguments
129   --      lgr_id               ledger id
130   --      coa_id               chart of accounts id
131   --      x_budget_version_id  budget_version_id
132   --      x_budget_name        budget name
133   --      x_bj_required        budget journals required
134   --      x_segment_name       account segment name
135   --
136   PROCEDURE budget_and_account_seg_info(
137                                lgr_id            NUMBER,
138                                coa_id               NUMBER,
139                                x_budget_version_id  IN OUT NOCOPY NUMBER,
140                                x_budget_name        IN OUT NOCOPY VARCHAR2,
141                                x_bj_required        IN OUT NOCOPY VARCHAR2,
142                                x_segment_name       OUT NOCOPY VARCHAR2);
143 
144   --
145   -- Procedure
146   --   Insert_Row
147   -- Purpose
148   --   Used to do the insert processing for a row
149   -- History
150   --   6-Mar-95	 K. Nigam    Created
151   --   7-Aug-03  P  Sahay    Added X_Security_Flag
152   --
153   PROCEDURE Insert_Row(X_Rowid                   IN OUT NOCOPY VARCHAR2,
154                        X_Budget_Entity_Id        IN OUT NOCOPY NUMBER,
155                        X_Name                           VARCHAR2,
156                        X_Ledger_Id                      NUMBER,
157                        X_Last_Update_Date               DATE,
158                        X_Last_Updated_By                NUMBER,
159                        X_Budget_Password_Required       VARCHAR2,
160                        X_Status_Code                    VARCHAR2,
161                        X_Creation_Date                  DATE,
162                        X_Created_By                     NUMBER,
163                        X_Last_Update_Login              NUMBER,
164                        X_Encrypted_Budget_Password      VARCHAR2,
165                        X_Description                    VARCHAR2,
166                        X_Start_Date                     DATE,
167                        X_End_Date                       DATE,
168                        X_Segment1_Type                  NUMBER,
169                        X_Segment2_Type                  NUMBER,
170                        X_Segment3_Type                  NUMBER,
171                        X_Segment4_Type                  NUMBER,
172                        X_Segment5_Type                  NUMBER,
173                        X_Segment6_Type                  NUMBER,
174                        X_Segment7_Type                  NUMBER,
175                        X_Segment8_Type                  NUMBER,
176                        X_Segment9_Type                  NUMBER,
177                        X_Segment10_Type                 NUMBER,
178                        X_Segment11_Type                 NUMBER,
179                        X_Segment12_Type                 NUMBER,
180                        X_Segment13_Type                 NUMBER,
181                        X_Segment14_Type                 NUMBER,
182                        X_Segment15_Type                 NUMBER,
183                        X_Segment16_Type                 NUMBER,
184                        X_Segment17_Type                 NUMBER,
185                        X_Segment18_Type                 NUMBER,
186                        X_Segment19_Type                 NUMBER,
187                        X_Segment20_Type                 NUMBER,
188                        X_Segment21_Type                 NUMBER,
189                        X_Segment22_Type                 NUMBER,
190                        X_Segment23_Type                 NUMBER,
191                        X_Segment24_Type                 NUMBER,
192                        X_Segment25_Type                 NUMBER,
193                        X_Segment26_Type                 NUMBER,
194                        X_Segment27_Type                 NUMBER,
195                        X_Segment28_Type                 NUMBER,
196                        X_Segment29_Type                 NUMBER,
197                        X_Segment30_Type                 NUMBER,
198                        X_Attribute1                     VARCHAR2,
199                        X_Attribute2                     VARCHAR2,
200                        X_Attribute3                     VARCHAR2,
201                        X_Attribute4                     VARCHAR2,
202                        X_Attribute5                     VARCHAR2,
203                        X_Attribute6                     VARCHAR2,
204                        X_Attribute7                     VARCHAR2,
205                        X_Attribute8                     VARCHAR2,
206                        X_Attribute9                     VARCHAR2,
207                        X_Attribute10                    VARCHAR2,
208                        X_Context                        VARCHAR2,
209                        X_All_Name                       BOOLEAN,
210                        X_Chart_Of_Accounts_Id           NUMBER,
211                        X_Security_Flag			VARCHAR2
212 );
213 
214   --
215   -- Procedure
216   --   Update_Row
217   -- Purpose
218   --   Used to do the update processing for a row
219   -- History
220   --   6-Mar-95	 K. Nigam    Created
221   --   7-Aug-03  P  Sahay    Added X_Security_Flag
222   --
223   PROCEDURE Update_Row(X_Rowid                          VARCHAR2,
224 
225                        X_Budget_Entity_Id               NUMBER,
226                        X_Name                           VARCHAR2,
227                        X_Ledger_Id                      NUMBER,
228                        X_Last_Update_Date               DATE,
229                        X_Last_Updated_By                NUMBER,
230                        X_Budget_Password_Required       VARCHAR2,
231                        X_Status_Code                    VARCHAR2,
232                        X_Last_Update_Login              NUMBER,
233                        X_Encrypted_Budget_Password      VARCHAR2,
234                        X_Description                    VARCHAR2,
235                        X_Start_Date                     DATE,
236                        X_End_Date                       DATE,
237                        X_Segment1_Type                  NUMBER,
238                        X_Segment2_Type                  NUMBER,
239                        X_Segment3_Type                  NUMBER,
240                        X_Segment4_Type                  NUMBER,
241                        X_Segment5_Type                  NUMBER,
242                        X_Segment6_Type                  NUMBER,
243                        X_Segment7_Type                  NUMBER,
244                        X_Segment8_Type                  NUMBER,
245                        X_Segment9_Type                  NUMBER,
246                        X_Segment10_Type                 NUMBER,
247                        X_Segment11_Type                 NUMBER,
248                        X_Segment12_Type                 NUMBER,
249                        X_Segment13_Type                 NUMBER,
250                        X_Segment14_Type                 NUMBER,
251                        X_Segment15_Type                 NUMBER,
252                        X_Segment16_Type                 NUMBER,
253                        X_Segment17_Type                 NUMBER,
254                        X_Segment18_Type                 NUMBER,
255                        X_Segment19_Type                 NUMBER,
256                        X_Segment20_Type                 NUMBER,
257                        X_Segment21_Type                 NUMBER,
261                        X_Segment25_Type                 NUMBER,
258                        X_Segment22_Type                 NUMBER,
259                        X_Segment23_Type                 NUMBER,
260                        X_Segment24_Type                 NUMBER,
262                        X_Segment26_Type                 NUMBER,
263                        X_Segment27_Type                 NUMBER,
264                        X_Segment28_Type                 NUMBER,
265                        X_Segment29_Type                 NUMBER,
266                        X_Segment30_Type                 NUMBER,
267                        X_Attribute1                     VARCHAR2,
268                        X_Attribute2                     VARCHAR2,
269                        X_Attribute3                     VARCHAR2,
270                        X_Attribute4                     VARCHAR2,
271                        X_Attribute5                     VARCHAR2,
272                        X_Attribute6                     VARCHAR2,
273                        X_Attribute7                     VARCHAR2,
274                        X_Attribute8                     VARCHAR2,
275                        X_Attribute9                     VARCHAR2,
276                        X_Attribute10                    VARCHAR2,
277                        X_Context                        VARCHAR2,
278                        X_All_Name                       BOOLEAN,
279                        X_Security_Flag                  VARCHAR2);
280 
281   --
282   -- Procedure
283   --   Lock_Row
284   -- Purpose
285   --   Locks a row in GL_BUDGET_ENTITIES table.
286   -- History
287   --   08-07-03  P Sahay      Created
288   --
289   PROCEDURE Lock_Row  (X_Rowid                IN OUT NOCOPY    VARCHAR2,
290                        X_Budget_Entity_Id     IN OUT NOCOPY    NUMBER,
291                        X_Name                           VARCHAR2,
292                        X_Ledger_Id                      NUMBER,
293                        X_Budget_Password_Required       VARCHAR2,
297                        X_Start_Date                     DATE,
294                        X_Status_Code                    VARCHAR2,
295                        X_Encrypted_Budget_Password      VARCHAR2,
296                        X_Description                    VARCHAR2,
298                        X_End_Date                       DATE,
299                        X_Segment1_Type                  NUMBER,
300                        X_Segment2_Type                  NUMBER,
301                        X_Segment3_Type                  NUMBER,
302                        X_Segment4_Type                  NUMBER,
303                        X_Segment5_Type                  NUMBER,
304                        X_Segment6_Type                  NUMBER,
305                        X_Segment7_Type                  NUMBER,
306                        X_Segment8_Type                  NUMBER,
307                        X_Segment9_Type                  NUMBER,
308                        X_Segment10_Type                 NUMBER,
309                        X_Segment11_Type                 NUMBER,
310                        X_Segment12_Type                 NUMBER,
311                        X_Segment13_Type                 NUMBER,
312                        X_Segment14_Type                 NUMBER,
313                        X_Segment15_Type                 NUMBER,
314                        X_Segment16_Type                 NUMBER,
315                        X_Segment17_Type                 NUMBER,
316                        X_Segment18_Type                 NUMBER,
317                        X_Segment19_Type                 NUMBER,
318                        X_Segment20_Type                 NUMBER,
319                        X_Segment21_Type                 NUMBER,
320                        X_Segment22_Type                 NUMBER,
321                        X_Segment23_Type                 NUMBER,
322                        X_Segment24_Type                 NUMBER,
323                        X_Segment25_Type                 NUMBER,
324                        X_Segment26_Type                 NUMBER,
325                        X_Segment27_Type                 NUMBER,
326                        X_Segment28_Type                 NUMBER,
327                        X_Segment29_Type                 NUMBER,
328                        X_Segment30_Type                 NUMBER,
329                        X_Attribute1                     VARCHAR2,
330                        X_Attribute2                     VARCHAR2,
331                        X_Attribute3                     VARCHAR2,
332                        X_Attribute4                     VARCHAR2,
333                        X_Attribute5                     VARCHAR2,
334                        X_Attribute6                     VARCHAR2,
335                        X_Attribute7                     VARCHAR2,
336                        X_Attribute8                     VARCHAR2,
337                        X_Attribute9                     VARCHAR2,
341 
338                        X_Attribute10                    VARCHAR2,
339                        X_Context                        VARCHAR2,
340                        X_Security_Flag			VARCHAR2);
342   --
343   -- Procedure
344   --   Insert_Org
345   -- Purpose
346   --   Inserts a row in GL_BUDGET_ENTITIES table.
347   --   Called by an iSpeed API.
348   -- History
349   --   11-07-00  K Vora       Created
350   --
351   PROCEDURE Insert_Org(X_Rowid               IN OUT NOCOPY     VARCHAR2,
352                        X_Budget_Entity_Id    IN OUT NOCOPY     NUMBER,
353                        X_Name                           VARCHAR2,
354                        X_Ledger_Id                      NUMBER,
355                        X_Last_Update_Date               DATE,
356                        X_Last_Updated_By                NUMBER,
357                        X_Budget_Password_Required       VARCHAR2,
358                        X_Status_Code                    VARCHAR2,
359                        X_Creation_Date                  DATE,
360                        X_Created_By                     NUMBER,
361                        X_Last_Update_Login              NUMBER,
362                        X_Encrypted_Budget_Password      VARCHAR2,
363                        X_Description                    VARCHAR2,
364                        X_Start_Date                     DATE,
365                        X_End_Date                       DATE,
366                        X_Segment1_Type                  NUMBER,
367                        X_Segment2_Type                  NUMBER,
368                        X_Segment3_Type                  NUMBER,
369                        X_Segment4_Type                  NUMBER,
370                        X_Segment5_Type                  NUMBER,
371                        X_Segment6_Type                  NUMBER,
372                        X_Segment7_Type                  NUMBER,
373                        X_Segment8_Type                  NUMBER,
374                        X_Segment9_Type                  NUMBER,
375                        X_Segment10_Type                 NUMBER,
376                        X_Segment11_Type                 NUMBER,
377                        X_Segment12_Type                 NUMBER,
378                        X_Segment13_Type                 NUMBER,
379                        X_Segment14_Type                 NUMBER,
380                        X_Segment15_Type                 NUMBER,
381                        X_Segment16_Type                 NUMBER,
382                        X_Segment17_Type                 NUMBER,
383                        X_Segment18_Type                 NUMBER,
384                        X_Segment19_Type                 NUMBER,
385                        X_Segment20_Type                 NUMBER,
386                        X_Segment21_Type                 NUMBER,
387                        X_Segment22_Type                 NUMBER,
388                        X_Segment23_Type                 NUMBER,
389                        X_Segment24_Type                 NUMBER,
390                        X_Segment25_Type                 NUMBER,
391                        X_Segment26_Type                 NUMBER,
392                        X_Segment27_Type                 NUMBER,
393                        X_Segment28_Type                 NUMBER,
394                        X_Segment29_Type                 NUMBER,
395                        X_Segment30_Type                 NUMBER,
396                        X_Attribute1                     VARCHAR2,
397                        X_Attribute2                     VARCHAR2,
398                        X_Attribute3                     VARCHAR2,
399                        X_Attribute4                     VARCHAR2,
400                        X_Attribute5                     VARCHAR2,
401                        X_Attribute6                     VARCHAR2,
402                        X_Attribute7                     VARCHAR2,
403                        X_Attribute8                     VARCHAR2,
404                        X_Attribute9                     VARCHAR2,
405                        X_Attribute10                    VARCHAR2,
406                        X_Context                        VARCHAR2);
407 
408   --
409   -- Function
410   --   Submit_Assign_Ranges_Request
411   -- Purpose
412   --   Submits the Assign Account Ranges concurrent program.
413   --   Called by an iSpeed API.
414   -- History
415   --   11-07-00  K Vora       Created
416   -- Argument
417   --   sobid - Ledger id
418   --   orgid - Budget entity id
419   -- Returns
420   --   The request id if the concurrent program was submitted successfully,
421   --   else returns 0.
422   --
423   FUNCTION Submit_Assign_Ranges_Request(
424 			  X_Ledger_id   IN VARCHAR2,
425 			  X_Orgid       IN VARCHAR2)
426 			  return NUMBER;
427   --
428   -- Procedure
429   --   Set_BC_Timestamp
430   -- Purpose
431   --   Sets the event timestamp used by budgetary control.
432   --   Called by an iSpeed API.
433   -- History
434   --   11-07-00  K Vora       Created
435   --
436   PROCEDURE Set_BC_Timestamp(X_Ledger_Id       NUMBER);
437 
438 
439 END gl_budget_entities_pkg;