[Home] [Help]
PACKAGE: APPS.FEM_FEMAPPR_ITEM_TYPE
Source
1 PACKAGE FEM_FEMAPPR_ITEM_TYPE AS
2 /* $Header: FEMAPPRS.pls 120.1 2006/03/06 20:44:50 nmartine noship $ */
3
4 --------------------------------------------------------------------------------
5 -- PUBLIC CONSTANTS
6 --------------------------------------------------------------------------------
7
8 -- Constants for the Request Items
9 G_BUSINESS_RULE_ITEM constant varchar2(30) := 'BUSINESS_RULE';
10
11 -- Constants for the Request Types
12 G_APPROVAL_TYPE constant varchar2(30) := 'APPROVAL';
13 G_DELETE_TYPE constant varchar2(30) := 'DELETE';
14
15 -- Types and constants for the FEM Approval's Business Events
16 G_BUSINESS_RULE_EVENT_APPROVAL constant varchar2(240) := 'oracle.apps.fem.brbase.event.approval';
17 G_BUSINESS_RULE_EVENT_DELETE constant varchar2(240) := 'oracle.apps.fem.brbase.event.delete';
18
19 -- Item Attributes in the FEM Approvals workflow process
20 G_EVENT_NAME constant varchar2(30) := 'EVENT_NAME';
21 G_EVENT_KEY constant varchar2(30) := 'EVENT_KEY';
22
23 G_ORG_ID constant varchar2(30) := 'ORG_ID';
24 G_USER_ID constant varchar2(30) := 'USER_ID';
25 G_USER_NAME constant varchar2(30) := 'USER_NAME';
26 G_RESPONSIBILITY_ID constant varchar2(30) := 'RESPONSIBILITY_ID';
27 G_APPLICATION_ID constant varchar2(30) := 'APPLICATION_ID';
28
29 G_REQUEST_ID constant varchar2(30) := 'REQUEST_ID';
30 G_REQUEST_ITEM_CODE constant varchar2(30) := 'REQUEST_ITEM_CODE';
31 G_REQUEST_ITEM constant varchar2(30) := 'REQUEST_ITEM';
32 G_REQUEST_TYPE_CODE constant varchar2(30) := 'REQUEST_TYPE_CODE';
33 G_REQUEST_TYPE constant varchar2(30) := 'REQUEST_TYPE';
34 G_REQUEST_DATE constant varchar2(30) := 'REQUEST_DATE';
35
36 G_APPROVER_ID constant varchar2(30) := 'APPROVER_ID';
37 G_APPROVER_USER_ID constant varchar2(30) := 'APPROVER_USER_ID';
38 G_APPROVER_NAME constant varchar2(30) := 'APPROVER_NAME';
39 G_APPROVER_DISPLAY_NAME constant varchar2(30) := 'APPROVER_DISPLAY_NAME';
40 G_APPROVER_ORIG_SYSTEM constant varchar2(30) := 'APPROVER_ORIG_SYSTEM';
41 G_SUBMITTER_ID constant varchar2(30) := 'SUBMITTER_ID';
42 G_SUBMITTER_NAME constant varchar2(30) := 'SUBMITTER_NAME';
43 G_SUBMITTER_DISPLAY_NAME constant varchar2(30) := 'SUBMITTER_DISPLAY_NAME';
44 G_SUBMITTER_ORIG_SYSTEM constant varchar2(30) := 'SUBMITTER_ORIG_SYSTEM';
45 G_ROLE_NAME constant varchar2(30) := 'ROLE_NAME';
46
47 G_AME_AUTHORITY constant varchar2(30) := 'AME_AUTHORITY';
48 G_AME_API_INSERTION constant varchar2(30) := 'AME_API_INSERTION';
49 G_AME_APPROVAL_TYPE_ID constant varchar2(30) := 'AME_APPROVAL_TYPE_ID';
50 G_AME_GROUP_OR_CHAIN_ID constant varchar2(30) := 'AME_GROUP_OR_CHAIN_ID';
51 G_AME_OCCURRENCE constant varchar2(30) := 'AME_OCCURRENCE';
52
53 G_ITEM_PLSQL_PKG_NAME constant varchar2(30) := 'ITEM_PLSQL_PKG_NAME';
54 G_JUSTIFICATION constant varchar2(30) := 'JUSTIFICATION';
55
56
57
58 --------------------------------------------------------------------------------
59 -- PUBLIC SPECIFICATIONS
60 --------------------------------------------------------------------------------
61
62 --
63 -- FUNCTION
64 -- CreateWfRequestRow
65 --
66 -- DESCRIPTION
67 -- PL/SQL API for creating a row in the FEM_WF_REQUESTS table. Used for
68 -- raising FEM Business Events.
69 --
70 -- IN
71 -- p_request_item_code - Request Item Code (ie: BUSINESS_RULE)
72 -- p_request_type_code - Request Type Code (ie: APPROVAL, DELETE)
73 --
74 -- RETURN
75 -- wf_request_id - Workflow Request Id
76 --
77 --------------------------------------------------------------------------------
78 FUNCTION CreateWfRequestRow (
79 p_request_item_code in varchar2
80 ,p_request_type_code in varchar2
81 )
82 RETURN number;
83
84 --
85 -- PROCEDURE
86 -- RaiseEvent
87 --
88 -- DESCRIPTION
89 -- PL/SQL API for Raising any FEM Business Events
90 --
91 -- IN
92 -- p_event_name - Business Event Name
93 -- p_request_id - Workflow Request Id (FEM_WF_REQUEST_ID_SEQ)
94 -- p_user_id - FND User ID
95 -- p_user_name - FND User Name
96 -- p_responsibility_id - FND Responsibility ID
97 -- p_application_id - FND Application ID
98 -- p_org_id - FND Organization ID
99 --
100 PROCEDURE RaiseEvent (
101 p_event_name in varchar2,
102 p_request_id in number,
103 p_user_id in number,
104 p_user_name in varchar2,
105 p_responsibility_id in number,
106 p_application_id in number,
107 p_org_id in number
108 );
109
110 --
111 -- PROCEDURE
112 -- InitApprovalRequest
113 --
114 -- DESCRIPTION
115 -- Initializes the all the item attributes of an FEM Approvals Workflow.
116 --
117 -- IN
118 -- p_item_type - The workflow item type (FEMAPPR)
119 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
120 -- p_act_id - The function activity
121 -- p_func_mode - Run/Cancel/Timeout
122 --
123 -- OUT
124 -- x_result_out - Indicates completion of workflow activity and it's result
125 --
126 -- USED BY ACTIVITIES
127 -- FEMAPPR FEM_INIT_APPROVAL_REQ
128 --
129 PROCEDURE InitApprovalRequest (
130 p_item_type in varchar2,
131 p_item_key in varchar2,
132 p_act_id in number,
133 p_func_mode in varchar2,
134 x_result_out out nocopy varchar2
135 );
136
137 --
138 -- PROCEDURE
139 -- CheckApprovalItems
140 --
141 -- DESCRIPTION
142 -- Checks to see if this approval request contains approval items.
143 --
144 -- IN
145 -- p_item_type - The workflow item type (FEMAPPR)
146 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
147 -- p_act_id - The function activity
148 -- p_func_mode - Run/Cancel/Timeout
149 --
150 -- OUT
151 -- x_result_out - Indicates completion of workflow activity and it's result
152 --
153 -- USED BY ACTIVITIES
154 -- FEMAPPR FEM_CHECK_APPROVAL_ITEMS
155 --
156 PROCEDURE CheckApprovalItems (
157 p_item_type in varchar2,
158 p_item_key in varchar2,
159 p_act_id in number,
160 p_func_mode in varchar2,
161 x_result_out out nocopy varchar2
162 );
163
164 --
165 -- PROCEDURE
166 -- InitApprovalItems
167 --
168 -- DESCRIPTION
169 -- Initializes all the approval items.
170 --
171 -- IN
172 -- p_item_type - The workflow item type (FEMAPPR)
173 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
174 -- p_act_id - The function activity
175 -- p_func_mode - Run/Cancel/Timeout
176 --
177 -- OUT
178 -- x_result_out - Indicates completion of workflow activity and it's result
179 --
180 -- USED BY ACTIVITIES
181 -- FEMAPPR FEM_INIT_APPROVAL_ITEMS
182 --
183 PROCEDURE InitApprovalItems (
184 p_item_type in varchar2,
185 p_item_key in varchar2,
186 p_act_id in number,
187 p_func_mode in varchar2,
188 x_result_out out nocopy varchar2
189 );
190
191 --
192 -- PROCEDURE
193 -- GetNextApprover
194 --
195 -- DESCRIPTION
196 -- Gets the next approver for the approval request.
197 --
198 -- IN
199 -- p_item_type - The workflow item type (FEMAPPR)
200 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
201 -- p_act_id - The function activity
202 -- p_func_mode - Run/Cancel/Timeout
203 --
204 -- OUT
205 -- x_result_out - Indicates completion of workflow activity and it's result
206 --
207 -- USED BY ACTIVITIES
208 -- FEMAPPR FEM_GET_NEXT_APPROVER
209 --
210 PROCEDURE GetNextApprover (
211 p_item_type in varchar2,
212 p_item_key in varchar2,
213 p_act_id in number,
214 p_func_mode in varchar2,
215 x_result_out out nocopy varchar2
216 );
217
218 --
219 -- PROCEDURE
220 -- UpdateApprovalApproved
221 --
222 -- DESCRIPTION
223 -- Update the approval request with the approved response from the current
224 -- approver.
225 --
226 -- IN
227 -- p_item_type - The workflow item type (FEMAPPR)
228 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
229 -- p_act_id - The function activity
230 -- p_func_mode - Run/Cancel/Timeout
231 --
232 -- OUT
233 -- x_result_out - Indicates completion of workflow activity and it's result
234 --
235 -- USED BY ACTIVITIES
236 -- FEMAPPR FEM_UPDATE_APPROVAL_APPROVED
237 --
238 PROCEDURE UpdateApprovalApproved (
239 p_item_type in varchar2,
240 p_item_key in varchar2,
241 p_act_id in number,
242 p_func_mode in varchar2,
243 x_result_out out nocopy varchar2
244 );
245
246 --
247 -- PROCEDURE
248 -- UpdateApprovalRejected
249 --
250 -- DESCRIPTION
251 -- Update the approval request with the rejected response from the current
252 -- approver.
253 --
254 -- IN
255 -- p_item_type - The workflow item type (FEMAPPR)
256 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
257 -- p_act_id - The function activity
258 -- p_func_mode - Run/Cancel/Timeout
259 --
260 -- OUT
261 -- x_result_out - Indicates completion of workflow activity and it's result
262 --
263 -- USED BY ACTIVITIES
264 -- FEMAPPR FEM_UPDATE_APPROVAL_REJECTED
265 --
266 PROCEDURE UpdateApprovalRejected (
267 p_item_type in varchar2,
268 p_item_key in varchar2,
269 p_act_id in number,
270 p_func_mode in varchar2,
271 x_result_out out nocopy varchar2
272 );
273
274 --
275 -- PROCEDURE
276 -- UpdateApprovalNoResponse
277 --
278 -- DESCRIPTION
279 -- Update the approval request to indicate the lack of response from the
280 -- current approver.
281 --
282 -- IN
283 -- p_item_type - The workflow item type (FEMAPPR)
284 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
285 -- p_act_id - The function activity
286 -- p_func_mode - Run/Cancel/Timeout
287 --
288 -- OUT
289 -- x_result_out - Indicates completion of workflow activity and it's result
290 --
291 -- USED BY ACTIVITIES
292 -- FEMAPPR FEM_UPDATE_APPROVAL_NO_RESP
293 --
294 PROCEDURE UpdateApprovalNoResponse (
295 p_item_type in varchar2,
296 p_item_key in varchar2,
297 p_act_id in number,
298 p_func_mode in varchar2,
299 x_result_out out nocopy varchar2
300 );
301
302 --
303 -- PROCEDURE
304 -- ApprovalRequestHandler
305 --
306 -- DESCRIPTION
307 -- Notification Handler for FEM_APPROVAL_REQ_NTF.
308 --
309 -- IN
310 -- p_item_type - The workflow item type (FEMAPPR)
311 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
312 -- p_act_id - The function activity
313 -- p_func_mode - Run/Cancel/Timeout
314 --
315 -- OUT
316 -- x_result_out - Indicates completion of workflow activity and it's result
317 --
318 -- USED BY ACTIVITIES
319 -- FEMAPPR FEM_APPROVAL_REQ_NTF
320 --
321 PROCEDURE ApprovalRequestHandler (
322 p_item_type in varchar2,
323 p_item_key in varchar2,
324 p_act_id in number,
325 p_func_mode in varchar2,
326 x_result_out out nocopy varchar2
327 );
328
329 --
330 -- PROCEDURE
331 -- SetSubmittedState
332 --
333 -- DESCRIPTION
334 -- Sets the approval items to the submitted state.
335 --
336 -- IN
337 -- p_item_type - The workflow item type (FEMAPPR)
338 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
339 -- p_act_id - The function activity
340 -- p_func_mode - Run/Cancel/Timeout
341 --
342 -- OUT
343 -- x_result_out - Indicates completion of workflow activity and it's result
344 --
345 -- USED BY ACTIVITIES
346 -- FEMAPPR FEM_SET_SUBMITTED_STATE
347 --
348 PROCEDURE SetSubmittedState (
349 p_item_type in varchar2,
350 p_item_key in varchar2,
351 p_act_id in number,
352 p_func_mode in varchar2,
353 x_result_out out nocopy varchar2
354 );
355
356 --
357 -- PROCEDURE
358 -- SetApprovedState
359 --
360 -- DESCRIPTION
361 -- Sets the approval items to the approved state.
362 --
363 -- IN
364 -- p_item_type - The workflow item type (FEMAPPR)
365 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
366 -- p_act_id - The function activity
367 -- p_func_mode - Run/Cancel/Timeout
368 --
369 -- OUT
370 -- x_result_out - Indicates completion of workflow activity and it's result
371 --
372 -- USED BY ACTIVITIES
373 -- FEMAPPR FEM_SET_APPROVED_STATE
374 --
375 PROCEDURE SetApprovedState (
376 p_item_type in varchar2,
377 p_item_key in varchar2,
378 p_act_id in number,
379 p_func_mode in varchar2,
380 x_result_out out nocopy varchar2
381 );
382
383 --
384 -- PROCEDURE
385 -- SetRejectedState
386 --
387 -- DESCRIPTION
388 -- Sets the approval items to the rejected state.
389 --
390 -- IN
391 -- p_item_type - The workflow item type (FEMAPPR)
392 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
393 -- p_act_id - The function activity
394 -- p_func_mode - Run/Cancel/Timeout
395 --
396 -- OUT
397 -- x_result_out - Indicates completion of workflow activity and it's result
398 --
399 -- USED BY ACTIVITIES
400 -- FEMAPPR FEM_SET_REJECTED_STATE
401 --
402 PROCEDURE SetRejectedState (
403 p_item_type in varchar2,
404 p_item_key in varchar2,
405 p_act_id in number,
406 p_func_mode in varchar2,
407 x_result_out out nocopy varchar2
408 );
409
410 --
411 -- PROCEDURE
412 -- ApprovedStateFailure
413 --
414 -- DESCRIPTION
415 -- Handles the case when SetApprovedState fails.
416 --
417 -- IN
418 -- p_item_type - The workflow item type (FEMAPPR)
419 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
420 -- p_act_id - The function activity
421 -- p_func_mode - Run/Cancel/Timeout
422 --
423 -- OUT
424 -- x_result_out - Indicates completion of workflow activity and it's result
425 --
426 -- USED BY ACTIVITIES
427 -- FEMAPPR FEM_APPROVED_STATE_FAILURE
428 --
429 PROCEDURE ApprovedStateFailure (
430 p_item_type in varchar2,
431 p_item_key in varchar2,
432 p_act_id in number,
433 p_func_mode in varchar2,
434 x_result_out out nocopy varchar2
435 );
436
437 --
438 -- PROCEDURE
439 -- FinalizeApprovalRequest
440 --
441 -- DESCRIPTION
442 -- Finalizes the approval request.
443 --
444 -- IN
445 -- p_item_type - The workflow item type (FEMAPPR)
446 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
447 -- p_act_id - The function activity
448 -- p_func_mode - Run/Cancel/Timeout
449 --
450 -- OUT
451 -- x_result_out - Indicates completion of workflow activity and it's result
452 --
453 -- USED BY ACTIVITIES
454 -- FEMAPPR FEM_FINALIZE_APPROVAL_REQ
455 --
456 PROCEDURE FinalizeApprovalRequest (
457 p_item_type in varchar2,
458 p_item_key in varchar2,
459 p_act_id in number,
460 p_func_mode in varchar2,
461 x_result_out out nocopy varchar2
462 );
463
464 --
465 -- PROCEDURE
466 -- CallbackFunction
467 --
468 -- DESCRIPTION
469 -- Callback function.
470 --
471 -- IN
472 -- p_item_type - The workflow item type (FEMAPPR)
473 -- p_item_key - The workflow request id (FEM_WF_REQUEST_ID_SEQ)
474 -- p_act_id - The function activity
475 -- p_func_mode - Run/Cancel/Timeout
476 --
477 -- OUT
478 -- x_result_out - Indicates completion of workflow activity and it's result
479 --
480 -- USED BY ACTIVITIES
481 -- FEMAPPR
482 --
483 PROCEDURE CallbackFunction (
484 p_item_type in varchar2,
485 p_item_key in varchar2,
486 p_act_id in number,
487 p_command in varchar2,
488 x_result_out out nocopy varchar2
489 );
490
491
492
493 END FEM_FEMAPPR_ITEM_TYPE;