[Home] [Help]
PACKAGE: APPS.JTF_AMV_ATTACHMENT_PUB
Source
1 PACKAGE jtf_amv_attachment_pub AUTHID CURRENT_USER AS
2 /* $Header: jtfpatts.pls 115.9 2002/11/26 22:13:56 stopiwal ship $ */
3
4 --
5 -- PACKAGE
6 -- JTF_AMV_ATTACHMENT_PUB
7 --
8 -- PURPOSE
9 -- Public API for document attachments.
10 -- It provide function for creating, deleting, or updating attachments
11 -- associated to the calling objects.
12 --
13 -- PROCEDURES
14 --
15 --------------------------------
16 -- Activity Attachments --
17 --------------------------------
18 -- create_act_attachment
19 -- delete_act_attachment
20 -- update_act_attachment
21 -- lock_act_attachment
22 -- validate_act_attachment
23 --
24 -- check_act_attachment_items
25 -- check_act_attachment_record
26 --
27 -- miss_act_attachment_rec
28 -- complete_act_attachment_rec
29 --
30 -- HISTORY
31 -- 10/09/1999 [email protected] created
32 -- 11/23/1999 PWU modify to move to jtf.
33 -- 06/20/2000 rmajumda Modified the record type definition
34 -- act_attachment_rec_type
35 --------------------------------------------------------------------------
36 TYPE act_attachment_rec_type IS RECORD
37 (
38 attachment_id NUMBER,
39 last_update_date DATE,
40 last_updated_by NUMBER,
41 creation_date DATE,
42 created_by NUMBER,
43 last_update_login NUMBER,
44 object_version_number NUMBER,
45 owner_user_id NUMBER,
46 attachment_used_by_id NUMBER,
47 attachment_used_by VARCHAR2(30),
48 version VARCHAR2(20),
49 enabled_flag VARCHAR2(1),
50 can_fulfill_electronic_flag VARCHAR2(1),
51 file_id NUMBER,
52 file_name VARCHAR2(240),
53 file_extension VARCHAR2(20),
54 document_id NUMBER,
55 keywords VARCHAR2(240),
56 display_width NUMBER,
57 display_height NUMBER,
58 display_location VARCHAR2(2000),
59 link_to VARCHAR2(2000),
60 link_URL VARCHAR2(2000),
61 send_for_preview_flag VARCHAR2(1),
62 attachment_type VARCHAR2(30),
63 language_code VARCHAR2(4),
64 application_id NUMBER,
65 description VARCHAR2(2000),
66 default_style_sheet VARCHAR2(240),
67 display_url VARCHAR2(1024),
68 display_rule_id NUMBER,
69 display_program VARCHAR2(240),
70 attribute_category VARCHAR2(30),
71 attribute1 VARCHAR2(150),
72 attribute2 VARCHAR2(150),
73 attribute3 VARCHAR2(150),
74 attribute4 VARCHAR2(150),
75 attribute5 VARCHAR2(150),
76 attribute6 VARCHAR2(150),
77 attribute7 VARCHAR2(150),
78 attribute8 VARCHAR2(150),
79 attribute9 VARCHAR2(150),
80 attribute10 VARCHAR2(150),
81 attribute11 VARCHAR2(150),
82 attribute12 VARCHAR2(150),
83 attribute13 VARCHAR2(150),
84 attribute14 VARCHAR2(150),
85 attribute15 VARCHAR2(150),
86 display_text VARCHAR2(2000),
87 alternate_text VARCHAR2(1000),
88 secured_flag VARCHAR2(1),
89 attachment_sub_type VARCHAR2(30)
90 );
91
92 ---------------------------------------------------------------------
93 -- PROCEDURE
94 -- create_act_attachment
95 --
96 -- PURPOSE
97 -- Create a new activity attachment.
98 --
99 -- PARAMETERS
100 -- p_act_attachment_rec: the new record to be inserted
101 -- x_act_attachment_id: return the activity_attachment_id of the new
102 -- attachment
103 --
104 -- NOTES
105 -- 1. object_version_number will be set to 1.
106 -- 2. If activity_attachment_id is passed in, the uniqueness will be checked.
107 -- Raise exception in case of duplicates.
108 -- 3. If activity_attachment_id is not passed in, generate a unique one from
109 -- the sequence.
110 -- 4. If a flag column is passed in, check if it is 'Y' or 'N'.
111 -- Raise exception for invalid flag.
112 -- 5. If a flag column is not passed in, default it to 'Y' or 'N'.
113 -- 6. Please don't pass in any FND_API.g_mess_char/num/date.
114 ---------------------------------------------------------------------
115
116 PROCEDURE create_act_attachment
117 (
118 p_api_version IN NUMBER,
119 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
120 p_commit IN VARCHAR2 := FND_API.g_false,
121 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
122
123 x_return_status OUT NOCOPY VARCHAR2,
124 x_msg_count OUT NOCOPY NUMBER,
125 x_msg_data OUT NOCOPY VARCHAR2,
126
127 p_act_attachment_rec IN act_attachment_rec_type,
128 x_act_attachment_id OUT NOCOPY NUMBER
129 );
130
131
132 --------------------------------------------------------------------
133 -- PROCEDURE
134 -- delete_act_attachment
135 --
136 -- PURPOSE
137 -- Delete an activity attachment.
138 --
139 -- PARAMETERS
140 -- p_act_attachment_id: the activity_attachment_id
141 -- p_object_version: the object_version_number
142 --
143 -- NOTES
144 -- 1. Raise exception if the object_version_number doesn't match.
145 --------------------------------------------------------------------
146
147 PROCEDURE delete_act_attachment
148 (
149 p_api_version IN NUMBER,
150 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
151 p_commit IN VARCHAR2 := FND_API.g_false,
152 x_return_status OUT NOCOPY VARCHAR2,
153 x_msg_count OUT NOCOPY NUMBER,
154 x_msg_data OUT NOCOPY VARCHAR2,
155 p_act_attachment_id IN NUMBER,
156 p_object_version IN NUMBER
157 );
158
159 ---------------------------------------------------------------------
160 -- PROCEDURE
161 -- update_act_attachment
162 --
163 -- PURPOSE
164 -- Update an activity attachment.
165 --
166 -- PARAMETERS
167 -- p_act_attachment_rec: the record with new items
168 --
169 -- NOTES
170 -- 1. Raise exception if the object_version_number doesn't match.
171 -- 2. If an attribute is passed in as FND_API.g_miss_char/num/date,
172 -- that column won't be updated.
173 ----------------------------------------------------------------------
174
175 PROCEDURE update_act_attachment
176 (
177 p_api_version IN NUMBER,
178 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
179 p_commit IN VARCHAR2 := FND_API.g_false,
180 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
181
182 x_return_status OUT NOCOPY VARCHAR2,
183 x_msg_count OUT NOCOPY NUMBER,
184 x_msg_data OUT NOCOPY VARCHAR2,
185
186 p_act_attachment_rec IN act_attachment_rec_type
187 );
188
189 -------------------------------------------------------------------
190 -- PROCEDURE
191 -- lock_act_attachment
192 --
193 -- PURPOSE
194 -- Lock an activity attachment.
195 --
196 -- PARAMETERS
197 -- p_act_attachment_id: the activity_attachment_id
198 -- p_object_version: the object_version_number
199 --
200 -- NOTES
201 -- 1. Raise exception if the object_version_number doesn't match.
202 --------------------------------------------------------------------
203
204 PROCEDURE lock_act_attachment
205 (
206 p_api_version IN NUMBER,
207 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
208
209 x_return_status OUT NOCOPY VARCHAR2,
210 x_msg_count OUT NOCOPY NUMBER,
211 x_msg_data OUT NOCOPY VARCHAR2,
212
213 p_act_attachment_id IN NUMBER,
214 p_object_version IN NUMBER
215 );
216
217
218 ---------------------------------------------------------------------
219 -- PROCEDURE
220 -- validate_act_attachment
221 --
222 -- PURPOSE
223 -- Validate an activity attachment record.
224 --
225 -- PARAMETERS
226 -- p_act_attachment_rec: the activity attachment record to be validated
227 --
228 -- NOTES
229 -- 1. p_act_attachment_rec should be the complete activity attachment
230 -- record. There should not be any FND_API.g_miss_char/num/date in it.
231 ----------------------------------------------------------------------
232
233 PROCEDURE validate_act_attachment
234 (
235 p_api_version IN NUMBER,
236 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
237 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
238
239 x_return_status OUT NOCOPY VARCHAR2,
240 x_msg_count OUT NOCOPY NUMBER,
241 x_msg_data OUT NOCOPY VARCHAR2,
242
243 p_act_attachment_rec IN act_attachment_rec_type
244 );
245
246 ---------------------------------------------------------------------
247 -- PROCEDURE
248 -- check_act_attachment_items
249 --
250 -- PURPOSE
251 -- Perform the item level checking including unique keys,
252 -- required columns, foreign keys, domain constraints.
253 --
254 -- PARAMETERS
255 -- p_act_attachment_rec: the record to be validated
256 -- p_validation_mode: JTF_PLSQL_API.g_create/g_update
257 ---------------------------------------------------------------------
258
259 PROCEDURE check_act_attachment_items
260 (
261 p_act_attachment_rec IN act_attachment_rec_type,
262 p_validation_mode IN VARCHAR2 := JTF_PLSQL_API.g_create,
263 x_return_status OUT NOCOPY VARCHAR2
264 );
265
266
267 ---------------------------------------------------------------------
268 -- PROCEDURE
269 -- check_act_attachment_record
270 --
271 -- PURPOSE
272 -- Check the record level business rules.
273 --
274 -- PARAMETERS
275 -- p_act_attachment_rec: the record to be validated; may contain attributes
276 -- as FND_API.g_miss_char/num/date
277 -- p_complete_rec: the complete record after all "g_miss" items
278 -- have been replaced by current database values
279 ---------------------------------------------------------------------
280
281 PROCEDURE check_act_attachment_record
282 (
283 p_act_attachment_rec IN act_attachment_rec_type,
284 p_complete_rec IN act_attachment_rec_type := NULL,
285 x_return_status OUT NOCOPY VARCHAR2
286 );
287
288 ---------------------------------------------------------------------
289 -- PROCEDURE
290 -- miss_act_attachment_rec
291 --
292 -- PURPOSE
293 -- Initialize all attributes to be FND_API.g_miss_char/num/date.
294 ---------------------------------------------------------------------
295
296 PROCEDURE miss_act_attachment_rec
297 (
298 x_act_attachment_rec OUT NOCOPY act_attachment_rec_type
299 );
300
301
302 ---------------------------------------------------------------------
303 -- PROCEDURE
304 -- complete_act_attachment_rec
305 --
306 -- PURPOSE
307 -- For update_act_attachment, some attributes may be passed in as
308 -- FND_API.g_miss_char/num/date if the user doesn't want to
309 -- update those attributes. This procedure will replace the
310 -- "g_miss" attributes with current database values.
311 --
312 -- PARAMETERS
313 -- p_act_attachment_rec: the record which may contain attributes as
314 -- FND_API.g_miss_char/num/date
315 -- x_complete_rec: the complete record after all "g_miss" items
316 -- have been replaced by current database values
317 ---------------------------------------------------------------------
318 PROCEDURE complete_act_attachment_rec
319 (
320 p_act_attachment_rec IN act_attachment_rec_type,
321 x_complete_rec OUT NOCOPY act_attachment_rec_type
322 );
323
324 END jtf_amv_attachment_pub;