DBA Data[Home] [Help]

PACKAGE: APPS.GMS_PA_API3

Source


1 PACKAGE gms_pa_api3 AS
2 /* $Header: gmspax3s.pls 120.4 2008/01/24 08:59:51 prabsing ship $ */
3 
4       -- =====================
5       -- Start of the comment
6       -- API Name 	: grants_enabled
7       -- Type		: Public
8       -- Pre_reqs	: None
9       -- Description	: Determine the grants implementations for a
10       --                  operating unit. The value returned here is
11       --                  from the cache.
12       -- Parameters     : None
13       -- Return Value   : 'Y' - Grants is implemented for a MO Org.
14       --                  'N'- Grants is not implemented.
15       --
16       -- End of comments
17       -- ===============
18 
19       FUNCTION grants_enabled return VARCHAR  ;
20       --pjr12ir1 build issue resolved.
21       --pragma RESTRICT_REFERENCES (grants_enabled, WNDS, WNPS );
22 
23       -- =====================
24       -- Start of the comment
25       -- API Name 	: override_rate_rev_id
26       -- Type		: Public
27       -- Pre_reqs	: None
28       -- Description	: The purpose of this API is to determine
29       --                  the schedule based on the award.
30       -- Called from    : PA_COST_PLUS.find_rate_sch_rev_id
31       -- Return Value   : None
32       --
33       -- Parameters     :
34       -- IN             :
35       --                  p_tran_item_id    Expenditure item id
36       --                  p_tran_type       Transaction type
37       --                  p_task_id         Task ID
38       --                  p_schedule_type   Schedule Type
39       --                  p_exp_item_date   Expenditure item date
40       --OUT               x_sch_fixed_date  Schedule fixed date.
41       --                  x_rate_sch_rev_id Revision ID
42       --                  x_status          Status
43       -- End of comments
44       -- ===============
45 
46       PROCEDURE override_rate_rev_id(
47                            p_tran_item_id          IN         number   DEFAULT NULL,
48                            p_tran_type             IN         Varchar2 DEFAULT NULL,
49                            p_task_id         	   IN         number   DEFAULT NULL,
50                            p_schedule_type         IN         Varchar2 DEFAULT NULL,
51                            p_exp_item_date         IN         Date     DEFAULT NULL,
52                            x_sch_fixed_date        IN OUT nocopy Date,
53                            x_rate_sch_rev_id 	   OUT nocopy number,
54                            x_status                OUT nocopy number ) ;
55 
56          --- pragma RESTRICT_REFERENCES (override_rate_rev_id, WNDS, WNPS ); /* commented as per 3786374 */
57 
58       -- =====================
59       -- Start of the comment
60       -- API Name 	: commitments_changed
61       -- Type		: Public
62       -- Pre_reqs	: None
63       -- Description	: The purpose of this API is to determine
64       --                  the new manual encumbrances generated
65       --                  since the last run of PSI process.
66       -- Called from    : PA_CHECK_COMMITMENTS.COMMITMENTS_CHANGED
67       -- Return Value   : Y
68       --                  N
69       --
70       -- Parameters     :
71       -- IN             :
72       --                  p_project_id    Project ID value
73       -- End of comments
74       -- ===============
75       -- REL12 commitments changed was removed.
76       -- merged in pa_check_commitments (PAXCMTVB.pls)
77 
78       -- =====================
79       -- Start of the comment
80       -- API Name       : is_award_same
81       -- Type           : Public
82       -- Pre_reqs       : None
83       -- Description    : The purpose of this API is to compare the award entered by the user in expenditure
84       --                  entry form and the award for the reversal item found is same or not.
85       -- Called from    : exp_items_private.check_matching_reversal
86       -- Return Value   : Y
87       --                  N
88       --
89       -- Parameters     :
90       -- IN             :
91       --                  expenditure_item_id  Item id of matching reversal item
92       --                  award_number         Award Number entered in expenidture entry form.
93       -- End of comments
94       -- ===============
95          FUNCTION is_award_same (P_expenditure_item_id IN NUMBER,P_award_number IN VARCHAR2 )
96            RETURN VARCHAR2 ;
97 
98       -- =====================
99       -- Start of the comment
100       -- API Name       : create_cmt_txns
101       -- Type           : Public
102       -- Pre_reqs       : None
103       -- Description    : The purpose of this API is to create commitment transactions
104       --                  using the GMS view and called from the PSI process .
105       -- Called from    : PA_TXN_ACCUMS.create_cmt_txns
106       -- Return Value   : None
107       --
108       -- Parameters     :
109       -- IN             :
110       --                  p_start_project_id         Starting project id in the range.
111       --                  p_end_project_id           Last project id in the range.
112       --                  p_system_linkage_function  System Linkage function
113       -- End of comments
114       -- ===============
115          PROCEDURE create_cmt_txns ( p_start_project_id     IN NUMBER,
116 				     p_end_project_id       IN NUMBER,
117 				     p_system_linkage_function IN VARCHAR2 ) ;
118 
119       -- =====================
120       -- Start of the comment
121       -- API Name       : is_project_type_sponsored
122       -- Type           : Public
123       -- Pre_reqs       : None
124       -- Description    : The purpose of this API is to check if project type is
125       --                  marked as sponsored in Grants Accounting.
126       -- Called from    :  project type entry and project entry form
127       -- Return Value   : Y - Yes
128       --                  N - No
129       --
130       -- Parameters     :
131       -- IN             :
132       --                  p_project_type          varchar2
133       -- End of comments
134       -- ===============
135          FUNCTION is_project_type_sponsored ( p_project_type     IN VARCHAR2 )
136 	 return varchar2 ;
137 	 PRAGMA RESTRICT_REFERENCES(is_project_type_sponsored , WNDS, WNPS) ;
138 
139       -- Bug 5726575
140       -- =====================
141       -- Start of the comment
142       -- API Name       : mark_impacted_enc_items
143       -- Type           : Public
144       -- Pre_reqs       : None
145       -- Description    : This procedure is called from
146       --                  pa_cost_plus.mark_impacted_exp_items (PAXCCPEB.pls).
147       --                  This procedure will mark all the burden impacted lines
148       --                  in gms_encumbrance_items_all.
149       --
150       -- Called from    : pa_cost_plus.mark_impacted_exp_items
151       -- Return Value   : None
152       --
153       -- Parameters     :
154       -- IN             :p_ind_compiled_set_id
155       --                 p_g_impacted_cost_bases
156       --                 p_g_cp_structure
157       --                 p_indirect_cost_code
158       --                 p_rate_sch_rev_id
159       --                 p_g_rate_sch_rev_id
160       --                 p_g_org_id
161       --                 p_g_org_override
162       -- OUT            :errbuf
163       --                 retcode
164       -- End of comments
165       -- ===============
166 
167       Procedure mark_impacted_enc_items (p_ind_compiled_set_id in number,
168                                          p_g_impacted_cost_bases in varchar2,
169                                          p_g_cp_structure in varchar2,
170                                          p_indirect_cost_code in varchar2,
171                                          p_rate_sch_rev_id in number,
172                                          p_g_rate_sch_rev_id in number,
173                                          p_g_org_id in number,
174                                          p_g_org_override in number,
175                                          errbuf OUT NOCOPY VARCHAR2,
176                                          retcode OUT NOCOPY     VARCHAR2);
177 
178       -- Bug 5726575
179       -- =====================
180       -- Start of the comment
181       -- API Name       : mark_prev_rev_enc_items
182       -- Type           : Public
183       -- Pre_reqs       : None
184       -- Description    : This procedure is called from
185       --                  pa_cost_plus.mark_prev_rev_exp_items (PAXCCPEB.pls).
186       --                  This procedure will mark all the burden impacted lines
187       --                  in gms_encumbrance_items_all.
188       --
189       -- Called from    : pa_cost_plus.mark_prev_rev_exp_items
190       -- Return Value   : None
191       --
192       -- Parameters     :
193       -- IN             :p_compiled_set_id
194       --                 p_start_date
195       --                 p_end_date
196       --                 p_mode
197       -- OUT            :errbuf
198       --                 retcode
199       -- End of comments
200       -- ===============
201       Procedure mark_prev_rev_enc_items (p_compiled_set_id in number,
202                                          p_start_date in date,
203                                          p_end_date in date,
204                                          p_mode in varchar2,
205                                          errbuf OUT NOCOPY VARCHAR2,
206                                          retcode OUT NOCOPY     VARCHAR2);
207 
208       -- Bug 6761516
209       -- =====================
210       -- Start of the comment
211       -- API Name       : mark_enc_items_for_recalc
212       -- Type           : Public
213       -- Pre_reqs       : None
214       -- Description    : This procedure is called from
215       --                  GMSAWEAW.fmb and GMSICOVR.fmb.
216       --                  This procedure will mark all the associated encumbrance items for recalc
217       --                  on insertion, uodation or deletion in Award Management Compliance Screen
218       --                  or in Override Schedules Screen.
219       --
220       -- Called from    : GMSAWEAW.fmb and GMSICOVR.fmb
221       -- Return Value   : None
222       --
223       -- Parameters     :
224       -- IN             :p_ind_rate_sch_id
225       --                 p_award_id
226       --                 p_project_id
227       --                 p_task_id
228       --                 p_calling_form
229       --                 p_event
230       --                 p_idc_schedule_fixed_date
231       -- OUT            :errbuf
232       --                 retcode
233       -- End of comments
234       -- ===============
235     Procedure mark_enc_items_for_recalc (p_ind_rate_sch_id in number,
236                                          p_award_id in number,
237                                          p_project_id in number,
238                                          p_task_id in number,
239                                          p_calling_form in varchar2,
240                                          p_event in varchar2,
241                                          p_idc_schedule_fixed_date in date,
242                                          errbuf OUT NOCOPY VARCHAR2,
243                                          retcode OUT NOCOPY     VARCHAR2);
244 
245 
246       -- Bug 6761516
247       -- =====================
248       -- Start of the comment
249       -- API Name 	: item_task_validate
250       -- Type		: Public
251       -- Pre_reqs	: None
252       -- Description	: This function is called from mark_enc_items_for_recalc
253       --                  to perform item validations.
254       --                  1. If record being inserted/updated/deleted from overrides schedule
255       --                     screen does not have task details, then this function returns 'N'
256       --                     if any other override exists for same project, award ,top_task for
257       --                     the task of enc. in picture combination, else returns 'Y'
258       --                  2. If record being inserted/updated/deleted from overrides schedule
259       --                     screen has task details, then just match the top task of the enc.
260       --                     in picture with the task on the record.
261       -- Parameters     : p_award_id number,
262       --                  p_project_id number,
263       --                  p_task_id number,
264       --                  p_item_task_id number
265       -- Return Value   : 'Y' - Encumbrance needs to be marked for recalc.
266       --                  'N' - Encumbrance should not be marked for recalc.
267       --
268       -- End of comments
269       -- ===============
270     Function item_task_validate (p_award_id number,
271                                  p_project_id number,
272                                  p_task_id number,
273                                  p_item_task_id number)
274     return varchar2;
275 
276 END gms_pa_api3;