1 package FND_WEBATTCH as
2 /* $Header: AFATCHMS.pls 120.3 2006/05/26 16:51:23 blash 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 );
217
218 -- Add_Attachment
219 -- IN
220 -- seq_num - Attachment Seq Number.
221 -- category_description
222 -- document_description
223 -- datatype_name - Datatype identifier
224 -- document_text - Document Text Input.
225 -- file_name - File name
226 -- URL - URL
227 -- function_name --Function name of the form
228 -- entity_name - Entity name for which attachment is made.
229 -- pk1_value - First Primary Key value of the entity.
230 -- to
231 -- pk5_value - Fifth Primary key value of the entity.
232 -- media_id - Document reference.
233 -- usage_type - One-time, Standard, Template
234
235 procedure Add_Attachment (
236 seq_num in varchar2 ,
237 category_id in varchar2 ,
238 document_description in varchar2 ,
239 datatype_id in varchar2 ,
240 text in long ,
241 file_name in varchar2 ,
242 url in varchar2 ,
243 function_name in varchar2 ,
244 entity_name in varchar2 ,
245 pk1_value in varchar2 ,
246 pk2_value in varchar2 ,
247 pk3_value in varchar2 ,
248 pk4_value in varchar2 ,
249 pk5_value in varchar2 ,
250 media_id in number ,
251 user_id in varchar2 ,
252 usage_type in varchar2 DEFAULT 'O' ,
253 title in varchar2 DEFAULT NULL
254 );
255
256 PROCEDURE update_attachment_gfm_wrapper(
257 seq_num varchar2,
258 category_id varchar2,
259 document_description varchar2 DEFAULT NULL,
260 text varchar2 DEFAULT NULL,
261 file_name varchar2 DEFAULT NULL,
262 url varchar2 DEFAULT NULL,
263 attached_document_id varchar2 DEFAULT NULL,
264 datatype_id varchar2,
265 function_name varchar2 DEFAULT NULL,
266 entity_name varchar2 DEFAULT NULL,
267 pk1_value varchar2 DEFAULT NULL,
268 pk2_value varchar2 DEFAULT NULL,
269 pk3_value varchar2 DEFAULT NULL,
270 pk4_value varchar2 DEFAULT NULL,
271 pk5_value varchar2 DEFAULT NULL,
272 from_url varchar2 DEFAULT NULL,
273 query_only varchar2 DEFAULT NULL,
274 dmid VARCHAR2 DEFAULT NULL,
275 dmname VARCHAR2 DEFAULT NULL,
276 package_name VARCHAR2 DEFAULT 'FND_WEBATTCH'
277 );
278
279 -- Update_Attachment
280 -- IN
281 -- seq_num - Attachment Seq Number.
282 -- category_id
283 -- document_description
284 -- datatype_id - Datatype identifier
285 -- document_text - Document Text Input.
286 -- file_name - File name
287 -- URL - URL
288 -- attached_document_id
289 -- function_name - Function name of the form
290 -- entity_name - Entity name for which attachment is made.
291 -- pk1_value - First Primary Key value of the entity.
292 -- to
293 -- pk5_value - Fifth Primary key value of the entity.
294 --
295
296 procedure Update_Attachment (
297 seq_num in varchar2 ,
298 category_id in varchar2 ,
299 document_description in varchar2 ,
300 text in long ,
301 file_name in varchar2 ,
302 url in varchar2 ,
303 attached_document_id in varchar2 ,
304 datatype_id in varchar2 ,
305 function_name in varchar2 ,
306 entity_name in varchar2 ,
307 pk1_value in varchar2 ,
308 pk2_value in varchar2 ,
309 pk3_value in varchar2 ,
310 pk4_value in varchar2 ,
311 pk5_value in varchar2 ,
312 media_id in number ,
313 user_id in varchar2
314 );
315
316 -- ReloadSummary
317 -- Reloads the summarry after adding or updating attachment.
318 -- IN
319 -- package_name - Calling package name.
320 -- function_name - Function name of the form
321 -- entity_name - Entity name for which attachment is made.
322 -- pk1_value - First Primary Key value of the entity.
323 -- to
324 -- pk5_value - Fifth Primary key value of the entity.
325 -- from_url - URL from which the attachments is invoked from.
326 -- This is required to set the back link.
327 -- query_only - Query flag is set 'Y' when called in query only
328 -- mode.
329 --
330
331 procedure ReloadSummary(
332 package_name in varchar2 default 'FND_WEBATTCH',
333 function_name in varchar2,
334 entity_name in varchar2,
335 pk1_value in varchar2,
336 pk2_value in varchar2 default NULL,
337 pk3_value in varchar2 default NULL,
338 pk4_value in varchar2 default NULL,
339 pk5_value in varchar2 default NULL,
340 from_url in varchar2 ,
341 query_only in varchar2 default 'N'
342 );
343
344 -- Header
345 -- Creates Toolbar for Attachment pages.
346 -- IN
347 -- Lang - Toolbar language.
348 --
349 procedure Header( Lang in varchar2);
350
351 -- PrintSummary
352 -- Prints the attachment summary page body (No Titles and Links).
353 -- IN
354 -- package_name - Calling package name.
355 -- function_name - Function name of the web function
356 -- entity_name - Entity name to which the attachment is made.
357 -- pk1_value - First primary key of the entity.
358 -- through
359 -- pk5_value - Fifth primary key value of the entity.
360 -- from_url - URL from which the attachments is invoked from.
361 -- This is required to set the back link.
362 -- query_only - Query flag is set 'Y' when called in query only
363 -- mode.
364 --
365
366 procedure PrintSummary(
367 package_name in varchar2 default 'FND_WEBATTCH',
368 function_name in varchar2,
369 entity_name in varchar2,
370 pk1_value in varchar2,
371 pk2_value in varchar2 default NULL,
372 pk3_value in varchar2 default NULL,
373 pk4_value in varchar2 default NULL,
374 pk5_value in varchar2 default NULL,
375 from_url in varchar2,
376 query_only in varchar2 default 'N'
377 );
378
379 -- PrintTextDocument
380 -- Prints the HTML page that displays text document information.
381 -- IN
382 -- package_name - Calling package name.
383 -- attached_document_id - Reference to the attached document
384 -- function_name - Function name of the web function
385 -- entity_name - Entity name to which the attachment is made.
386 -- pk1_value - First primary key of the entity.
387 -- through
388 -- pk5_value - Fifth primary key value of the entity.
389 -- from_url - URL from which the attachments is invoked from.
390 -- This is required to set the back link.
391 -- query_only - Query flag is set 'Y' when called in query only
392 -- mode.
393 --
394
395 procedure PrintTextDocument(
396 package_name in varchar2 default 'FND_WEBATTCH',
397 attached_document_id in varchar2,
398 function_name in varchar2 ,
399 entity_name in varchar2 ,
400 pk1_value in varchar2 ,
401 pk2_value in varchar2 default NULL,
402 pk3_value in varchar2 default NULL,
403 pk4_value in varchar2 default NULL,
404 pk5_value in varchar2 default NULL,
405 from_url in varchar2,
406 query_only in varchar2 default 'N'
407 );
408
409 -- PrintAddAttachment
410 -- Prints the HTML form to add attachment and document information.
411 -- IN
412 -- package_name - Calling package name.
413 -- function_name - Function name of the web function
414 -- entity_name - Entity name to which the attachment is made.
415 -- pk1_value - First primary key of the entity.
416 -- through
417 -- pk5_value - Fifth primary key value of the entity.
418 -- from_url - URL from which the attachments is invoked from.
419 -- This is required to set the back link.
420 -- query_only - Query flag is set 'Y' when called in query only
424 procedure PrintAddAttachment(
421 -- mode.
422 --
423
425 package_name in varchar2 default 'FND_WEBATTCH',
426 function_name in varchar2,
427 entity_name in varchar2,
428 pk1_value in varchar2,
429 pk2_value in varchar2 default NULL,
430 pk3_value in varchar2 default NULL,
431 pk4_value in varchar2 default NULL,
432 pk5_value in varchar2 default NULL,
433 from_url in varchar2,
434 query_only in varchar2 default 'N'
435 );
436
437 -- PrintUpdateAttachment
438 -- Prints the HTML form to update attachment and document information.
439 -- IN
440 -- package_name - Calling package name.
441 -- seq_num - Attachment Seq Number.
442 -- attached_document_id
443 -- function_name - Function name of the web function
444 -- entity_name - Entity name to which the attachment is made.
445 -- pk1_value - First primary key of the entity.
446 -- through
447 -- pk5_value - Fifth primary key value of the entity.
448 -- from_url - URL from which the attachments is invoked from.
449 -- This is required to set the back link.
450 -- query_only - Query flag is set 'Y' when called in query only
451 -- mode.
452 --
453
454 procedure PrintUpdateAttachment (
455 package_name in varchar2 default 'FND_WEBATTCH',
456 attached_document_id in varchar2,
457 function_name in varchar2,
458 entity_name in varchar2,
459 pk1_value in varchar2,
460 pk2_value in varchar2 default NULL,
461 pk3_value in varchar2 default NULL,
462 pk4_value in varchar2 default NULL,
463 pk5_value in varchar2 default NULL,
464 from_url in varchar2,
465 query_only in varchar2 default 'N'
466 );
467
468 procedure PrintBlankPage;
469
470 /*===========================================================================
471
472 Function set_document_identifier
473
474 Purpose This is call back implemented to pass the document reference
475 identifier to the attachments.
476
477
478 file_id - A unique access key for document reference attributes
479 being attached to a application entity.
480
481 document_identifier - full concatenated document attribute strings.
482 nodeid:libraryid:documentid:version:document_name
483
484 ============================================================================*/
485 procedure set_document_identifier (
486 p_file_id IN VARCHAR2,
487 p_document_id IN VARCHAR2);
488
489 /*===========================================================================
490
491 Function authorizeDMTransaction
492
493 Purpose This will provide a secure key for DM transaction from forms.
494
495
496 file_id - A unique access key for document reference attributes
497 being attached to a application entity.
498
499 ============================================================================*/
500 procedure authorizeDMTransaction(
501 file_id OUT NOCOPY VARCHAR2);
502
503 end FND_WEBATTCH;
[Home] [Help]