1 PACKAGE GMS_AWARD_PVT AUTHID CURRENT_USER AS
2 -- $Header: gmsawpvs.pls 120.1 2007/02/06 09:48:44 rshaik ship $
3
4
5 -- ---------------------------------------------
6 -- reset_msg_init
7 -- This is called from gms_award_pub API.
8 -- This is used to reset flags indicating that
9 -- message table has not been initialized.
10 -- ---------------------------------------------
11 PROCEDURE reset_message_flag ;
12
13
14 -- ---------------------------------------------
15 -- init_message_stack
16 -- Initialize the message stack here.
17 -- ---------------------------------------------
18 PROCEDURE init_message_stack ;
19
20
21
22 -- ---------------------------------------------
23 -- add_message_to_stack
24 -- Common program unit used to set the message
25 -- in the stack.
26 -- ---------------------------------------------
27 PROCEDURE add_message_to_stack( P_Label IN Varchar2,
28 P_token1 IN varchar2 DEFAULT NULL,
29 P_val1 IN varchar2 DEFAULT NULL,
30 P_token2 IN varchar2 DEFAULT NULL,
31 P_val2 in varchar2 DEFAULT NULL,
32 P_token3 IN varchar2 DEFAULT NULL,
33 P_val3 in varchar2 DEFAULT NULL ) ;
34
35
36 PROCEDURE set_return_status(X_return_status IN OUT NOCOPY VARCHAR2,
37 p_type in varchar2 DEFAULT 'B' ) ;
38 ---------------------------------------------------------------------------
39 --
40 -- CREATE_AWARD
41 -- Create award is a private API provided to create award
42 -- into grants accounting. This is the API used to
43 -- transfer Legacy system data into grants accounting.
44 -- OUT NOCOPY Parameters meanings
45 -- X_MSG_COUNT : Holds no. of messages in the global
46 -- message table.
47 -- X_MSG_DATE : Holds the message code, if the API
48 -- returned only one error/warning message.
49 -- X_return_status : The indicator of success/Failure
50 -- S- Success, E- and U- Failure
51 -- p_award_id : The Award ID created.
52 ---------------------------------------------------------------------------
53 -- Create Award
54 -- ======================================================================
55
56 PROCEDURE create_award( X_msg_count IN OUT NOCOPY NUMBER ,
57 X_MSG_DATA IN OUT NOCOPY varchar2 ,
58 X_return_status IN OUT NOCOPY varchar2,
59 X_ROW_ID OUT NOCOPY VARCHAR2,
60 X_AWARD_ID OUT NOCOPY NUMBER ,
61 P_CALLING_MODULE IN VARCHAR2,
62 P_API_VERSION_NUMBER IN NUMBER ,
63 P_AWARD_REC IN GMS_AWARDS_ALL%ROWTYPE ) ;
64
65 -- ===========================================================
66 -- COPY_AWARD :
67 -- Copy award has all the parameters that we have in quick entry for award.
68 -- The ID's in the table are replaced by corresponding value. Users must
69 -- provide decode values instead of code values.
70 -- P_return_status : S- Success,
71 -- E- Business Rule Validation error
72 -- U- Unexpected Error
73 -- P_API_VERSION_NUMBER : 1.0
74 -- ===============================================================================
75 PROCEDURE COPY_AWARD(
76 X_MSG_COUNT IN OUT NOCOPY NUMBER,
77 X_MSG_DATA IN OUT NOCOPY VARCHAR2,
78 X_return_status IN OUT NOCOPY VARCHAR2,
79 P_AWARD_NUMBER IN OUT NOCOPY VARCHAR2,
80 X_AWARD_ID OUT NOCOPY NUMBER,
81 P_CALLING_MODULE IN VARCHAR2,
82 P_API_VERSION_NUMBER IN NUMBER,
83 P_AWARD_BASE_ID IN NUMBER,
84 P_AWARD_SHORT_NAME IN VARCHAR2 DEFAULT NULL,
85 P_AWARD_FULL_NAME IN VARCHAR2 DEFAULT NULL,
86 P_AWARD_START_DATE IN DATE DEFAULT NULL,
87 P_AWARD_END_DATE IN DATE DEFAULT NULL,
88 P_AWARD_CLOSE_DATE IN DATE DEFAULT NULL,
89 P_PREAWARD_DATE IN DATE DEFAULT NULL,
90 P_AWARD_PURPOSE_CODE IN VARCHAR2 DEFAULT NULL,
91 P_AWARD_STATUS_CODE IN VARCHAR2 DEFAULT NULL,
92 P_AWARD_MANAGER_ID IN NUMBER DEFAULT NULL,
93 P_AWARD_ORGANIZATION_ID IN NUMBER DEFAULT NULL,
94 P_FUNDING_SOURCE_ID IN NUMBER DEFAULT NULL,
95 P_FUNDING_SOURCE_AWARD_NUM IN VARCHAR2 DEFAULT NULL,
96 P_ALLOWABLE_SCHEDULE_ID IN VARCHAR2 DEFAULT NULL,
97 P_INDIRECT_SCHEDULE_ID IN VARCHAR2 DEFAULT NULL,
98 P_COST_IND_SCH_FIXED_DATE IN DATE DEFAULT NULL,
99 P_REVENUE_DISTRIBUTION_RULE IN VARCHAR2 DEFAULT NULL,
100 P_BILLING_DISTRIBUTION_RULE IN VARCHAR2 DEFAULT NULL,
101 P_BILLING_TERM_ID IN NUMBER DEFAULT NULL,
102 P_LABOR_INVOICE_FORMAT_ID IN VARCHAR2 DEFAULT NULL,
103 P_NON_LABOR_INVOICE_FORMAT_ID IN VARCHAR2 DEFAULT NULL,
104 P_BILLING_CYCLE_ID IN VARCHAR2 DEFAULT NULL,
105 P_AMOUNT_TYPE_CODE IN VARCHAR2 DEFAULT NULL,
106 P_BOUNDARY_CODE IN VARCHAR2 DEFAULT NULL,
107 P_AGREEMENT_TYPE IN VARCHAR2 DEFAULT NULL,
108 P_ATTRIBUTE_CATEGORY IN VARCHAR2 DEFAULT NULL,
109 P_ATTRIBUTE1 IN VARCHAR2 DEFAULT NULL,
110 P_ATTRIBUTE2 IN VARCHAR2 DEFAULT NULL,
111 P_ATTRIBUTE3 IN VARCHAR2 DEFAULT NULL,
112 P_ATTRIBUTE4 IN VARCHAR2 DEFAULT NULL,
113 P_ATTRIBUTE5 IN VARCHAR2 DEFAULT NULL,
114 P_ATTRIBUTE6 IN VARCHAR2 DEFAULT NULL,
115 P_ATTRIBUTE7 IN VARCHAR2 DEFAULT NULL,
116 P_ATTRIBUTE8 IN VARCHAR2 DEFAULT NULL,
117 P_ATTRIBUTE9 IN VARCHAR2 DEFAULT NULL,
118 P_ATTRIBUTE10 IN VARCHAR2 DEFAULT NULL,
119 P_ATTRIBUTE11 IN VARCHAR2 DEFAULT NULL,
120 P_ATTRIBUTE12 IN VARCHAR2 DEFAULT NULL,
121 P_ATTRIBUTE13 IN VARCHAR2 DEFAULT NULL,
122 P_ATTRIBUTE14 IN VARCHAR2 DEFAULT NULL,
123 P_ATTRIBUTE15 IN VARCHAR2 DEFAULT NULL,
124 P_ATTRIBUTE16 IN VARCHAR2 DEFAULT NULL,
125 P_ATTRIBUTE17 IN VARCHAR2 DEFAULT NULL,
126 P_ATTRIBUTE18 IN VARCHAR2 DEFAULT NULL,
127 P_ATTRIBUTE19 IN VARCHAR2 DEFAULT NULL,
128 P_ATTRIBUTE20 IN VARCHAR2 DEFAULT NULL,
129 P_ATTRIBUTE21 IN VARCHAR2 DEFAULT NULL,
130 P_ATTRIBUTE22 IN VARCHAR2 DEFAULT NULL,
131 P_ATTRIBUTE23 IN VARCHAR2 DEFAULT NULL,
132 P_ATTRIBUTE24 IN VARCHAR2 DEFAULT NULL,
133 P_ATTRIBUTE25 IN VARCHAR2 DEFAULT NULL,
134 P_PROPOSAL_ID IN NUMBER DEFAULT NULL) ;
135
136
137 -- ==========================================================================================
138 -- Create Installments.
139 --
140 -- CREATE_INSTALLMENT
141 -- Create Installment is a private API provided to create Installment for awards in grants accounting.
142 -- Valid award should be defined. This API is used to transfer Legacy system data into grants
143 -- accounting also.
144 --
145 -- X_MSG_COUNT : Holds no. of messages in the global
146 -- message table
147 -- X_MSG_DATA : Holds the message code, if the API
148 -- returned only one error/warning message
149 -- X_RETURN_STATUS : The indicator of success/Failure
150 -- S- Success, E- and U- Failure
151 -- X_INSTALLMENT_ID : The Unique Record Identifier that is created.
152 -- X_ROW_ID : Record Identifier
153 --
154 -- P_CALLING_MODULE : For Internal Use only. This is exclusively
155 -- reserved by Grants Accounting for future Use.
156 -- P_API_VERSION_NUMBER : Package constant used for package version
157 -- P_VALIDATE : This is for internal Use only. This is used to
158 -- to avoid redundant validations, once we know Input
159 -- data is valid
160 -- P_INSTALLMENT_REC : Installment Record Which will hold all the Input
161 -- Values
162 -- ==========================================================================================
163
164 PROCEDURE create_installment
165 (X_MSG_COUNT IN OUT NOCOPY NUMBER ,
166 X_MSG_DATA IN OUT NOCOPY VARCHAR2 ,
167 X_RETURN_STATUS IN OUT NOCOPY VARCHAR2 ,
168 X_ROW_ID OUT NOCOPY VARCHAR2 ,
169 X_INSTALLMENT_ID OUT NOCOPY NUMBER ,
170 P_CALLING_MODULE IN VARCHAR2 ,
171 P_API_VERSION_NUMBER IN NUMBER,
172 P_VALIDATE IN BOOLEAN DEFAULT TRUE ,
173 P_INSTALLMENT_REC IN GMS_INSTALLMENTS%ROWTYPE
174
175 ) ;
176
177
178 -- ==========================================================================================
179 -- Create Personnel
180 --
181 -- CREATE_PERSONNEL
182 -- Create Personnel is a private API provided to create Personnel for awards in
183 -- grants accounting. This is the API used to transfer Legacy system data into grants
184 -- accounting also.
185 --
186 -- X_MSG_COUNT : Holds no. of messages in the global
187 -- message table
188 -- X_MSG_DATA : Holds the message code, if the API
189 -- returned only one error/warning message
190 -- X_RETURN_STATUS : The indicator of success/Failure
191 -- S- Success, E- and U- Failure
192 -- X_ROW_ID : Record Identifier
193 --
194 -- P_CALLING_MODULE : For Internal Use only. This is exclusively
195 -- reserved by Grants Accounting for future Use.
196 -- P_API_VERSION_NUMBER : Package constant used for package version
197 -- P_VALIDATE : This is for internal Use only. This is used to
198 -- to avoid redundant validations, once we know Input
199 -- data is valid
200 -- P_PERSONNEL_REC : Personnel Record Which will hold all the Input
201 -- Values
202 -- ==========================================================================================
203
204
205 PROCEDURE create_personnel
206 (X_MSG_COUNT IN OUT NOCOPY NUMBER ,
207 X_MSG_DATA IN OUT NOCOPY VARCHAR2 ,
208 X_RETURN_STATUS IN OUT NOCOPY VARCHAR2 ,
209 X_ROW_ID OUT NOCOPY VARCHAR2 ,
210 P_CALLING_MODULE IN VARCHAR2 ,
211 P_API_VERSION_NUMBER IN NUMBER ,
212 P_VALIDATE IN BOOLEAN DEFAULT TRUE ,
213 P_PERSONNEL_REC IN GMS_PERSONNEL%ROWTYPE
214 );
215
216 -- ==========================================================================================
217 -- Create Terms and conditions.
218 --
219 -- CREATE_TERM_CONDITION
220 -- Create Term Condition is a private API provided to create Term and Condition for awards in
221 -- grants accounting. This is the API used to transfer Legacy system data into grants
222 -- accounting also.
223 --
224 -- X_MSG_COUNT : Holds no. of messages in the global
225 -- message table
226 -- X_MSG_DATA : Holds the message code, if the API
227 -- returned only one error/warning message
228 -- X_RETURN_STATUS : The indicator of success/Failure
229 -- S- Success, E- and U- Failure
230 -- X_ROW_ID : Record Identifier
231 --
232 -- P_CALLING_MODULE : For Internal Use only. This is exclusively
233 -- reserved by Grants Accounting for future Use.
234 -- P_API_VERSION_NUMBER : Package constant used for package version
235 -- P_VALIDATE : This is for internal Use only. This is used to
236 -- to avoid redundant validations, once we know Input
237 -- data is valid
238 -- P_AWARD_TERM_CONDITION_REC : Term Condition Record Which will hold all the Input
239 -- Values
240 -- ==========================================================================================
241
242 PROCEDURE create_term_condition
243 (X_MSG_COUNT IN OUT NOCOPY NUMBER ,
244 X_MSG_DATA IN OUT NOCOPY VARCHAR2 ,
245 X_RETURN_STATUS IN OUT NOCOPY VARCHAR2 ,
246 X_ROW_ID OUT NOCOPY VARCHAR2 ,
247 P_CALLING_MODULE IN VARCHAR2 ,
248 P_API_VERSION_NUMBER IN NUMBER ,
249 P_VALIDATE IN BOOLEAN DEFAULT TRUE ,
250 P_AWARD_TERM_CONDITION_REC IN GMS_AWARDS_TERMS_CONDITIONS%ROWTYPE
251 ) ;
252
253
254 -- ==========================================================================================
255 -- Create Reference Number
256 --
257 -- CREATE_REFERENCE_NUMBER
258 -- Create Reference Number is a private API provided to create Reference Number for awards in
259 -- grants accounting. This is the API used to transfer Legacy system data into grants
260 -- accounting also.
261 --
262 -- X_MSG_COUNT : Holds no. of messages in the global
263 -- message table
264 -- X_MSG_DATA : Holds the message code, if the API
265 -- returned only one error/warning message
266 -- X_RETURN_STATUS : The indicator of success/Failure
267 -- S- Success, E- and U- Failure
268 -- X_ROW_ID : Record Identifier
269 --
270 -- P_CALLING_MODULE : For Internal Use only. This is exclusively
271 -- reserved by Grants Accounting for future Use.
272 -- P_API_VERSION_NUMBER : Package constant used for package version
273 -- P_VALIDATE : This is for internal Use only. This is used to
274 -- to avoid redundant validations, once we know Input
275 -- data is valid
276 -- P_REFERENCE_NUMBER_REC : Reference Number Record Which will hold all the Input
277 -- Values
278 -- ==========================================================================================
279
280 PROCEDURE create_reference_number
281 (X_MSG_COUNT IN OUT NOCOPY NUMBER ,
282 X_MSG_DATA IN OUT NOCOPY VARCHAR2 ,
283 X_RETURN_STATUS IN OUT NOCOPY VARCHAR2 ,
284 X_ROW_ID OUT NOCOPY VARCHAR2 ,
285 P_CALLING_MODULE IN VARCHAR2 ,
286 P_API_VERSION_NUMBER IN NUMBER ,
287 P_VALIDATE IN BOOLEAN DEFAULT TRUE ,
288 P_REFERENCE_NUMBER_REC IN GMS_REFERENCE_NUMBERS%ROWTYPE
289 ) ;
290
291 -- ==========================================================================================
292 -- Create Contact
293 --
294 -- CREATE_CONTACT
295 -- Create Contact is a private API provided to create Contact for awards in grants accounting.
296 -- Valid Award should be defined. This API is used to transfer Legacy system data into grants
297 -- accounting also.
298 --
299 -- X_MSG_COUNT : Holds no. of messages in the global
300 -- message table
301 -- X_MSG_DATA : Holds the message code, if the API
302 -- returned only one error/warning message
303 -- X_RETURN_STATUS : The indicator of success/Failure
304 -- S- Success, E- and U- Failure
305 -- X_ROW_ID : Record Identifier
306 --
307 -- P_CALLING_MODULE : For Internal Use only. This is exclusively
308 -- reserved by Grants Accounting for future Use.
309 -- P_API_VERSION_NUMBER : Package constant used for package version
310 -- P_VALIDATE : This is for internal Use only. This is used to
311 -- to avoid redundant validations, once we know Input
312 -- data is valid
313 -- P_CONTACT_REC : Contact Record Which will hold all the Input
314 -- Values
315 -- ==========================================================================================
316
317 PROCEDURE create_contact
318 (X_MSG_COUNT IN OUT NOCOPY NUMBER ,
319 X_MSG_DATA IN OUT NOCOPY VARCHAR2 ,
320 X_RETURN_STATUS IN OUT NOCOPY VARCHAR2 ,
321 X_ROW_ID OUT NOCOPY VARCHAR2 ,
322 P_CALLING_MODULE IN VARCHAR2 ,
323 P_API_VERSION_NUMBER IN NUMBER ,
324 P_VALIDATE IN BOOLEAN default TRUE,
325 P_CONTACT_REC IN GMS_AWARDS_CONTACTS%ROWTYPE
326 ) ;
327
328 -- ==========================================================================================
329 -- Create Report
330 --
331 -- CREATE_REPORT
332 -- Create Report is a private API provided to create Report for awards in grants accounting.
333 -- Valid award should be defined. This API is used to transfer Legacy system data into grants
334 -- accounting also.
335 --
336 -- X_MSG_COUNT : Holds no. of messages in the global
337 -- message table
338 -- X_MSG_DATA : Holds the message code, if the API
339 -- returned only one error/warning message
340 -- X_RETURN_STATUS : The indicator of success/Failure
341 -- S- Success, E- and U- Failure
342 -- X_DEFAULT_REPORT_ID : The Unique Record Identifier that is created.
343 -- X_ROW_ID : Record Identifier
344 --
345 -- P_CALLING_MODULE : For Internal Use only. This is exclusively
346 -- reserved by Grants Accounting for future Use.
347 -- P_API_VERSION_NUMBER : Package constant used for package version
348 -- P_VALIDATE : This is for internal Use only. This is used to
349 -- to avoid redundant validations, once we know Input
350 -- data is valid
351 -- P_REPORT_REC : Report Record Which will hold all the Input
352 -- Values
353 -- ==========================================================================================
354
355 PROCEDURE create_report
356 (X_MSG_COUNT IN OUT NOCOPY NUMBER ,
357 X_MSG_DATA IN OUT NOCOPY VARCHAR2 ,
358 X_RETURN_STATUS IN OUT NOCOPY VARCHAR2 ,
359 X_DEFAULT_REPORT_ID IN OUT NOCOPY NUMBER ,
360 X_ROW_ID OUT NOCOPY VARCHAR2 ,
361 P_CALLING_MODULE IN VARCHAR2 ,
362 P_API_VERSION_NUMBER IN NUMBER ,
363 P_VALIDATE IN BOOLEAN default TRUE,
364 P_REPORT_REC IN GMS_DEFAULT_REPORTS%ROWTYPE
365 ) ;
366
367 -- ==========================================================================================
368 -- Create Notification
369 --
370 -- CREATE_NOTIFICATION
371 -- Create Notification is a private API provided to create Notifications for awards in
372 -- grants accounting. This is the API used to transfer Legacy system data into grants
373 -- accounting also.
374 --
375 -- X_MSG_COUNT : Holds no. of messages in the global
376 -- message table
377 -- X_MSG_DATA : Holds the message code, if the API
378 -- returned only one error/warning message
379 -- X_RETURN_STATUS : The indicator of success/Failure
380 -- S- Success, E- and U- Failure
381 -- X_ROW_ID : Record Identifier
382 --
383 -- P_CALLING_MODULE : For Internal Use only. This is exclusively
384 -- reserved by Grants Accounting for future Use.
385 -- P_API_VERSION_NUMBER : Package constant used for package version
386 -- P_VALIDATE : This is for internal Use only. This is used to
387 -- to avoid redundant validations, once we know Input
388 -- data is valid
389 -- P_NOTIFICATION_REC : Notification Record Which will hold all the Input
390 -- Values
391 -- ==========================================================================================
392
393 PROCEDURE create_notification
394 (X_MSG_COUNT IN OUT NOCOPY NUMBER ,
395 X_MSG_DATA IN OUT NOCOPY VARCHAR2 ,
396 X_RETURN_STATUS IN OUT NOCOPY VARCHAR2 ,
397 X_ROW_ID OUT NOCOPY VARCHAR2 ,
398 P_CALLING_MODULE IN VARCHAR2 ,
399 P_API_VERSION_NUMBER IN NUMBER ,
400 P_VALIDATE IN BOOLEAN default TRUE,
401 P_NOTIFICATION_REC IN GMS_NOTIFICATIONS%ROWTYPE
402 ) ;
403
404 -- ======================================================================================
405 -- ADD FUNDING
406 --
407 -- ADD_FUNDING
408 -- Add Funding is a private API provided to create funding from awards in grants
409 -- accounting. This API needs a valid award, and installment defined with positive
410 -- amount to fund. This API is used to transfer Legacy system data into grants
411 -- accounting also.
412 --
413 -- X_MSG_COUNT : Holds no. of messages in the global
414 -- message table
415 -- X_MSG_DATA : Holds the message code, if the API
416 -- returned only one error/warning message
417 -- X_RETURN_STATUS : The indicator of success/Failure
418 -- S- Success, E- and U- Failure
419 -- X_GMS_PROJECT_FUNDING_ID : The Project Funding ID created
420 --
421 -- X_ROW_ID : Record Identifier
422 --
423 -- P_CALLING_MODULE : For Internal Use only. This is exclusively
424 -- reserved by Grants Accounting for future Use.
425 -- P_API_VERSION_NUMBER : Package constant used for package version
426 -- validation
427 -- P_AWARD_ID : Award Identifier from which the funding is done
428 --
429 -- P_INSTALLMENT_ID : Installment Identifier for the above award from
430 -- which funding is done
431 -- P_PROJECT_ID : Project Identifier for which funding is allocated
432 --
433 -- P_TASK_ID : Task Identifier for which funding can be allocated
434 --
435 -- P_AMOUNT : Amount that is allocated for the above project or task
436 --
437 -- P_FUNDING_DATE : Date on which funding is done, between the award dates
438 --
439 -- =======================================================================================
440
441 PROCEDURE ADD_FUNDING
442 (X_MSG_COUNT IN OUT NOCOPY NUMBER ,
443 X_MSG_DATA IN OUT NOCOPY VARCHAR2 ,
444 X_RETURN_STATUS IN OUT NOCOPY VARCHAR2 ,
445 X_GMS_PROJECT_FUNDING_ID IN OUT NOCOPY NUMBER ,
446 X_ROW_ID OUT NOCOPY VARCHAR2 ,
447 P_CALLING_MODULE IN VARCHAR2 ,
448 P_API_VERSION_NUMBER IN NUMBER ,
449 P_AWARD_ID IN NUMBER,
450 P_INSTALLMENT_ID IN NUMBER,
451 P_PROJECT_ID IN NUMBER,
452 P_TASK_ID IN NUMBER,
453 P_AMOUNT IN NUMBER,
454 P_FUNDING_DATE IN DATE
455 );
456
457
458 END GMS_AWARD_PVT ;
[Home] [Help]