1 package FND_WEBATTCH AUTHID CURRENT_USER as
2 /* $Header: AFATCHMS.pls 120.5.12020000.2 2012/08/30 17:57:19 ctilley ship $ */
3
4
5 -- GetSummaryStatus
6 -- IN
7 -- function_name - Function name of the web function
8 -- entity_name - Entity name to which the attachment is made.
9 -- pk1_value - First primary key of the entity.
10 -- through
11 -- pk5_value - Fifth primary key value of the entity.
12 -- attchmt_status - Indicates Attachment Status -
13 -- EMPTY, FULL, DISABLED.
14 --
15 procedure GetSummaryStatus (
16 x_function_name in varchar2,
17 x_entity_name in varchar2,
18 x_pk1_value in varchar2,
19 x_pk2_value in varchar2 default NULL,
20 x_pk3_value in varchar2 default NULL,
21 x_pk4_value in varchar2 default NULL,
22 x_pk5_value in varchar2 default NULL,
23 attchmt_status out NOCOPY varchar2
24 );
25
26 -- GetSummaryList
27 -- IN
28 -- attchmt_status - Indicates Attachment Status -
29 -- EMPTY, FULL, DISABLED.
30 -- URL - URL string to linked to the attachment button.
31 -- from_url - URL from which the attachments is invoked from.
32 -- This is required to set the back link.
33 -- query_only - Query flag is set 'Y' when called in query only
34 -- mode.
35 --
36
37 procedure GetSummaryList(
38 attchmt_status in varchar2 default 'DISABLED', -- Bug 1850949 - added default value
39 from_url in varchar2,
40 query_only in varchar2 default 'N',
41 package_name in varchar2 default 'FND_WEBATTCH',
42 URL out NOCOPY varchar2
43 );
44
45 --
46 -- Summary
47 -- Construct the list of attachments for an entity.
48 -- IN
49 -- function_name - Function name of the web function
50 -- entity_name - Entity name to which the attachment is made.
51 -- pk1_value - First primary key of the entity.
52 -- through
53 -- pk5_value - Fifth primary key value of the entity.
54 -- from_url - URL from which the attachments is invoked from.
55 -- This is required to set the back link.
56 -- query_only - Query flag is set 'Y' when called in query only
57 -- mode.
58 --
59
60 procedure Summary(
61 function_name in varchar2,
62 entity_name in varchar2,
63 pk1_value in varchar2,
64 pk2_value in varchar2 default NULL,
65 pk3_value in varchar2 default NULL,
66 pk4_value in varchar2 default NULL,
67 pk5_value in varchar2 default NULL,
68 from_url in varchar2,
69 query_only in varchar2 default 'N'
70 );
71
72 --
73 -- UpdateAttachment
74 -- Display the attachment information for update.
75 -- IN
76 -- attached_document_id
77 -- function_name - Function name of the web function
78 -- entity_name - Entity name to which the attachment is made.
79 -- pk1_value - First primary key of the entity.
80 -- through
81 -- pk5_value - Fifth primary key value of the entity.
82 -- from_url - URL from which the attachments is invoked from.
83 -- This is required to set the back link.
84 -- query_only - Query flag is set 'Y' when called in query only
85 -- mode.
86 --
87
88 procedure UpdateAttachment(
89 attached_document_id in varchar2,
90 function_name in varchar2,
91 entity_name in varchar2,
92 pk1_value in varchar2,
93 pk2_value in varchar2 default NULL,
94 pk3_value in varchar2 default NULL,
95 pk4_value in varchar2 default NULL,
96 pk5_value in varchar2 default NULL,
97 from_url in varchar2,
98 query_only in varchar2 default 'N'
99 );
100
101 --
102 -- DeleteAttachment
103 -- Deletes the attachment and document.
104 -- IN
105 -- attached_document_id
106 -- function_name - Function name of the web function
107 -- entity_name - Entity name to which the attachment is made.
108 -- pk1_value - First primary key of the entity.
109 -- through
110 -- pk5_value - Fifth primary key value of the entity.
111 -- from_url - URL from which the attachments is invoked from.
112 -- This is required to set the back link.
113 -- query_only - Query flag is set 'Y' when called in query only
114 -- mode.
115 --
116
117 procedure DeleteAttachment(
118 attached_document_id in varchar2,
119 function_name in varchar2,
120 entity_name in varchar2,
121 pk1_value in varchar2,
122 pk2_value in varchar2 default NULL,
123 pk3_value in varchar2 default NULL,
124 pk4_value in varchar2 default NULL,
125 pk5_value in varchar2 default NULL,
126 from_url in varchar2,
127 query_only in varchar2 default 'N'
128 );
129
130 -- AddAttachment
131 -- Creates an attachment and document.
132 -- IN
133 -- function_name - Function name of the web function
134 -- entity_name - Entity name to which the attachment is made.
135 -- pk1_value - First primary key of the entity.
136 -- through
137 -- pk5_value - Fifth primary key value of the entity.
138 -- from_url - URL from which the attachments is invoked from.
139 -- This is required to set the back link.
140 -- query_only - Query flag is set 'Y' when called in query only
141 -- mode.
142 --
143
144 procedure AddAttachment(
145 function_name in varchar2,
146 entity_name in varchar2,
147 pk1_value in varchar2,
148 pk2_value in varchar2 default NULL,
149 pk3_value in varchar2 default NULL,
150 pk4_value in varchar2 default NULL,
151 pk5_value in varchar2 default NULL,
152 from_url in varchar2,
153 query_only in varchar2 default 'N'
154 );
155
156 -- ViewTextDocument
157 -- View the document information of an attachment.
158 -- IN
159 -- attached_document_id - Reference to the attached document
160 -- function_name - Function name of the web function
161 -- entity_name - Entity name to which the attachment is made.
162 -- pk1_value - First primary key of the entity.
163 -- through
164 -- pk5_value - Fifth primary key value of the entity.
165 -- from_url - URL from which the attachments is invoked from.
166 -- This is required to set the back link.
167 -- query_only - Query flag is set 'Y' when called in query only
168 -- mode.
169 --
170
171 procedure ViewTextDocument(
172 attached_document_id in varchar2,
173 function_name in varchar2 ,
174 entity_name in varchar2 ,
175 pk1_value in varchar2 ,
176 pk2_value in varchar2 default NULL,
177 pk3_value in varchar2 default NULL,
178 pk4_value in varchar2 default NULL,
179 pk5_value in varchar2 default NULL,
180 from_url in varchar2,
181 query_only in varchar2 default 'N'
182 );
183
184 -- ViewFileDocument
185 -- Displays the file document.
186 -- IN
187 -- attached_document_id - Unique id for an attachment.
188 --
189
190 procedure ViewFileDocument (
191 attached_document_id in varchar2
192 );
193
194 PROCEDURE add_attachment_gfm_wrapper(
195 access_id NUMBER,
196 seq_num VARCHAR2 ,
197 category_id VARCHAR2,
198 document_description VARCHAR2,
199 datatype_id VARCHAR2,
200 text VARCHAR2 DEFAULT NULL,
201 file_name VARCHAR2 DEFAULT NULL,
202 url VARCHAR2 DEFAULT NULL,
203 function_name VARCHAR2 DEFAULT NULL,
204 entity_name VARCHAR2 DEFAULT NULL,
205 pk1_value VARCHAR2 DEFAULT NULL,
206 pk2_value VARCHAR2 DEFAULT NULL,
207 pk3_value VARCHAR2 DEFAULT NULL,
208 pk4_value VARCHAR2 DEFAULT NULL,
209 pk5_value VARCHAR2 DEFAULT NULL,
210 from_url VARCHAR2 DEFAULT NULL,
211 query_only VARCHAR2 DEFAULT NULL,
212 user_id VARCHAR2 DEFAULT NULL,
213 dmid VARCHAR2 DEFAULT NULL,
214 dmname VARCHAR2 DEFAULT NULL,
215 package_name VARCHAR2 DEFAULT 'FND_WEBATTCH',
216 dm_node in number DEFAULT NULL,
217 dm_folder_path in varchar2 DEFAULT NULL,
218 dm_type in varchar2 DEFAULT NULL,
219 dm_document_id in number DEFAULT NULL,
220 dm_version_number in varchar2 DEFAULT NULL,
221 title in varchar2 DEFAULT NULL
222 );
223
224 -- Add_Attachment
225 -- IN
226 -- seq_num - Attachment Seq Number.
227 -- category_description
228 -- document_description
229 -- datatype_name - Datatype identifier
230 -- document_text - Document Text Input.
231 -- file_name - File name
232 -- URL - URL
233 -- function_name --Function name of the form
234 -- entity_name - Entity name for which attachment is made.
235 -- pk1_value - First Primary Key value of the entity.
236 -- to
237 -- pk5_value - Fifth Primary key value of the entity.
238 -- media_id - Document reference.
239 -- usage_type - One-time, Standard, Template
240
241 procedure Add_Attachment (
242 seq_num in varchar2 ,
243 category_id in varchar2 ,
244 document_description in varchar2 ,
245 datatype_id in varchar2 ,
246 text in CLOB ,
247 file_name in varchar2 ,
248 url in varchar2 ,
249 function_name in varchar2 ,
250 entity_name in varchar2 ,
251 pk1_value in varchar2 ,
252 pk2_value in varchar2 ,
253 pk3_value in varchar2 ,
254 pk4_value in varchar2 ,
255 pk5_value in varchar2 ,
256 media_id in number ,
257 user_id in varchar2 ,
258 usage_type in varchar2 DEFAULT 'O' ,
259 title in varchar2 DEFAULT NULL ,
260 dm_node in number DEFAULT NULL ,
261 dm_folder_path in varchar2 DEFAULT NULL ,
262 dm_type in varchar2 DEFAULT NULL ,
263 dm_document_id in number DEFAULT NULL ,
264 dm_version_number in varchar2 DEFAULT NULL
265 );
266
267 PROCEDURE update_attachment_gfm_wrapper(
268 seq_num varchar2,
269 category_id varchar2,
270 document_description varchar2 DEFAULT NULL,
271 text varchar2 DEFAULT NULL,
272 file_name varchar2 DEFAULT NULL,
273 url varchar2 DEFAULT NULL,
274 attached_document_id varchar2 DEFAULT NULL,
275 datatype_id varchar2,
276 function_name varchar2 DEFAULT NULL,
277 entity_name varchar2 DEFAULT NULL,
278 pk1_value varchar2 DEFAULT NULL,
279 pk2_value varchar2 DEFAULT NULL,
280 pk3_value varchar2 DEFAULT NULL,
281 pk4_value varchar2 DEFAULT NULL,
282 pk5_value varchar2 DEFAULT NULL,
283 from_url varchar2 DEFAULT NULL,
284 query_only varchar2 DEFAULT NULL,
285 dmid VARCHAR2 DEFAULT NULL,
286 dmname VARCHAR2 DEFAULT NULL,
287 package_name VARCHAR2 DEFAULT 'FND_WEBATTCH',
288 dm_node NUMBER DEFAULT NULL,
289 dm_folder_path VARCHAR2 DEFAULT NULL,
290 dm_type VARCHAR2 DEFAULT NULL,
291 dm_document_id NUMBER DEFAULT NULL,
292 dm_version_number VARCHAR2 DEFAULT NULL,
293 title VARCHAR2 DEFAULT NULL
294 );
295
296 -- Update_Attachment
297 -- IN
298 -- seq_num - Attachment Seq Number.
299 -- category_id
300 -- document_description
301 -- datatype_id - Datatype identifier
302 -- document_text - Document Text Input.
303 -- file_name - File name
304 -- URL - URL
305 -- attached_document_id
306 -- function_name - Function name of the form
307 -- entity_name - Entity name for which attachment is made.
308 -- pk1_value - First Primary Key value of the entity.
309 -- to
310 -- pk5_value - Fifth Primary key value of the entity.
311 --
312
313 procedure Update_Attachment (
314 seq_num in varchar2 ,
315 category_id in varchar2 ,
316 document_description in varchar2 ,
317 text in CLOB ,
318 file_name in varchar2 ,
319 url in varchar2 ,
320 attached_document_id in varchar2 ,
321 datatype_id in varchar2 ,
322 function_name in varchar2 ,
323 entity_name in varchar2 ,
324 pk1_value in varchar2 ,
325 pk2_value in varchar2 ,
326 pk3_value in varchar2 ,
327 pk4_value in varchar2 ,
328 pk5_value in varchar2 ,
329 media_id in number ,
330 user_id in varchar2 ,
331 dm_node in NUMBER DEFAULT NULL ,
332 dm_folder_path in VARCHAR2 DEFAULT NULL ,
336 title in VARCHAR2 DEFAULT NULL
333 dm_type in VARCHAR2 DEFAULT NULL ,
334 dm_document_id in NUMBER DEFAULT NULL ,
335 dm_version_number in VARCHAR2 DEFAULT NULL ,
337 );
338
339 -- ReloadSummary
340 -- Reloads the summarry after adding or updating attachment.
341 -- IN
342 -- package_name - Calling package name.
343 -- function_name - Function name of the form
344 -- entity_name - Entity name for which attachment is made.
345 -- pk1_value - First Primary Key value of the entity.
346 -- to
347 -- pk5_value - Fifth Primary key value of the entity.
348 -- from_url - URL from which the attachments is invoked from.
349 -- This is required to set the back link.
350 -- query_only - Query flag is set 'Y' when called in query only
351 -- mode.
352 --
353
354 procedure ReloadSummary(
355 package_name in varchar2 default 'FND_WEBATTCH',
356 function_name in varchar2,
357 entity_name in varchar2,
358 pk1_value in varchar2,
359 pk2_value in varchar2 default NULL,
360 pk3_value in varchar2 default NULL,
361 pk4_value in varchar2 default NULL,
362 pk5_value in varchar2 default NULL,
363 from_url in varchar2 ,
364 query_only in varchar2 default 'N'
365 );
366
367 -- Header
368 -- Creates Toolbar for Attachment pages.
369 -- IN
370 -- Lang - Toolbar language.
371 --
372 procedure Header( Lang in varchar2);
373
374 -- PrintSummary
375 -- Prints the attachment summary page body (No Titles and Links).
376 -- IN
377 -- package_name - Calling package name.
378 -- function_name - Function name of the web function
379 -- entity_name - Entity name to which the attachment is made.
380 -- pk1_value - First primary key of the entity.
381 -- through
382 -- pk5_value - Fifth primary key value of the entity.
383 -- from_url - URL from which the attachments is invoked from.
384 -- This is required to set the back link.
385 -- query_only - Query flag is set 'Y' when called in query only
386 -- mode.
387 --
388
389 procedure PrintSummary(
390 package_name in varchar2 default 'FND_WEBATTCH',
391 function_name in varchar2,
392 entity_name in varchar2,
393 pk1_value in varchar2,
394 pk2_value in varchar2 default NULL,
395 pk3_value in varchar2 default NULL,
396 pk4_value in varchar2 default NULL,
397 pk5_value in varchar2 default NULL,
398 from_url in varchar2,
399 query_only in varchar2 default 'N'
400 );
401
402 -- PrintTextDocument
403 -- Prints the HTML page that displays text document information.
404 -- IN
405 -- package_name - Calling package name.
406 -- attached_document_id - Reference to the attached document
407 -- function_name - Function name of the web function
408 -- entity_name - Entity name to which the attachment is made.
409 -- pk1_value - First primary key of the entity.
410 -- through
411 -- pk5_value - Fifth primary key value of the entity.
412 -- from_url - URL from which the attachments is invoked from.
413 -- This is required to set the back link.
414 -- query_only - Query flag is set 'Y' when called in query only
415 -- mode.
416 --
417
418 procedure PrintTextDocument(
419 package_name in varchar2 default 'FND_WEBATTCH',
420 attached_document_id in varchar2,
421 function_name in varchar2 ,
422 entity_name in varchar2 ,
423 pk1_value in varchar2 ,
424 pk2_value in varchar2 default NULL,
425 pk3_value in varchar2 default NULL,
426 pk4_value in varchar2 default NULL,
427 pk5_value in varchar2 default NULL,
428 from_url in varchar2,
429 query_only in varchar2 default 'N'
430 );
431
432 -- PrintAddAttachment
433 -- Prints the HTML form to add attachment and document information.
434 -- IN
435 -- package_name - Calling package name.
436 -- function_name - Function name of the web function
437 -- entity_name - Entity name to which the attachment is made.
438 -- pk1_value - First primary key of the entity.
439 -- through
440 -- pk5_value - Fifth primary key value of the entity.
441 -- from_url - URL from which the attachments is invoked from.
442 -- This is required to set the back link.
443 -- query_only - Query flag is set 'Y' when called in query only
444 -- mode.
445 --
446
447 procedure PrintAddAttachment(
448 package_name in varchar2 default 'FND_WEBATTCH',
449 function_name in varchar2,
450 entity_name in varchar2,
451 pk1_value in varchar2,
452 pk2_value in varchar2 default NULL,
453 pk3_value in varchar2 default NULL,
454 pk4_value in varchar2 default NULL,
455 pk5_value in varchar2 default NULL,
456 from_url in varchar2,
457 query_only in varchar2 default 'N'
458 );
459
460 -- PrintUpdateAttachment
461 -- Prints the HTML form to update attachment and document information.
462 -- IN
463 -- package_name - Calling package name.
464 -- seq_num - Attachment Seq Number.
465 -- attached_document_id
466 -- function_name - Function name of the web function
467 -- entity_name - Entity name to which the attachment is made.
468 -- pk1_value - First primary key of the entity.
469 -- through
470 -- pk5_value - Fifth primary key value of the entity.
471 -- from_url - URL from which the attachments is invoked from.
472 -- This is required to set the back link.
473 -- query_only - Query flag is set 'Y' when called in query only
474 -- mode.
475 --
476
477 procedure PrintUpdateAttachment (
478 package_name in varchar2 default 'FND_WEBATTCH',
479 attached_document_id in varchar2,
480 function_name in varchar2,
481 entity_name in varchar2,
482 pk1_value in varchar2,
483 pk2_value in varchar2 default NULL,
484 pk3_value in varchar2 default NULL,
485 pk4_value in varchar2 default NULL,
486 pk5_value in varchar2 default NULL,
487 from_url in varchar2,
488 query_only in varchar2 default 'N'
489 );
490
491 procedure PrintBlankPage;
492
493 /*===========================================================================
494
495 Function set_document_identifier
496
497 Purpose This is call back implemented to pass the document reference
498 identifier to the attachments.
499
500
501 file_id - A unique access key for document reference attributes
502 being attached to a application entity.
503
504 document_identifier - full concatenated document attribute strings.
505 nodeid:libraryid:documentid:version:document_name
506
507 ============================================================================*/
508 procedure set_document_identifier (
509 p_file_id IN VARCHAR2,
510 p_document_id IN VARCHAR2);
511
512 /*===========================================================================
513
514 Function authorizeDMTransaction
515
516 Purpose This will provide a secure key for DM transaction from forms.
517
518
519 file_id - A unique access key for document reference attributes
520 being attached to a application entity.
521
522 ============================================================================*/
523 procedure authorizeDMTransaction(
524 file_id OUT NOCOPY VARCHAR2);
525
526 end FND_WEBATTCH;
[Home] [Help]