1 PACKAGE JTF_IH_PUB AUTHID CURRENT_USER AS
2 /* $Header: JTFIHPBS.pls 120.4 2006/02/13 06:33:26 nchouras ship $ */
3 /*#
4 * The JTF_IH_PUB package provides a common framework for CRM modules to
5 * capture and access all customer interaction data that are associated with
6 * customer contacts.
7 * All public procedures (APIs) relating to media items, media lifecycles,
8 * interactions, and activities are stored in the JTF_IH_PUB package.
9 * @rep:scope public
10 * @rep:product JTH
11 * @rep:displayname Customer Interaction Management
12 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
13 */
14 -- Start of comments
15 -- Procedure : Create_Interaction
16 -- Type : Public API
17 -- Usage : Creates a customer interaction record in the table
18 -- JTF_IH_INTERACTIONS and related activity(ies)
19 -- Pre-reqs : None
20 --
21 -- Standard IN Parameters:
22 -- p_api_version IN NUMBER Required
23 -- p_init_msg_list IN VARCHAR2(1) Optional
24 -- Default = FND_API.G_FALSE
25 -- p_commit IN VARCHAR2(1) Optional
26 -- Default = FND_API.G_FALSE
27 --
28 -- Standard OUT Parameters:
29 -- x_return_status OUT VARCHAR2(1)
30 -- x_msg_count OUT NUMBER
31 -- x_msg_data OUT VARCHAR2(2000)
32 --
33 -- Interaction IN Parameters:
34 -- p_resp_appl_id IN NUMBER Optional(1)
35 -- Application identifier
36 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
37 -- p_resp_id IN NUMBER Optional(1)
38 -- Responsibility identifier
39 -- Default = FND_GLOBAL.RESP_ID or NULL
40 -- p_user_id IN NUMBER Optional
41 -- Corresponds to the column USER_ID in the table
42 -- FND_USER, and identifies the Oracle
43 -- Applications user
44 -- Default = FND_GLOBAL.USER_ID
45 -- p_login_id IN NUMBER Optional
46 -- Corresponds to the column LOGIN_ID in the
47 -- table FND_LOGINS, and identifies the login session
48 -- Default = FND_GLOBAL.LOGIN_ID or NULL
49 -- p_interaction_rec IN interaction_rec_type
50 -- p_activities IN activity_tbl_type
51 --
52 -- interaction_rec_type is the structure that captures the interaction and has the following
53 -- attributes:
54 -- reference_form VARCHAR2 Optional
55 -- follow_up_action VARCHAR2 Optional
56 -- duration NUMBER Optional
57 -- end_date_time DATE Optional
58 -- inter_interaction_duration NUMBER Optional
59 -- interaction_id NUMBER
60 -- non_productive_time_amount NUMBER Optional
61 -- preview_time_amount NUMBER Optional
62 -- productive_time_amount NUMBER Optiona
63 -- start_date_time DATE Optional
64 -- wrapUp_time_amount NUMBER Optional
65 -- handler_id NUMBER Mandatory
66 -- script_id NUMBER Optional
67 -- outcome_id NUMBER Mandatory
68 -- result_id NUMBER Optional
69 -- reason_id NUMBER Optional
70 -- resource_subtype_id NUMBER Optional
71 -- resource_type_id NUMBER Optional
72 -- resource_id NUMBER Mandatory
73 -- party_id NUMBER Mandatory
74 -- parent_id NUMBER Optional
75 -- object_id NUMBER Optional
76 -- object_type VARCHAR2 Optional
77 -- source_code_id NUMBER Optional
78 -- source_code VARCHAR2 Optional
79 -- attribute1 VARCHAR2 Optional(2)
80 -- attribute2 VARCHAR2 Optional(2)
81 -- attribute3 VARCHAR2 Optional(2)
82 -- attribute4 VARCHAR2 Optional(2)
83 -- attribute5 VARCHAR2 Optional(2)
84 -- attribute6 VARCHAR2 Optional(2)
85 -- attribute7 VARCHAR2 Optional(2)
86 -- attribute8 VARCHAR2 Optional(2)
87 -- attribute9 VARCHAR2 Optional(2)
88 -- attribute10 VARCHAR2 Optional(2)
89 -- attribute11 VARCHAR2 Optional(2)
90 -- attribute12 VARCHAR2 Optional(2)
91 -- attribute13 VARCHAR2 Optional(2)
92 -- attribute14 VARCHAR2 Optional(2)
93 -- attribute15 VARCHAR2 Optional(2)
94 -- attribute_category VARCHAR2 Optional(2)
95 -- touchpoint1_type VARCHAR2 Optional(3)
96 -- touchpoint2_type VARCHAR2 Optional(3)
97 --
98 -- activity_rec_type is the structure that captures the activity and has the following attributes:
99 --
100 -- duration NUMBER
101 -- end_date_time DATE
102 -- start_date_time DATE
103 -- task_id NUMBER
104 -- doc_id NUMBER
105 -- doc_ref VARCHAR2
106 -- doc_source_object_name VARCHAR2 -- Modified by Jim Baldo 20 April 2000 for bugdb 1275539
107 -- media_id NUMBER
108 -- action_item_id NUMBER
109 -- interaction_id NUMBER
110 -- activity_id NUMBER
111 -- outcome_id NUMBER
112 -- result_id NUMBER
113 -- reason_id NUMBER
114 -- description VARCHAR2
115 -- action_id VARCHAR2
116 -- arole VARCHAR2
117 -- interaction_action_type VARCHAR2
118 -- object_id NUMBER Optional
119 -- object_type VARCHAR2 Optional
120 -- source_code_id NUMBER Optional
121 -- source_code VARCHAR2 Optional
122 --
123 -- activity_tbl_type is the pl/sql table that used to bundle the set of activities
124 --
125 -- Version : Initial version 1.0
126 --
127 -- Notes :
128 -- (1) The application ID, responsibility ID, and user ID determine which
129 -- profile values are used as default.
130 -- (2) You must pass in segment IDs for none or all descriptive flexfield
131 -- columns that might be used in the descriptive flexfield.
132 -- (3) The touchpoint types extends the Interaction History model to include
133 -- resource-to-resource touchpoints.
134 --
135 -- End of comments
136
137 TYPE interaction_rec_type IS RECORD
138 (
139 interaction_id NUMBER :=fnd_api.g_miss_num,
140 reference_form VARCHAR2(1000) :=fnd_api.g_miss_char,
141 follow_up_action VARCHAR2(80) :=fnd_api.g_miss_char,
142 duration NUMBER := fnd_api.g_miss_num,
143 end_date_time DATE :=fnd_api.g_miss_date,
144 inter_interaction_duration NUMBER :=fnd_api.g_miss_num,
145 non_productive_time_amount NUMBER :=fnd_api.g_miss_num,
146 preview_time_amount NUMBER :=fnd_api.g_miss_num,
147 productive_time_amount NUMBER :=fnd_api.g_miss_num,
148 start_date_time DATE :=fnd_api.g_miss_date,
149 wrapUp_time_amount NUMBER :=fnd_api.g_miss_num,
150 handler_id NUMBER :=fnd_api.g_miss_num,
151 script_id NUMBER :=fnd_api.g_miss_num,
152 outcome_id NUMBER :=fnd_api.g_miss_num,
153 result_id NUMBER :=fnd_api.g_miss_num,
154 reason_id NUMBER :=fnd_api.g_miss_num,
155 resource_id NUMBER :=fnd_api.g_miss_num,
156 party_id NUMBER :=fnd_api.g_miss_num,
157 parent_id NUMBER :=fnd_api.g_miss_num,
158 object_id NUMBER :=fnd_api.g_miss_num,
159 object_type VARCHAR2(30) :=fnd_api.g_miss_char,
160 source_code_id NUMBER :=fnd_api.g_miss_num,
161 source_code VARCHAR2(100) :=fnd_api.g_miss_char,
162 attribute1 VARCHAR2(150) :=fnd_api.g_miss_char,
163 attribute2 VARCHAR2(150) :=fnd_api.g_miss_char,
164 attribute3 VARCHAR2(150) :=fnd_api.g_miss_char,
165 attribute4 VARCHAR2(150) :=fnd_api.g_miss_char,
166 attribute5 VARCHAR2(150) :=fnd_api.g_miss_char,
167 attribute6 VARCHAR2(150) :=fnd_api.g_miss_char,
168 attribute7 VARCHAR2(150) :=fnd_api.g_miss_char,
169 attribute8 VARCHAR2(150) :=fnd_api.g_miss_char,
170 attribute9 VARCHAR2(150) :=fnd_api.g_miss_char,
171 attribute10 VARCHAR2(150) :=fnd_api.g_miss_char,
172 attribute11 VARCHAR2(150) :=fnd_api.g_miss_char,
173 attribute12 VARCHAR2(150) :=fnd_api.g_miss_char,
174 attribute13 VARCHAR2(150) :=fnd_api.g_miss_char,
175 attribute14 VARCHAR2(150) :=fnd_api.g_miss_char,
176 attribute15 VARCHAR2(150) :=fnd_api.g_miss_char,
177 attribute_category VARCHAR2(30) :=fnd_api.g_miss_char,
178 touchpoint1_type VARCHAR2(30) := 'PARTY',
179 touchpoint2_type VARCHAR2(30) := 'RS_EMPLOYEE',
180 -- Bug# 1732336
181 method_code VARCHAR2(30) :=fnd_api.g_miss_char,
182 -- Enh# 2940473
183 bulk_writer_code VARCHAR2(240) := fnd_api.g_miss_char,
184 bulk_batch_type VARCHAR2(240) := fnd_api.g_miss_char,
185 bulk_batch_id NUMBER := fnd_api.g_miss_num,
186 bulk_interaction_id NUMBER := fnd_api.g_miss_num,
187 -- Enh# 1846960
188 primary_party_id NUMBER := fnd_api.g_miss_num,
189 contact_rel_party_id NUMBER := fnd_api.g_miss_num,
190 contact_party_id NUMBER := fnd_api.g_miss_num
191 );
192
193 FUNCTION INIT_INTERACTION_REC RETURN interaction_rec_type;
194
195 TYPE activity_rec_type IS RECORD
196 (
197 activity_id NUMBER := fnd_api.g_miss_num,
198 duration NUMBER :=fnd_api.g_miss_num,
199 cust_account_id NUMBER := fnd_api.g_miss_num,
200 cust_org_id NUMBER := fnd_api.g_miss_num,
201 role VARCHAR2(240) := fnd_api.g_miss_char,
202 end_date_time DATE :=fnd_api.g_miss_date,
203 start_date_time DATE :=fnd_api.g_miss_date,
204 task_id NUMBER :=fnd_api.g_miss_num,
205 doc_id NUMBER :=fnd_api.g_miss_num,
206 doc_ref VARCHAR2(30) :=fnd_api.g_miss_char,
207 doc_source_object_name VARCHAR2(80) :=fnd_api.g_miss_char,
208 media_id NUMBER :=fnd_api.g_miss_num,
209 action_item_id NUMBER :=fnd_api.g_miss_num,
210 interaction_id NUMBER :=fnd_api.g_miss_num,
211 outcome_id NUMBER :=fnd_api.g_miss_num,
212 result_id NUMBER :=fnd_api.g_miss_num,
213 reason_id NUMBER :=fnd_api.g_miss_num,
214 description VARCHAR2(1000) :=fnd_api.g_miss_char,
215 action_id NUMBER :=fnd_api.g_miss_num,
216 interaction_action_type VARCHAR2(240) :=fnd_api.g_miss_char,
217 object_id NUMBER :=fnd_api.g_miss_num,
218 object_type VARCHAR2(30) :=fnd_api.g_miss_char,
219 source_code_id NUMBER :=fnd_api.g_miss_num,
220 source_code VARCHAR2(100) :=fnd_api.g_miss_char,
221 script_trans_id NUMBER :=fnd_api.g_miss_num,
222 attribute1 VARCHAR2(150) :=fnd_api.g_miss_char,
223 attribute2 VARCHAR2(150) :=fnd_api.g_miss_char,
224 attribute3 VARCHAR2(150) :=fnd_api.g_miss_char,
225 attribute4 VARCHAR2(150) :=fnd_api.g_miss_char,
226 attribute5 VARCHAR2(150) :=fnd_api.g_miss_char,
227 attribute6 VARCHAR2(150) :=fnd_api.g_miss_char,
228 attribute7 VARCHAR2(150) :=fnd_api.g_miss_char,
229 attribute8 VARCHAR2(150) :=fnd_api.g_miss_char,
230 attribute9 VARCHAR2(150) :=fnd_api.g_miss_char,
231 attribute10 VARCHAR2(150) :=fnd_api.g_miss_char,
232 attribute11 VARCHAR2(150) :=fnd_api.g_miss_char,
233 attribute12 VARCHAR2(150) :=fnd_api.g_miss_char,
234 attribute13 VARCHAR2(150) :=fnd_api.g_miss_char,
235 attribute14 VARCHAR2(150) :=fnd_api.g_miss_char,
236 attribute15 VARCHAR2(150) :=fnd_api.g_miss_char,
237 attribute_category VARCHAR2(30) :=fnd_api.g_miss_char,
238 -- Removed by IAleshin 06/05/2002
239 -- ,resource_id NUMBER := fnd_api.g_miss_num
240 -- Enh# 2940473
241 bulk_writer_code VARCHAR2(240) := fnd_api.g_miss_char,
242 bulk_batch_type VARCHAR2(240) := fnd_api.g_miss_char,
243 bulk_batch_id NUMBER := fnd_api.g_miss_num,
244 bulk_interaction_id NUMBER := fnd_api.g_miss_num
245 );
246 TYPE activity_tbl_type IS TABLE OF activity_rec_type INDEX BY BINARY_INTEGER;
247
248 FUNCTION INIT_ACTIVITY_REC RETURN activity_rec_type;
249
250 /*#
251 * Creates an Interaction and associated Interaction Activities
252 * and sets the status of the interaction and activities created
253 * to inactive.
254 * @param p_api_version This must match the version number of the API.
255 * An unexpected error is returned if the calling program version number
256 * is incompatible with the current API version number.
257 * @param p_init_msg_list This flag is used to indicate if the message stack
258 * should be initialized. The values that are valid for this parameter are:
259 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
260 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
261 * to the fnd_msg_pub.initialize to initialize the message stack. When
262 * set to 'False', it is the responsibility of the calling program to
263 * initialize the message stack. It is only required that this action be
264 * performed once, even when more than one API is called.
265 * @param p_commit This flag is used to indicate if changes made to the
266 * transaction should be committed on success. The values that are valid
267 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
268 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
269 * before returning to the calling program. When set to 'False', it is the
270 * responsibility of the calling program to commit the transaction.
271 * @param p_resp_appl_id This represents the unique application identifier.
272 * @param p_resp_id This is a unique identifier for the responsibility.
273 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
274 * table and identifies the Oracle Applications user.
275 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
276 * table and identifies the login session.
277 * @param x_return_status This flag is used to indicate the return status
278 * of the API. The values that are valid for this parameter are:
279 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR,
280 * and FND_API.G_RET_STS_UNEXP_ERROR.If the FND_API.G_RET_STS_SUCCESS
281 * value is returned, the API call was successful. If the
282 * FND_API.G_RET_STS_ERROR value is returned, a validation or missing
283 * data error has occurred. If the FND_API.G_RET_STS_UNEXP_ERROR value
287 * message list.
284 * is returned, an unexpected error has occurred and the calling program
285 * cannot correct the error.
286 * @param x_msg_count This represents the count of error messages in the
288 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
289 * @param p_interaction_rec Contains the elements that comprise the
290 * interaction record.
291 * @param p_activities A table of PL/SQL records of type activity_rec_type.
292 * The activities populated in this table will be added to the specified
293 * interaction.
294 * @rep:scope public
295 * @rep:displayname Create Interaction
296 */
297 PROCEDURE Create_Interaction
298 (
299 p_api_version IN NUMBER,
300 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
301 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
302 p_resp_appl_id IN NUMBER DEFAULT NULL,
303 p_resp_id IN NUMBER DEFAULT NULL,
304 p_user_id IN NUMBER,
305 p_login_id IN NUMBER DEFAULT NULL,
306 x_return_status OUT NOCOPY VARCHAR2,
307 x_msg_count OUT NOCOPY NUMBER,
308 x_msg_data OUT NOCOPY VARCHAR2,
309 p_interaction_rec IN interaction_rec_type,
310 p_activities IN activity_tbl_type
311 );
312
313 -- Start of comments
314 -- Procedure : Create_MediaItem
315 -- Type : Public API
316 -- Usage : Creates a media item record in the table
317 -- JTF_IH_MEDIAITEM
318 -- Pre-reqs : None
319 --
320 -- Standard IN Parameters:
321 -- p_api_version IN NUMBER Required
322 -- p_init_msg_list IN VARCHAR2(1) Optional
323 -- Default = FND_API.G_FALSE
324 -- p_commit IN VARCHAR2(1) Optional
325 -- Default = FND_API.G_FALSE
326 --
327 -- Standard OUT Parameters:
328 -- x_return_status OUT VARCHAR2(1)
329 -- x_msg_count OUT NUMBER
330 -- x_msg_data OUT VARCHAR2(2000)
331 --
332 -- MediaItem IN Parameters:
333 -- p_resp_appl_id IN NUMBER Optional(1)
334 -- Application identifier
335 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
336 -- p_resp_id IN NUMBER Optional(1)
337 -- Responsibility identifier
338 -- Default = FND_GLOBAL.RESP_ID or NULL
339 -- p_user_id IN NUMBER Optional
340 -- Corresponds to the column USER_ID in the table
341 -- FND_USER, and identifies the Oracle
342 -- Applications user
343 -- Default = FND_GLOBAL.USER_ID
344 -- p_login_id IN NUMBER Optional
345 -- Corresponds to the column LOGIN_ID in the
346 -- table FND_LOGINS, and identifies the
347 -- login session
348 -- Default = FND_GLOBAL.LOGIN_ID or NULL
349 --
350 -- p_media IN media_rec_type
351 --
352 -- media_rec_type is the structure that captures a media item and has the following attributes:
353 -- media_id NUMBER Mandatory
354 -- source_id NUMBER Optional
355 -- direction VARCHAR2 Optional
356 -- duration NUMBER Optional
357 -- end_date_time DATE Optional
358 -- interaction_performed VARCHAR2 Optional
359 -- start_date_time DATE Optional
360 -- media_data VARCHAR2 Optional
361 -- source_item_create_date_time NUMBER Optional
362 -- source_item_id NUMBER Optional
363 -- media_item_type VARCHAR2 Mandatory
364 -- media_item_ref VARCHAR2 Optional
365 -- media_abandon_flag VARCHAR2 Optional
366 -- media_transferred_flag VARCHAR2 Optional
367 --
368 -- Version : Initial version 1.0
369 --
370 -- Notes :
371 -- (1) The application ID, responsibility ID, and user ID determine which
372 -- profile values are used as default.
373 --
374 -- End of comments
375
376 TYPE media_rec_type IS RECORD
377 (
378 media_id NUMBER :=fnd_api.g_miss_num,
379 source_id NUMBER :=fnd_api.g_miss_num,
380 direction VARCHAR2(240) :=fnd_api.g_miss_char,
381 duration NUMBER :=fnd_api.g_miss_num,
382 end_date_time DATE :=fnd_api.g_miss_date,
383 interaction_performed VARCHAR2(240) :=fnd_api.g_miss_char,
384 start_date_time DATE :=fnd_api.g_miss_date,
385 media_data VARCHAR2(80) :=fnd_api.g_miss_char,
386 source_item_create_date_time DATE :=fnd_api.g_miss_date,
387 source_item_id NUMBER :=fnd_api.g_miss_num,
388 media_item_type VARCHAR2(80) :=fnd_api.g_miss_char,
389 media_item_ref VARCHAR2(240) :=fnd_api.g_miss_char,
390 media_abandon_flag VARCHAR2(1) :=fnd_api.g_miss_char,
391 media_transferred_flag VARCHAR2(1) :=fnd_api.g_miss_char,
392 -- added by IAleshin
393 server_group_id NUMBER :=fnd_api.g_miss_num,
394 dnis VARCHAR2(30) :=fnd_api.g_miss_char,
395 ani VARCHAR2(30) :=fnd_api.g_miss_char,
396 classification VARCHAR2(64) :=fnd_api.g_miss_char,
397 -- Enh# 2940473
398 bulk_writer_code VARCHAR2(240) := fnd_api.g_miss_char,
402 -- Enh# 3022511
399 bulk_batch_type VARCHAR2(240) := fnd_api.g_miss_char,
400 bulk_batch_id NUMBER := fnd_api.g_miss_num,
401 bulk_interaction_id NUMBER := fnd_api.g_miss_num,
403 address VARCHAR2(2000) := fnd_api.g_miss_char
404 );
405 TYPE media_lc_rec_type IS RECORD
406 (
407 start_date_time DATE :=fnd_api.g_miss_date,
408 type_type VARCHAR2(80) :=fnd_api.g_miss_char,
409 type_id NUMBER :=fnd_api.g_miss_num,
410 duration NUMBER :=fnd_api.g_miss_num,
411 end_date_time DATE :=fnd_api.g_miss_date,
412 milcs_id NUMBER :=fnd_api.g_miss_num,
413 milcs_type_id NUMBER :=fnd_api.g_miss_num,
414 media_id NUMBER :=fnd_api.g_miss_num,
415 handler_id NUMBER :=fnd_api.g_miss_num,
416 resource_id NUMBER :=fnd_api.g_miss_num, -- Added by Jim Baldo 30 November 2000 for bugdb 1501325
417 milcs_code VARCHAR2(80) := fnd_api.g_miss_char, -- Added by Jim Baldo 30 November 2000 for bugdb 1501325
418 -- Enh# 2940473
419 bulk_writer_code VARCHAR2(240) := fnd_api.g_miss_char,
420 bulk_batch_type VARCHAR2(240) := fnd_api.g_miss_char,
421 bulk_batch_id NUMBER := fnd_api.g_miss_num,
422 bulk_interaction_id NUMBER := fnd_api.g_miss_num
423 );
424
425 TYPE mlcs_tbl_type IS TABLE OF media_lc_rec_type INDEX BY BINARY_INTEGER;
426
427 /*#
428 * This procedure creates a media item record in the Media Items table and
429 * a media lifecycle record in the Media Lifecycles table, as passed by the
430 * calling application. It sets the status of the Media Item and
431 * Media Lifecycles created to inactive.
432 * @param p_api_version This must match the version number of the API.
433 * An unexpected error is returned if the calling program version number
434 * is incompatible with the current API version number.
435 * @param p_init_msg_list This flag is used to indicate if the message stack
436 * should be initialized. The values that are valid for this parameter are:
437 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
438 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
439 * to the fnd_msg_pub.initialize to initialize the message stack. When
440 * set to 'False', it is the responsibility of the calling program to
441 * initialize the message stack. It is only required that this action be
442 * performed once, even when more than one API is called.
443 * @param p_commit This flag is used to indicate if changes made to the
444 * transaction should be committed on success. The values that are valid
445 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
446 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
447 * before returning to the calling program. When set to 'False', it is the
448 * responsibility of the calling program to commit the transaction.
449 * @param p_resp_appl_id This represents the unique application identifier.
450 * @param p_resp_id This is a unique identifier for the responsibility.
451 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
452 * table and identifies the Oracle Applications user.
453 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
454 * table and identifies the login session.
455 * @param x_return_status This flag is used to indicate the return
456 * status of the API. The values that are valid for this parameter are:
457 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
458 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
459 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
460 * value is returned, a validation or missing data error has occurred. If
461 * the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
462 * has occurred and the calling program cannot correct the error.
463 * @param x_msg_count This represents the count of error messages in the
464 * message list.
465 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
466 * @param p_media A PL/SQL record of type media_rec_type.
467 * The media item values specified in this record will be created
468 * on the specified media item.
469 * @param p_mlcs A PL/SQL record of type media_lc_rec_type.
470 * The Media Item Lifecycle Segment values specified in this record
471 * will be added to the specified Media Item.
472 * @rep:scope internal
473 * @rep:displayname Create Media Item
474 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
475 */
476 PROCEDURE Create_MediaItem
477 (
478 p_api_version IN NUMBER,
479 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
480 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
481 p_resp_appl_id IN NUMBER DEFAULT NULL,
482 p_resp_id IN NUMBER DEFAULT NULL,
483 p_user_id IN NUMBER,
484 p_login_id IN NUMBER DEFAULT NULL,
485 x_return_status OUT NOCOPY VARCHAR2,
486 x_msg_count OUT NOCOPY NUMBER,
487 x_msg_data OUT NOCOPY VARCHAR2,
488 p_media IN media_rec_type,
489 p_mlcs IN mlcs_tbl_type
490 );
491
492 /*#
493 * Creates a Media Item and sets the Media Item status to
494 * indicate that it is inactive.
495 * @param p_api_version This must match the version number of the API.
496 * An unexpected error is returned if the calling program version number
497 * is incompatible with the current API version number.
498 * @param p_init_msg_list This flag is used to indicate if the message stack
499 * should be initialized. The values that are valid for this parameter are:
500 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
504 * initialize the message stack. It is only required that this action be
501 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
502 * to the fnd_msg_pub.initialize to initialize the message stack. When
503 * set to 'False', it is the responsibility of the calling program to
505 * performed once, even when more than one API is called.
506 * @param p_commit This flag is used to indicate if changes made to the
507 * transaction should be committed on success. The values that are valid
508 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
509 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
510 * before returning to the calling program. When set to 'False', it is the
511 * responsibility of the calling program to commit the transaction.
512 * @param p_resp_appl_id This represents the unique application identifier.
513 * @param p_resp_id This is a unique identifier for the responsibility.
514 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
515 * table and identifies the Oracle Applications user.
516 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
517 * table and identifies the login session.
518 * @param x_return_status This flag is used to indicate the return
519 * status of the API. The values that are valid for this parameter are:
520 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
521 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
522 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
523 * value is returned, a validation or missing data error has occurred. If
524 * the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
525 * has occurred and the calling program cannot correct the error.
526 * @param x_msg_count This represents the count of error messages in the
527 * message list.
528 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
529 * @param p_media_rec A PL/SQL record of type media_rec_type. The media item
530 * values specified in this record will be created on the specified media
531 * item.
532 * @param x_media_id This is the record number for the created media
533 * item and is automatically generated by sequence JTF_IH_MEDIA_ITEMS_S1.
534 * @rep:scope public
535 * @rep:displayname Create Media Item
536 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
537 */
538 PROCEDURE Create_MediaItem
539 (
540 p_api_version IN NUMBER,
541 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
542 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
543 p_resp_appl_id IN NUMBER DEFAULT NULL,
544 p_resp_id IN NUMBER DEFAULT NULL,
545 p_user_id IN NUMBER,
546 p_login_id IN NUMBER DEFAULT NULL,
547 x_return_status OUT NOCOPY VARCHAR2,
548 x_msg_count OUT NOCOPY NUMBER,
549 x_msg_data OUT NOCOPY VARCHAR2,
550 p_media_rec IN media_rec_type,
551 x_media_id OUT NOCOPY NUMBER
552 );
553
554 -- Start of comments
555 -- Procedure : Create_MediaLifecycle
556 -- Type : Public API
557 -- Usage : Creates a media lifecycle record in the table
558 -- JTF_IH_MEDIA_ITEM_LC_SEGS
559 -- Pre-reqs : None
560 --
561 -- Standard IN Parameters:
562 -- p_api_version IN NUMBER Required
563 -- p_init_msg_list IN VARCHAR2(1) Optional
564 -- Default = FND_API.G_FALSE
565 -- p_commit IN VARCHAR2(1) Optional
566 -- Default = FND_API.G_FALSE
567 --
568 -- Standard OUT Parameters:
569 -- x_return_status OUT VARCHAR2(1)
570 -- x_msg_count OUT NUMBER
571 -- x_msg_data OUT VARCHAR2(2000)
572 --
573 -- MediaItem IN Parameters:
574 -- p_resp_appl_id IN NUMBER Optional(1)
575 -- Application identifier
576 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
577 -- p_resp_id IN NUMBER Optional(1)
578 -- Responsibility identifier
579 -- Default = FND_GLOBAL.RESP_ID or NULL
580 -- p_user_id IN NUMBER Optional
581 -- Corresponds to the column USER_ID in the table
582 -- FND_USER, and identifies the Oracle
583 -- Applications user
584 -- Default = FND_GLOBAL.USER_ID
585 -- p_login_id IN NUMBER Optional
586 -- Corresponds to the column LOGIN_ID in the
587 -- table FND_LOGINS, and identifies the
588 -- login session
589 -- Default = FND_GLOBAL.LOGIN_ID or NULL
590 --
591 -- p_media_lc_rec IN media_lc_rec_type
592 --
593 -- media_lc_rec_type is the structure that captures a media lifecycle and has the following attributes:
594 -- start_date_time DATE
595 -- type_type VARCHAR2(80)
596 -- type_id NUMBER
597 -- duration NUMBER
598 -- end_date_time DATE
599 -- milcs_id NUMBER
600 -- milcs_type_id NUMBER REQUIRED
601 -- media_id NUMBER REQUIRED
602 -- handler_id NUMBER
603 -- resource_id NUMBER
604 --
605 -- Version : Initial version 1.0
606 --
607 -- Notes :
611 -- End of comments
608 -- (1) The application ID, responsibility ID, and user ID determine which
609 -- profile values are used as default.
610 --
612
613 /*#
614 * This procedure creates a media lifecycle record in the Media Lifecycle
615 * table, and sets it to inactive.
616 * @param p_api_version This must match the version number of the API.
617 * An unexpected error is returned if the calling program version number
618 * is incompatible with the current API version number.
619 * @param p_init_msg_list This flag is used to indicate if the message stack
620 * should be initialized. The values that are valid for this parameter are:
621 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
622 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
623 * to the fnd_msg_pub.initialize to initialize the message stack. When
624 * set to 'False', it is the responsibility of the calling program to
625 * initialize the message stack. It is only required that this action be
626 * performed once, even when more than one API is called.
627 * @param p_commit This flag is used to indicate if changes made to the
628 * transaction should be committed on success. The values that are valid
629 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
630 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
631 * before returning to the calling program. When set to 'False', it is the
632 * responsibility of the calling program to commit the transaction.
633 * @param p_resp_appl_id This represents the unique application identifier.
634 * @param p_resp_id This is a unique identifier for the responsibility.
635 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
636 * table and identifies the Oracle Applications user.
637 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
638 * table and identifies the login session.
639 * @param x_return_status This flag is used to indicate the return status
640 * of the API. The values that are valid for this parameter are:
641 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
642 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
643 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
644 * value is returned, a validation or missing data error has occurred. If
645 * the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
646 * has occurred and the calling program cannot correct the error.
647 * @param x_msg_count This represents the count of error messages in the
648 * message list.
649 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
650 * @param p_media_lc_rec This is a composite record that enumerates the
651 * elements that comprise a media lifecycle.
652 * @rep:scope internal
653 * @rep:displayname Create Media Lifecycle
654 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
655 */
656 PROCEDURE Create_MediaLifecycle
657 (
658 p_api_version IN NUMBER,
659 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
660 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
661 p_resp_appl_id IN NUMBER DEFAULT NULL,
662 p_resp_id IN NUMBER DEFAULT NULL,
663 p_user_id IN NUMBER,
664 p_login_id IN NUMBER DEFAULT NULL,
665 x_return_status OUT NOCOPY VARCHAR2,
666 x_msg_count OUT NOCOPY NUMBER,
667 x_msg_data OUT NOCOPY VARCHAR2,
668 p_media_lc_rec IN media_lc_rec_type
669 );
670
671 -- Start of comments
672 -- Procedure : Get_InteractionActivityCount
673 -- Type : Public API
674 -- Usage : Get the interaction activity count from JTF_IH_ACTIVITY based on the input parameters
675 -- Pre-reqs : None
676 --
677 -- Standard IN Parameters:
678 -- p_api_version IN NUMBER Required
679 -- p_init_msg_list IN VARCHAR2(1) Optional
680 -- Default = FND_API.G_FALSE
681 --
682 -- Standard OUT Parameters:
683 -- x_return_status OUT VARCHAR2(1)
684 -- x_msg_count OUT NUMBER
685 -- x_msg_data OUT VARCHAR2(2000)
686 --
687 -- Customer Interaction IN Parameters:
688 -- p_resp_appl_id IN NUMBER Optional(1)
689 -- Application identifier
690 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
691 -- p_resp_id IN NUMBER Optional(1)
692 -- Responsibility identifier
693 -- Default = FND_GLOBAL.RESP_ID or NULL
694 -- p_user_id IN NUMBER Optional
695 -- Corresponds to the column USER_ID in the
696 -- table FND_USER, and identifies the Oracle
697 -- Applications user
698 -- Default = FND_GLOBAL.USER_ID
699 -- p_login_id IN NUMBER Optional
700 -- Corresponds to the column LOGIN_ID in the
701 -- table FND_LOGINS, and identifies
702 -- the login session
703 -- Default = FND_GLOBAL.LOGIN_ID or NULL
704 -- p_outcome_id IN NUMBER Optional
705 -- p_result_id IN NUMBER Optional
706 -- p_reason_id IN NUMBER Optional
707 -- p_script_id IN NUMBER Optional
708 -- p_media_id IN NUMBER Optional
709 -- Activity Count OUT Parameters
710 -- x_activity_count OUT NUMBER
711 -- the number of the activity record that
715 --
712 -- match the search criteria
713 --
714 -- Version : Initial version 1.0
716 -- Notes :
717 -- (1) The application ID, responsibility ID, and user ID determine which
718 -- profile values are used as default.
719 --
720 -- End of comments
721
722 /*#
723 * This procedure retrieves the interaction activity count from
724 * the Activities table based on the criteria passed in the
725 * defined parameters.
726 * @param p_api_version This must match the version number of the API.
727 * An unexpected error is returned if the calling program version number
728 * is incompatible with the current API version number.
729 * @param p_init_msg_list This flag is used to indicate if the message stack
730 * should be initialized. The values that are valid for this parameter are:
731 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
732 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
733 * to the fnd_msg_pub.initialize to initialize the message stack. When
734 * set to 'False', it is the responsibility of the calling program to
735 * initialize the message stack. It is only required that this action be
736 * performed once, even when more than one API is called.
737 * @param p_resp_appl_id This represents the unique application identifier.
738 * @param p_resp_id This is a unique identifier for the responsibility.
739 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
740 * table and identifies the Oracle Applications user.
741 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
742 * table and identifies the login session.
743 * @param x_return_status This flag is used to indicate the return
744 * status of the API. The values that are valid for this parameter are:
745 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
746 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
747 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
748 * value is returned, a validation or missing data error has occurred.
749 * If the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected
750 * error has occurred and the calling program cannot correct the error.
751 * @param x_msg_count This represents the count of error messages in the
752 * message list.
753 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
754 * @param p_outcome_id This is a unique, sequence-generated identifier.
755 * @param p_result_id This is a unique identifier that corresponds to
756 * a certain result.
757 * @param p_reason_id This is a unique identifier that corresponds
758 * to a certain reason.
759 * @param p_script_id The identifier of the script/survey used
760 * during the interaction.
761 * @param p_media_id This is a unique, sequence-generated identifier
762 * for the media.
763 * @param x_activity_count This corresponds to the number of
764 * interactions and activities found that match the search criteria.
765 * @rep:scope internal
766 * @rep:displayname Get Interaction Activity Count
767 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
768 */
769 PROCEDURE Get_InteractionActivityCount
770 (
771 p_api_version IN NUMBER,
772 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
773 p_resp_appl_id IN NUMBER DEFAULT NULL,
774 p_resp_id IN NUMBER DEFAULT NULL,
775 p_user_id IN NUMBER,
776 p_login_id IN NUMBER DEFAULT NULL,
777 x_return_status OUT NOCOPY VARCHAR2,
778 x_msg_count OUT NOCOPY NUMBER,
779 x_msg_data OUT NOCOPY VARCHAR2,
780 p_outcome_id IN NUMBER,
781 p_result_id IN NUMBER,
782 p_reason_id IN NUMBER,
783 p_script_id IN NUMBER,
784 p_media_id IN NUMBER,
785 x_activity_count OUT NOCOPY NUMBER
786 );
787
788 -- Start of comments
789 -- Procedure : Get_InteractionCount
790 -- Type : Public API
791 -- Usage : Get the interaction count from JTF_IH_INTERACTIONS based on the input parameters
792 -- Pre-reqs : None
793 --
794 -- Standard IN Parameters:
795 -- p_api_version IN NUMBER Required
796 -- p_init_msg_list IN VARCHAR2(1) Optional
797 -- Default = FND_API.G_FALSE
798 --
799 -- Standard OUT Parameters:
800 -- x_return_status OUT VARCHAR2(1)
801 -- x_msg_count OUT NUMBER
802 -- x_msg_data OUT VARCHAR2(2000)
803 --
804 -- Interaction count IN Parameters:
805 -- p_resp_appl_id IN NUMBER Optional(1)
806 -- Application identifier
807 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
808 -- p_resp_id IN NUMBER Optional(1)
809 -- Responsibility identifier
810 -- Default = FND_GLOBAL.RESP_ID or NULL
811 -- p_user_id IN NUMBER Optional
812 -- Corresponds to the column USER_ID in
813 -- the table FND_USER, and identifies the
814 -- Oracle Applications user
815 -- Default = FND_GLOBAL.USER_ID
816 -- p_login_id IN NUMBER Optional
817 -- Corresponds to the column LOGIN_ID in the
818 -- table FND_LOGINS, and identifies the login session
819 -- Default = FND_GLOBAL.LOGIN_ID or NULL
820 -- p_outcome_id IN NUMBER Optional
824 -- Customer interaction descriptive flexfield segments 1-15
821 -- p_result_id IN NUMBER Optional
822 -- p_reason_id IN NUMBER Optional
823 -- p_attribute1 IN VARCHAR2(150) Optional(2)
825 -- p_attribute2 IN VARCHAR2(150) Optional(2)
826 -- p_attribute3 IN VARCHAR2(150) Optional(2)
827 -- p_attribute4 IN VARCHAR2(150) Optional(2)
828 -- p_attribute5 IN VARCHAR2(150) Optional(2)
829 -- p_attribute6 IN VARCHAR2(150) Optional(2)
830 -- p_attribute7 IN VARCHAR2(150) Optional(2)
831 -- p_attribute8 IN VARCHAR2(150) Optional(2)
832 -- p_attribute9 IN VARCHAR2(150) Optional(2)
833 -- p_attribute10 IN VARCHAR2(150) Optional(2)
834 -- p_attribute11 IN VARCHAR2(150) Optional(2)
835 -- p_attribute12 IN VARCHAR2(150) Optional(2)
836 -- p_attribute13 IN VARCHAR2(150) Optional(2)
837 -- p_attribute14 IN VARCHAR2(150) Optional(2)
838 -- p_attribute15 IN VARCHAR2(150) Optional(2)
839 -- p_attribute_category IN VARCHAR2(30) Optional(2)
840 -- Descriptive flexfield structure defining column
841 --
842 -- Interaction Count OUT Parameters
843 -- x_interaction_count OUT NUMBER
844 -- the number of the interaction record that match the search criteria
845 --
846 -- Version : Initial version 1.0
847 --
848 -- Notes :
849 -- (1) The application ID, responsibility ID, and user ID determine which
850 -- profile values are used as default.
851 -- (2) You must pass in segment IDs for none or all descriptive flexfield
852 -- columns that might be used in the descriptive flexfield.
853 --
854 -- End of comments
855
856 /*#
857 * This procedure retrieves the interaction count from table Interactions
858 * table, as determined by the criteria passed in the defined parameters.
859 * @param p_api_version This must match the version number of the API.
860 * An unexpected error is returned if the calling program version number
861 * is incompatible with the current API version number.
862 * @param p_init_msg_list This flag is used to indicate if the message stack
863 * should be initialized. The values that are valid for this parameter are:
864 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
865 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
866 * to the fnd_msg_pub.initialize to initialize the message stack. When
867 * set to 'False', it is the responsibility of the calling program to
868 * initialize the message stack. It is only required that this action be
869 * performed once, even when more than one API is called.
870 * @param p_resp_appl_id This represents the unique application identifier.
871 * @param p_resp_id This is a unique identifier for the responsibility.
872 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
873 * table and identifies the Oracle Applications user.
874 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
875 * table and identifies the login session.
876 * @param x_return_status This flag is used to indicate the return
877 * status of the API. The values that are valid for this parameter are:
878 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
879 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
880 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
881 * value is returned, a validation or missing data error has occurred.
882 * If the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
883 * has occurred and the calling program cannot correct the error.
884 * @param x_msg_count This represents the count of error messages in the
885 * message list.
886 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
887 * @param p_outcome_id This is a unique, sequence-generated identifier.
888 * @param p_result_id This is a unique identifier that corresponds to
889 * a certain result.
890 * @param p_reason_id This is a unique identifier that corresponds
891 * to a certain reason.
892 * @param p_attribute1 Customer flex field segment
893 * @param p_attribute2 Customer flex field segment
894 * @param p_attribute3 Customer flex field segment
895 * @param p_attribute4 Customer flex field segment
896 * @param p_attribute5 Customer flex field segment
897 * @param p_attribute6 Customer flex field segment
898 * @param p_attribute7 Customer flex field segment
899 * @param p_attribute8 Customer flex field segment
900 * @param p_attribute9 Customer flex field segment
901 * @param p_attribute10 Customer flex field segment
902 * @param p_attribute11 Customer flex field segment
903 * @param p_attribute12 Customer flex field segment
904 * @param p_attribute13 Customer flex field segment
905 * @param p_attribute14 Customer flex field segment
906 * @param p_attribute15 Customer flex field segment
907 * @param p_attribute_category The attribute category code.
908 * @param x_interaction_count The count of the number of
909 * interactions matching the specified criteria.
910 * @rep:scope internal
911 * @rep:displayname Get Interaction Count
912 */
913 PROCEDURE Get_InteractionCount
914 (
915 p_api_version IN NUMBER,
916 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
917 p_resp_appl_id IN NUMBER DEFAULT NULL,
918 p_resp_id IN NUMBER DEFAULT NULL,
919 p_user_id IN NUMBER,
920 p_login_id IN NUMBER DEFAULT NULL,
921 x_return_status OUT NOCOPY VARCHAR2,
922 x_msg_count OUT NOCOPY NUMBER,
923 x_msg_data OUT NOCOPY VARCHAR2,
927 p_attribute1 IN VARCHAR2 DEFAULT NULL,
924 p_outcome_id IN NUMBER,
925 p_result_id IN NUMBER,
926 p_reason_id IN NUMBER,
928 p_attribute2 IN VARCHAR2 DEFAULT NULL,
929 p_attribute3 IN VARCHAR2 DEFAULT NULL,
930 p_attribute4 IN VARCHAR2 DEFAULT NULL,
931 p_attribute5 IN VARCHAR2 DEFAULT NULL,
932 p_attribute6 IN VARCHAR2 DEFAULT NULL,
933 p_attribute7 IN VARCHAR2 DEFAULT NULL,
934 p_attribute8 IN VARCHAR2 DEFAULT NULL,
935 p_attribute9 IN VARCHAR2 DEFAULT NULL,
936 p_attribute10 IN VARCHAR2 DEFAULT NULL,
937 p_attribute11 IN VARCHAR2 DEFAULT NULL,
938 p_attribute12 IN VARCHAR2 DEFAULT NULL,
939 p_attribute13 IN VARCHAR2 DEFAULT NULL,
940 p_attribute14 IN VARCHAR2 DEFAULT NULL,
941 p_attribute15 IN VARCHAR2 DEFAULT NULL,
942 p_attribute_category IN VARCHAR2 DEFAULT NULL,
943 x_interaction_count OUT NOCOPY NUMBER
944 );
945
946 -- Start of comments
947 -- Procedure : Open_Interaction -- created by Jean Zhu 01/11/2000
948 -- Type : Public API
949 -- Usage : This API servers as the basis for providing a caching mechanism during the creation of
950 -- an Interaction.
951 -- Pre-reqs : None
952 --
953 -- Standard IN Parameters:
954 -- p_api_version IN NUMBER Required
955 -- p_init_msg_list IN VARCHAR2(1) Optional
956 -- Default = FND_API.G_FALSE
957 --
958 -- Standard OUT Parameters:
959 -- x_return_status OUT VARCHAR2(1)
960 -- x_msg_count OUT NUMBER
961 -- x_msg_data OUT VARCHAR2(2000)
962 --
963 -- Interaction count IN Parameters:
964 -- p_resp_appl_id IN NUMBER Optional(1)
965 --
966 -- Application identifier
967 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
968 -- p_resp_id IN NUMBER Optional(1)
969 -- Responsibility identifier
970 -- Default = FND_GLOBAL.RESP_ID or NULL
971 -- p_user_id IN NUMBER Optional
972 -- Corresponds to the column USER_ID in
973 -- the table FND_USER, and identifies the
974 -- Oracle Applications user
975 -- Default = FND_GLOBAL.USER_ID
976 -- p_login_id IN NUMBER Optional
977 -- Corresponds to the column LOGIN_ID in the
978 -- table FND_LOGINS, and identifies the login session
979 --
980 -- Default = FND_GLOBAL.LOGIN_ID or NULL
981 -- p_interaction_rec IN interaction_rec_type
982 --
983 -- Interaction_Id OUT Parameters
984 -- x_interaction_id OUT NUMBER
985 -- the id of the new interaction record
986 --
987 -- Version : Initial version 1.0
988 --
989 -- Notes :
990 -- (1) The application ID, responsibility ID, and user ID determine which
991 -- profile values are used as default.
992 -- (2) You must pass in segment IDs for none or all descriptive flexfield
993 -- columns that might be used in the descriptive flexfield.
994 --
995 -- End of comments
996
997 /*#
998 * Creates an Interaction and sets the status of the Interaction
999 * to active.
1000 * @param p_api_version This must match the version number of the API.
1001 * An unexpected error is returned if the calling program version number
1002 * is incompatible with the current API version number.
1003 * @param p_init_msg_list This flag is used to indicate if the message stack
1004 * should be initialized. The values that are valid for this parameter are:
1005 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
1006 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
1007 * to the fnd_msg_pub.initialize to initialize the message stack. When
1008 * set to 'False', it is the responsibility of the calling program to
1009 * initialize the message stack. It is only required that this action be
1010 * performed once, even when more than one API is called.
1011 * @param p_commit This flag is used to indicate if changes made to the
1012 * transaction should be committed on success. The values that are valid
1013 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
1014 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
1015 * before returning to the calling program. When set to 'False', it is the
1016 * responsibility of the calling program to commit the transaction.
1017 * @param p_resp_appl_id This represents the unique application identifier.
1018 * @param p_resp_id This is a unique identifier for the responsibility.
1019 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
1020 * table and identifies the Oracle Applications user.
1021 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
1022 * table and identifies the login session.
1023 * @param x_return_status This flag is used to indicate the return status
1024 * of the API. The values that are valid for this parameter are:
1025 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
1026 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
1027 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
1028 * value is returned, a validation or missing data error has occurred.
1029 * If the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
1033 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
1030 * has occurred and the calling program cannot correct the error.
1031 * @param x_msg_count This represents the count of error messages in the
1032 * message list.
1034 * @param p_interaction_rec Contains the elements that comprise the
1035 * interaction record.
1036 * @param x_interaction_id This is the unique, sequence-generated
1037 * identifier that is sent to the calling application when a generic
1038 * interaction record is inserted in the Interactions table for updating.
1039 * @rep:scope public
1040 * @rep:displayname Open Interaction
1041 */
1042 PROCEDURE Open_Interaction
1043 (
1044 p_api_version IN NUMBER,
1045 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1046 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1047 p_resp_appl_id IN NUMBER DEFAULT NULL,
1048 p_resp_id IN NUMBER DEFAULT NULL,
1049 p_user_id IN NUMBER,
1050 p_login_id IN NUMBER DEFAULT NULL,
1051 x_return_status OUT NOCOPY VARCHAR2,
1052 x_msg_count OUT NOCOPY NUMBER,
1053 x_msg_data OUT NOCOPY VARCHAR2,
1054 p_interaction_rec IN interaction_rec_type,
1055 x_interaction_id OUT NOCOPY NUMBER
1056 );
1057
1058 -- Start of comments
1059 -- Procedure : Update_Interaction -- created by Jean Zhu 01/11/2000
1060 -- Type : Public API
1061 -- Usage : This API servers as the basis for providing a caching mechanism during the active of
1062 -- an Interaction.
1063 -- Pre-reqs : None
1064 --
1065 -- Standard IN Parameters:
1066 -- p_api_version IN NUMBER Required
1067 -- p_init_msg_list IN VARCHAR2(1) Optional
1068 -- Default = FND_API.G_FALSE
1069 --
1070 -- Standard OUT Parameters:
1071 -- x_return_status OUT VARCHAR2(1)
1072 -- x_msg_count OUT NUMBER
1073 -- x_msg_data OUT VARCHAR2(2000)
1074 --
1075 -- Interaction count IN Parameters:
1076 -- p_resp_appl_id IN NUMBER Optional(1)
1077 --
1078 -- Application identifier
1079 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
1080 -- p_resp_id IN NUMBER Optional(1)
1081 -- Responsibility identifier
1082 -- Default = FND_GLOBAL.RESP_ID or NULL
1083 -- p_user_id IN NUMBER Optional
1084 -- Corresponds to the column USER_ID in
1085 -- the table FND_USER, and identifies the
1086 -- Oracle Applications user
1087 -- Default = FND_GLOBAL.USER_ID
1088 -- p_login_id IN NUMBER Optional
1089 -- Corresponds to the column LOGIN_ID in the
1090 -- table FND_LOGINS, and identifies the login session
1091 --
1092 -- Default = FND_GLOBAL.LOGIN_ID or NULL
1093 -- p_interaction_rec IN interaction_rec_type
1094 --
1095 --
1096 -- Version : Initial version 1.0
1097 --
1098 -- Notes :
1099 -- (1) The application ID, responsibility ID, and user ID determine which
1100 -- profile values are used as default.
1101 -- (2) You must pass in segment IDs for none or all descriptive flexfield
1102 -- columns that might be used in the descriptive flexfield.
1103 --
1104 -- End of comments
1105 /*#
1106 * Updates an active Interaction.
1107 * The record remains in an active status.
1108 * @param p_api_version This must match the version number of the API.
1109 * An unexpected error is returned if the calling program version number
1110 * is incompatible with the current API version number.
1111 * @param p_init_msg_list This flag is used to indicate if the message stack
1112 * should be initialized. The values that are valid for this parameter are:
1113 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
1114 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
1115 * to the fnd_msg_pub.initialize to initialize the message stack. When
1116 * set to 'False', it is the responsibility of the calling program to
1117 * initialize the message stack. It is only required that this action be
1118 * performed once, even when more than one API is called.
1119 * @param p_commit This flag is used to indicate if changes made to the
1120 * transaction should be committed on success. The values that are valid
1121 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
1122 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
1123 * before returning to the calling program. When set to 'False', it is the
1124 * responsibility of the calling program to commit the transaction.
1125 * @param p_resp_appl_id This represents the unique application identifier.
1126 * @param p_resp_id This is a unique identifier for the responsibility.
1127 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
1128 * table and identifies the Oracle Applications user.
1129 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
1130 * table and identifies the login session.
1131 * @param x_return_status This flag is used to indicate the return status
1132 * of the API. The values that are valid for this parameter are:
1133 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
1134 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
1135 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
1139 * @param x_msg_count This represents the count of error messages in the
1136 * value is returned, a validation or missing data error has occurred. If
1137 * the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
1138 * has occurred and the calling program cannot correct the error.
1140 * message list.
1141 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
1142 * @param p_interaction_rec Contains the elements that comprise the
1143 * interaction record.
1144 * @param p_object_version The version number of the record to be updated.
1145 * @rep:scope public
1146 * @rep:displayname Update Interaction
1147 */
1148 PROCEDURE Update_Interaction
1149 (
1150 p_api_version IN NUMBER,
1151 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1152 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1153 p_resp_appl_id IN NUMBER DEFAULT NULL,
1154 p_resp_id IN NUMBER DEFAULT NULL,
1155 p_user_id IN NUMBER,
1156 p_login_id IN NUMBER DEFAULT NULL,
1157 x_return_status OUT NOCOPY VARCHAR2,
1158 x_msg_count OUT NOCOPY NUMBER,
1159 x_msg_data OUT NOCOPY VARCHAR2,
1160 p_interaction_rec IN interaction_rec_type,
1161 -- Bug# 2012159
1162 p_object_version IN NUMBER DEFAULT NULL
1163 );
1164
1165 -- Start of comments
1166 -- Procedure : Close_Interaction -- created by Jean Zhu 01/11/2000
1167 -- Type : Public API
1168 -- Usage : This API servers as the basis for providing a caching mechanism during the final of
1169 -- an Interaction.
1170 -- Pre-reqs : None
1171 --
1172 -- Standard IN Parameters:
1173 -- p_api_version IN NUMBER Required
1174 -- p_init_msg_list IN VARCHAR2(1) Optional
1175 -- Default = FND_API.G_FALSE
1176 --
1177 -- Standard OUT Parameters:
1178 -- x_return_status OUT VARCHAR2(1)
1179 -- x_msg_count OUT NUMBER
1180 -- x_msg_data OUT VARCHAR2(2000)
1181 --
1182 -- Interaction count IN Parameters:
1183 -- p_resp_appl_id IN NUMBER Optional(1)
1184 --
1185 -- Application identifier
1186 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
1187 -- p_resp_id IN NUMBER Optional(1)
1188 -- Responsibility identifier
1189 -- Default = FND_GLOBAL.RESP_ID or NULL
1190 -- p_user_id IN NUMBER Optional
1191 -- Corresponds to the column USER_ID in
1192 -- the table FND_USER, and identifies the
1193 -- Oracle Applications user
1194 -- Default = FND_GLOBAL.USER_ID
1195 -- p_login_id IN NUMBER Optional
1196 -- Corresponds to the column LOGIN_ID in the
1197 -- table FND_LOGINS, and identifies the login session
1198 --
1199 -- Default = FND_GLOBAL.LOGIN_ID or NULL
1200 -- p_interaction_rec IN interaction_rec_type
1201 -- used in update interaction record
1202 --
1203 -- Version : Initial version 1.0
1204 --
1205 -- Notes :
1206 -- (1) The application ID, responsibility ID, and user ID determine which
1207 -- profile values are used as default.
1208 -- (2) You must pass in segment IDs for none or all descriptive flexfield
1209 -- columns that might be used in the descriptive flexfield.
1210 --
1211 -- End of comments
1212
1213 /*#
1214 * Updates and then closes an Interaction by setting the
1215 * Interaction status to indicate that it is inactive.
1216 * @param p_api_version This must match the version number of the API.
1217 * An unexpected error is returned if the calling program version number
1218 * is incompatible with the current API version number.
1219 * @param p_init_msg_list This flag is used to indicate if the message stack
1220 * should be initialized. The values that are valid for this parameter are:
1221 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
1222 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
1223 * to the fnd_msg_pub.initialize to initialize the message stack. When
1224 * set to 'False', it is the responsibility of the calling program to
1225 * initialize the message stack. It is only required that this action be
1226 * performed once, even when more than one API is called.
1227 * @param p_commit This flag is used to indicate if changes made to the
1228 * transaction should be committed on success. The values that are valid
1229 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
1230 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
1231 * before returning to the calling program. When set to 'False', it is the
1232 * responsibility of the calling program to commit the transaction.
1233 * @param p_resp_appl_id This represents the unique application identifier.
1234 * @param p_resp_id This is a unique identifier for the responsibility.
1235 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
1236 * table and identifies the Oracle Applications user.
1237 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
1238 * table and identifies the login session.
1239 * @param x_return_status This flag is used to indicate the return status
1240 * of the API. The values that are valid for this parameter are:
1241 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
1242 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value is
1243 * returned, the API call was successful. If the FND_API.G_RET_STS_ERROR value
1244 * is returned, a validation or missing data error has occurred. If the
1245 * FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
1246 * has occurred and the calling program cannot correct the error.
1247 * @param x_msg_count This represents the count of error messages in the
1248 * message list.
1249 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
1250 * @param p_interaction_rec Contains the elements that comprise the
1251 * interaction record.
1252 * @param p_object_version The version number of the record to be updated.
1253 * @rep:scope public
1254 * @rep:displayname Update and Close Interaction
1255 */
1256 PROCEDURE Close_Interaction
1257 (
1258 p_api_version IN NUMBER,
1259 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1260 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1261 p_resp_appl_id IN NUMBER DEFAULT NULL,
1262 p_resp_id IN NUMBER DEFAULT NULL,
1263 p_user_id IN NUMBER,
1264 p_login_id IN NUMBER DEFAULT NULL,
1265 x_return_status OUT NOCOPY VARCHAR2,
1266 x_msg_count OUT NOCOPY NUMBER,
1267 x_msg_data OUT NOCOPY VARCHAR2,
1268 p_interaction_rec IN interaction_rec_type,
1269 p_object_version IN NUMBER DEFAULT NULL
1270 );
1271
1272 -- Start of comments
1273 -- Procedure : Add_Activity -- created by Jean Zhu 01/11/2000
1274 -- Type : Public API
1275 -- Usage : This API servers as the basis for providing a caching mechanism
1276 -- during the creation of an activity after some interaction happen.
1277 -- Pre-reqs : None
1278 --
1279 -- Standard IN Parameters:
1280 -- p_api_version IN NUMBER Required
1281 -- p_init_msg_list IN VARCHAR2(1) Optional
1282 -- Default = FND_API.G_FALSE
1283 --
1284 -- Standard OUT Parameters:
1285 -- x_return_status OUT VARCHAR2(1)
1286 -- x_msg_count OUT NUMBER
1287 -- x_msg_data OUT VARCHAR2(2000)
1288 --
1289 -- Interaction count IN Parameters:
1290 -- p_resp_appl_id IN NUMBER Optional(1)
1291 --
1292 -- Application identifier
1293 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
1294 -- p_resp_id IN NUMBER Optional(1)
1295 -- Responsibility identifier
1296 -- Default = FND_GLOBAL.RESP_ID or NULL
1297 -- p_user_id IN NUMBER Optional
1298 -- Corresponds to the column USER_ID in
1299 -- the table FND_USER, and identifies the
1300 -- Oracle Applications user
1301 -- Default = FND_GLOBAL.USER_ID
1302 -- p_login_id IN NUMBER Optional
1303 -- Corresponds to the column LOGIN_ID in the
1304 -- table FND_LOGINS, and identifies the login session
1305 --
1306 -- Default = FND_GLOBAL.LOGIN_ID or NULL
1307 -- p_activity_rec IN activity_rec_type
1308 --
1309 -- Activity_Id OUT Parameters
1310 -- x_activity_id OUT NUMBER
1311 -- the id of the new activity record
1312 --
1313 -- Version : Initial version 1.0
1314 --
1315 -- Notes :
1316 -- (1) The application ID, responsibility ID, and user ID determine which
1317 -- profile values are used as default.
1318 -- (2) You must pass in segment IDs for none or all descriptive flexfield
1319 -- columns that might be used in the descriptive flexfield.
1320 --
1321 -- End of comments
1322 /*#
1323 * Creates an Interaction Activity for an Open Interaction.
1324 * @param p_api_version This must match the version number of the API.
1325 * An unexpected error is returned if the calling program version number
1326 * is incompatible with the current API version number.
1327 * @param p_init_msg_list This flag is used to indicate if the message stack
1328 * should be initialized. The values that are valid for this parameter are:
1329 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
1330 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
1331 * to the fnd_msg_pub.initialize to initialize the message stack. When
1332 * set to 'False', it is the responsibility of the calling program to
1333 * initialize the message stack. It is only required that this action be
1334 * performed once, even when more than one API is called.
1335 * @param p_commit This flag is used to indicate if changes made to the
1336 * transaction should be committed on success. The values that are valid
1337 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
1338 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
1342 * @param p_resp_id This is a unique identifier for the responsibility.
1339 * before returning to the calling program. When set to 'False', it is the
1340 * responsibility of the calling program to commit the transaction.
1341 * @param p_resp_appl_id This represents the unique application identifier.
1343 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
1344 * table and identifies the Oracle Applications user.
1345 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
1346 * table and identifies the login session.
1347 * @param x_return_status This flag is used to indicate the return
1348 * status of the API. The values that are valid for this parameter are:
1349 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
1350 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
1351 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
1352 * value is returned, a validation or missing data error has occurred. If
1353 * the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
1354 * has occurred and the calling program cannot correct the error.
1355 * @param x_msg_count This represents the count of error messages in the
1356 * message list.
1357 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
1358 * @param p_activity_rec A PL/SQL record of type activity_rec_type.
1359 * The activity values specified in this record will be added to
1360 * the specified Interaction.
1361 * @param x_activity_id This is the unique, sequence-generated
1362 * identifier that is sent from the API to the calling application.
1363 * @rep:scope public
1364 * @rep:displayname Create Interaction Activity
1365 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
1366 */
1367 PROCEDURE Add_Activity
1368 (
1369 p_api_version IN NUMBER,
1370 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1371 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1372 p_resp_appl_id IN NUMBER DEFAULT NULL,
1373 p_resp_id IN NUMBER DEFAULT NULL,
1374 p_user_id IN NUMBER,
1375 p_login_id IN NUMBER DEFAULT NULL,
1376 x_return_status OUT NOCOPY VARCHAR2,
1377 x_msg_count OUT NOCOPY NUMBER,
1378 x_msg_data OUT NOCOPY VARCHAR2,
1379 p_activity_rec IN activity_rec_type,
1380 x_activity_id OUT NOCOPY NUMBER
1381 );
1382
1383 -- Start of comments
1384 -- Procedure : Update_Activity -- created by Jean Zhu 01/11/2000
1385 -- Type : Public API
1386 -- Usage : This API servers as the basis for providing a caching mechanism
1387 -- during the active of an activity
1388 -- Pre-reqs : None
1389 --
1390 -- Standard IN Parameters:
1391 -- p_api_version IN NUMBER Required
1395 -- Standard OUT Parameters:
1392 -- p_init_msg_list IN VARCHAR2(1) Optional
1393 -- Default = FND_API.G_FALSE
1394 --
1396 -- x_return_status OUT VARCHAR2(1)
1397 -- x_msg_count OUT NUMBER
1398 -- x_msg_data OUT VARCHAR2(2000)
1399 --
1400 -- Interaction count IN Parameters:
1401 -- p_resp_appl_id IN NUMBER Optional(1)
1402 --
1403 -- Application identifier
1404 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
1405 -- p_resp_id IN NUMBER Optional(1)
1406 -- Responsibility identifier
1407 -- Default = FND_GLOBAL.RESP_ID or NULL
1408 -- p_user_id IN NUMBER Optional
1409 -- Corresponds to the column USER_ID in
1410 -- the table FND_USER, and identifies the
1411 -- Oracle Applications user
1412 -- Default = FND_GLOBAL.USER_ID
1413 -- p_login_id IN NUMBER Optional
1414 -- Corresponds to the column LOGIN_ID in the
1415 -- table FND_LOGINS, and identifies the login session
1416 --
1417 -- Default = FND_GLOBAL.LOGIN_ID or NULL
1418 -- p_activity_rec IN activity_rec_type
1419 --
1420 --
1421 -- Version : Initial version 1.0
1422 --
1423 -- Notes :
1424 -- (1) The application ID, responsibility ID, and user ID determine which
1425 -- profile values are used as default.
1426 -- (2) You must pass in segment IDs for none or all descriptive flexfield
1427 -- columns that might be used in the descriptive flexfield.
1428 --
1429 -- End of comments
1430 /*#
1431 * Updates an Interaction Activity for an Open Interaction.
1432 * @param p_api_version This must match the version number of the API.
1433 * An unexpected error is returned if the calling program version number
1434 * is incompatible with the current API version number.
1435 * @param p_init_msg_list This flag is used to indicate if the message stack
1436 * should be initialized. The values that are valid for this parameter are:
1437 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
1438 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
1439 * to the fnd_msg_pub.initialize to initialize the message stack. When
1440 * set to 'False', it is the responsibility of the calling program to
1441 * initialize the message stack. It is only required that this action be
1442 * performed once, even when more than one API is called.
1443 * @param p_commit This flag is used to indicate if changes made to the
1444 * transaction should be committed on success. The values that are valid
1445 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
1446 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
1447 * before returning to the calling program. When set to 'False', it is the
1448 * responsibility of the calling program to commit the transaction.
1449 * @param p_resp_appl_id This represents the unique application identifier.
1450 * @param p_resp_id This is a unique identifier for the responsibility.
1451 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
1452 * table and identifies the Oracle Applications user.
1453 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
1454 * table and identifies the login session.
1455 * @param x_return_status This flag is used to indicate the return
1456 * status of the API. The values that are valid for this parameter are:
1457 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
1458 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
1459 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
1460 * value is returned, a validation or missing data error has occurred.
1461 * If the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
1462 * has occurred and the calling program cannot correct the error.
1463 * @param x_msg_count This represents the count of error messages in the
1464 * message list.
1465 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
1466 * @param p_activity_rec A PL/SQL record of type activity_rec_type.
1467 * The activity values specified in this record will be Updated on
1468 * the specified Activity.
1469 * @param p_object_version The version number of the record to be updated.
1470 * @rep:scope public
1471 * @rep:displayname Update Interaction Activity
1472 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
1473 */
1474 PROCEDURE Update_Activity
1475 (
1476 p_api_version IN NUMBER,
1477 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1478 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1479 p_resp_appl_id IN NUMBER DEFAULT NULL,
1480 p_resp_id IN NUMBER DEFAULT NULL,
1481 p_user_id IN NUMBER,
1482 p_login_id IN NUMBER DEFAULT NULL,
1483 x_return_status OUT NOCOPY VARCHAR2,
1484 x_msg_count OUT NOCOPY NUMBER,
1485 x_msg_data OUT NOCOPY VARCHAR2,
1486 p_activity_rec IN activity_rec_type,
1487 -- Bug# 2012159
1488 p_object_version IN NUMBER DEFAULT NULL
1489
1490 );
1491
1492 -- Start of comments
1493 -- Procedure : Close_Interaction -- created by Jean Zhu 01/11/2000
1494 -- Type : Public API
1495 -- Usage : This API servers as the basis for providing a caching mechanism during the final of
1496 -- an Interaction.
1497 -- Pre-reqs : None
1498 --
1499 -- Standard IN Parameters:
1500 -- p_api_version IN NUMBER Required
1501 -- p_init_msg_list IN VARCHAR2(1) Optional
1502 -- Default = FND_API.G_FALSE
1503 --
1504 -- Standard OUT Parameters:
1508 --
1505 -- x_return_status OUT VARCHAR2(1)
1506 -- x_msg_count OUT NUMBER
1507 -- x_msg_data OUT VARCHAR2(2000)
1509 -- Interaction count IN Parameters:
1510 -- p_resp_appl_id IN NUMBER Optional(1)
1511 --
1512 -- Application identifier
1513 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
1514 -- p_resp_id IN NUMBER Optional(1)
1515 -- Responsibility identifier
1516 -- Default = FND_GLOBAL.RESP_ID or NULL
1517 -- p_user_id IN NUMBER Optional
1518 -- Corresponds to the column USER_ID in
1519 -- the table FND_USER, and identifies the
1520 -- Oracle Applications user
1521 -- Default = FND_GLOBAL.USER_ID
1522 -- p_login_id IN NUMBER Optional
1523 -- Corresponds to the column LOGIN_ID in the
1524 -- table FND_LOGINS, and identifies the login session
1525 --
1526 -- Default = FND_GLOBAL.LOGIN_ID or NULL
1527 -- p_interaction_id IN NUMBER
1528 --
1529 --
1530 -- Version : Initial version 1.0
1531 --
1532 -- Notes :
1533 -- (1) The application ID, responsibility ID, and user ID determine which
1534 -- profile values are used as default.
1535 -- (2) You must pass in segment IDs for none or all descriptive flexfield
1536 -- columns that might be used in the descriptive flexfield.
1537 --
1538 -- End of comments
1539
1540 /*#
1541 * Closes an Interaction by updating the end date and sets the
1542 * Interaction status to indicate that it is inactive.
1543 * @param p_api_version This must match the version number of the API.
1544 * An unexpected error is returned if the calling program version number
1545 * is incompatible with the current API version number.
1546 * @param p_init_msg_list This flag is used to indicate if the message stack
1547 * should be initialized. The values that are valid for this parameter are:
1548 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
1549 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
1550 * to the fnd_msg_pub.initialize to initialize the message stack. When
1551 * set to 'False', it is the responsibility of the calling program to
1552 * initialize the message stack. It is only required that this action be
1553 * performed once, even when more than one API is called.
1554 * @param p_commit This flag is used to indicate if changes made to the
1555 * transaction should be committed on success. The values that are valid
1556 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
1557 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
1558 * before returning to the calling program. When set to 'False', it is the
1559 * responsibility of the calling program to commit the transaction.
1560 * @param p_resp_appl_id This represents the unique application identifier.
1561 * @param p_resp_id This is a unique identifier for the responsibility.
1562 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
1563 * table and identifies the Oracle Applications user.
1564 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
1565 * table and identifies the login session.
1566 * @param x_return_status This flag is used to indicate the return
1567 * status of the API. The values that are valid for this parameter are:
1568 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
1569 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
1570 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
1571 * value is returned, a validation or missing data error has occurred. If
1572 * the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
1573 * has occurred and the calling program cannot correct the error.
1574 * @param x_msg_count This represents the count of error messages in the
1575 * message list.
1576 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
1577 * @param p_interaction_id This is a unique, sequence-generated identifier
1578 * for the interaction.
1579 * @rep:scope public
1580 * @rep:displayname Close Interaction
1581 */
1582 PROCEDURE Close_Interaction
1583 (
1584 p_api_version IN NUMBER,
1585 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1586 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1587 p_resp_appl_id IN NUMBER DEFAULT NULL,
1588 p_resp_id IN NUMBER DEFAULT NULL,
1589 p_user_id IN NUMBER,
1590 p_login_id IN NUMBER DEFAULT NULL,
1591 x_return_status OUT NOCOPY VARCHAR2,
1592 x_msg_count OUT NOCOPY NUMBER,
1593 x_msg_data OUT NOCOPY VARCHAR2,
1594 p_interaction_id IN NUMBER
1595 );
1596
1597 -- Start of comments
1598 -- Procedure : Update_ActivityDuration -- created by Jean Zhu 01/11/2000
1599 -- Type : Public API
1600 -- Usage : This API servers as the basis for providing a updating mechanism
1601 -- for the duration and start/end date of an activity
1602 -- Pre-reqs : None
1603 --
1604 -- Standard IN Parameters:
1605 -- p_api_version IN NUMBER Required
1606 -- p_init_msg_list IN VARCHAR2(1) Optional
1607 -- Default = FND_API.G_FALSE
1608 --
1609 -- Standard OUT Parameters:
1610 -- x_return_status OUT VARCHAR2(1)
1611 -- x_msg_count OUT NUMBER
1612 -- x_msg_data OUT VARCHAR2(2000)
1613 --
1614 -- Interaction count IN Parameters:
1615 -- p_resp_appl_id IN NUMBER Optional(1)
1619 -- p_resp_id IN NUMBER Optional(1)
1616 --
1617 -- Application identifier
1618 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
1620 -- Responsibility identifier
1621 -- Default = FND_GLOBAL.RESP_ID or NULL
1622 -- p_user_id IN NUMBER Optional
1623 -- Corresponds to the column USER_ID in
1624 -- the table FND_USER, and identifies the
1625 -- Oracle Applications user
1626 -- Default = FND_GLOBAL.USER_ID
1627 -- p_login_id IN NUMBER Optional
1628 -- Corresponds to the column LOGIN_ID in the
1629 -- table FND_LOGINS, and identifies the login session
1630 --
1631 -- Default = FND_GLOBAL.LOGIN_ID or NULL
1632 -- p_activity_id IN NUMBER
1633 -- p_start_date_time IN DATE
1634 -- p_end_date_time IN DATE
1635 -- p_duration IN NUMBER
1636 -- Version : Initial version 1.0
1637 --
1638 -- Notes :
1639 -- (1) The application ID, responsibility ID, and user ID determine which
1640 -- profile values are used as default.
1641 -- (2) You must pass in segment IDs for none or all descriptive flexfield
1642 -- columns that might be used in the descriptive flexfield.
1643 --
1644 -- End of comments
1645
1646 /*#
1647 * This procedure updates an activity end_date_time and duration fields,
1648 * as determined by the provided activity identifier with the values
1649 * supplied by the calling application. The record remains in an active status.
1650 * @param p_api_version This must match the version number of the API.
1651 * An unexpected error is returned if the calling program version number
1652 * is incompatible with the current API version number.
1653 * @param p_init_msg_list This flag is used to indicate if the message stack
1654 * should be initialized. The values that are valid for this parameter are:
1655 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
1656 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
1657 * to the fnd_msg_pub.initialize to initialize the message stack. When
1658 * set to 'False', it is the responsibility of the calling program to
1659 * initialize the message stack. It is only required that this action be
1660 * performed once, even when more than one API is called.
1661 * @param p_commit This flag is used to indicate if changes made to the
1662 * transaction should be committed on success. The values that are valid
1663 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
1664 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
1665 * before returning to the calling program. When set to 'False', it is the
1666 * responsibility of the calling program to commit the transaction.
1667 * @param p_resp_appl_id This represents the unique application identifier.
1668 * @param p_resp_id This is a unique identifier for the responsibility.
1669 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
1670 * table and identifies the Oracle Applications user.
1671 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
1672 * table and identifies the login session.
1673 * @param x_return_status This flag is used to indicate the return
1674 * status of the API. The values that are valid for this parameter are:
1675 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
1676 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
1677 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
1678 * value is returned, a validation or missing data error has occurred. If
1679 * the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
1680 * has occurred and the calling program cannot correct the error.
1681 * @param x_msg_count This represents the count of error messages in the
1682 * message list.
1683 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
1684 * @param p_activity_id This is a unique, sequence-generated identifier
1685 * that corresponds to a certain activity.
1686 * @param p_end_date_time This is the time in date format at the end of
1687 * the transaction.
1688 * @param p_duration Time difference between the end_date_time and
1689 * the start_date_time converted to seconds.
1690 * @param p_object_version The version number of the record to be updated.
1691 * @rep:scope internal
1692 * @rep:displayname Update Activity Duration
1693 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
1694 */
1695 PROCEDURE Update_ActivityDuration
1696 (
1697 p_api_version IN NUMBER,
1698 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1699 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1700 p_resp_appl_id IN NUMBER DEFAULT NULL,
1701 p_resp_id IN NUMBER DEFAULT NULL,
1702 p_user_id IN NUMBER,
1703 p_login_id IN NUMBER DEFAULT NULL,
1704 x_return_status OUT NOCOPY VARCHAR2,
1705 x_msg_count OUT NOCOPY NUMBER,
1706 x_msg_data OUT NOCOPY VARCHAR2,
1707 p_activity_id IN NUMBER,
1708 p_end_date_time IN DATE,
1709 p_duration IN NUMBER,
1710 -- Bug# 2012159
1711 p_object_version IN NUMBER DEFAULT NULL
1712
1713 );
1714
1715 -- Start of comments
1716 -- Author : James Baldo Jr.
1717 -- History :
1718 -- 29 February 2000 Created
1719 -- Procedure : Open_MediaItem
1720 -- Type : Public API
1721 -- Usage : Creates a media item record in the table JTF_IH_MEDIA_ITEMS. The record created
1722 -- resulting from a successful call to this API will have its Active column marked
1723 -- 'Y'. This state indicates that the record can be updated via the Update_MediaItem
1727 --
1724 -- procedure. The procedure call returns the media_id value for the record created.
1725 --
1726 -- Pre-reqs : None
1728 -- Standard IN Parameters:
1729 -- p_api_version IN NUMBER Required
1730 -- p_init_msg_list IN VARCHAR2(1) Optional
1731 -- Default = FND_API.G_FALSE
1732 -- p_commit IN VARCHAR2(1) Optional
1733 -- Default = FND_API.G_FALSE
1734 --
1735 -- Standard OUT Parameters:
1736 -- x_return_status OUT VARCHAR2(1)
1737 -- x_msg_count OUT NUMBER
1738 -- x_msg_data OUT VARCHAR2(2000)
1739 --
1740 -- MediaItem IN Parameters:
1741 -- p_resp_appl_id IN NUMBER Optional(1)
1742 -- Application identifier
1743 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
1744 -- p_resp_id IN NUMBER Optional(1)
1745 -- Responsibility identifier
1746 -- Default = FND_GLOBAL.RESP_ID or NULL
1747 -- p_user_id IN NUMBER Optional
1748 -- Corresponds to the column USER_ID in the table
1749 -- FND_USER, and identifies the Oracle
1750 -- Applications user
1751 -- Default = FND_GLOBAL.USER_ID
1752 -- p_login_id IN NUMBER Optional
1753 -- Corresponds to the column LOGIN_ID in the
1754 -- table FND_LOGINS, and identifies the
1755 -- login session
1756 -- Default = FND_GLOBAL.LOGIN_ID or NULL
1757 --
1758 -- p_media IN media_rec_type
1759 --
1760 -- x_media_id OUT NUMBER
1761 --
1762 -- Version : Initial version 1.0
1763 --
1764 -- Notes :
1765 -- (1) The application ID, responsibility ID, and user ID determine which
1766 -- profile values are used as default.
1767 --
1768 -- End of comments
1769
1770 /*#
1771 * Creates a Media Item and sets the Media Item status to active.
1772 * @param p_api_version This must match the version number of the API.
1773 * An unexpected error is returned if the calling program version number
1774 * is incompatible with the current API version number.
1775 * @param p_init_msg_list This flag is used to indicate if the message stack
1776 * should be initialized. The values that are valid for this parameter are:
1777 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
1778 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
1779 * to the fnd_msg_pub.initialize to initialize the message stack. When
1780 * set to 'False', it is the responsibility of the calling program to
1781 * initialize the message stack. It is only required that this action be
1782 * performed once, even when more than one API is called.
1783 * @param p_commit This flag is used to indicate if changes made to the
1784 * transaction should be committed on success. The values that are valid
1785 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
1786 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
1787 * before returning to the calling program. When set to 'False', it is the
1788 * responsibility of the calling program to commit the transaction.
1789 * @param p_resp_appl_id This represents the unique application identifier.
1790 * @param p_resp_id This is a unique identifier for the responsibility.
1791 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
1792 * table and identifies the Oracle Applications user.
1793 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
1794 * table and identifies the login session.
1798 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS
1795 * @param x_return_status This flag is used to indicate the return status
1796 * of the API. The values that are valid for this parameter are:
1797 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
1799 * value is returned, the API call was successful. If the
1800 * FND_API.G_RET_STS_ERROR value is returned, a validation or missing
1801 * data error has occurred. If the FND_API.G_RET_STS_UNEXP_ERROR value is
1802 * returned, an unexpected error has occurred and the calling program
1803 * cannot correct the error.
1804 * @param x_msg_count This represents the count of error messages in the
1805 * message list.
1806 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
1807 * @param p_media_rec A PL/SQL record of type media_rec_type. The media item
1808 * values specified in this record will be created on the specified media item.
1809 * @param x_media_id This is the record number for the created media
1810 * item and is automatically generated by sequence JTF_IH_MEDIA_ITEMS_S1.
1811 * @rep:scope public
1812 * @rep:displayname Open Media Item
1813 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
1814 */
1815 PROCEDURE Open_MediaItem
1816 (
1817 p_api_version IN NUMBER,
1818 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1819 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1820 p_resp_appl_id IN NUMBER DEFAULT NULL,
1821 p_resp_id IN NUMBER DEFAULT NULL,
1822 p_user_id IN NUMBER,
1823 p_login_id IN NUMBER DEFAULT NULL,
1824 x_return_status OUT NOCOPY VARCHAR2,
1825 x_msg_count OUT NOCOPY NUMBER,
1826 x_msg_data OUT NOCOPY VARCHAR2,
1827 p_media_rec IN media_rec_type,
1828 x_media_id OUT NOCOPY NUMBER
1829 );
1830
1831 -- Start of comments
1832 -- Author : James Baldo Jr.
1833 -- History :
1834 -- 29 February 2000 Created
1835 -- Procedure : Update_MediaItem
1836 -- Type : Public API
1837 -- Usage : Updates an existing media item record in the table JTF_IH_MEDIA_ITEMS.
1838 -- Procedure will only update columns with valid values. All input values must
1839 -- be valid. Procedure will not perform a partial update.
1840 --
1841 -- Pre-conditions : Media_ID update state Active = 'Y'
1842 --
1843 -- Post-conditions : Media_ID update state Active = 'Y'
1844 -- : Updated columns changed to valid values
1845 --
1846 -- Standard IN Parameters:
1847 -- p_api_version IN NUMBER Required
1848 -- p_init_msg_list IN VARCHAR2(1) Optional
1849 -- Default = FND_API.G_FALSE
1850 -- p_commit IN VARCHAR2(1) Optional
1851 -- Default = FND_API.G_FALSE
1852 --
1853 -- Standard OUT Parameters:
1854 -- x_return_status OUT VARCHAR2(1)
1855 -- x_msg_count OUT NUMBER
1856 -- x_msg_data OUT VARCHAR2(2000)
1857 --
1858 -- MediaItem IN Parameters:
1859 -- p_resp_appl_id IN NUMBER Optional(1)
1860 -- Application identifier
1861 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
1862 -- p_resp_id IN NUMBER Optional(1)
1863 -- Responsibility identifier
1864 -- Default = FND_GLOBAL.RESP_ID or NULL
1865 -- p_user_id IN NUMBER Optional
1866 -- Corresponds to the column USER_ID in the table
1867 -- FND_USER, and identifies the Oracle
1868 -- Applications user
1869 -- Default = FND_GLOBAL.USER_ID
1870 -- p_login_id IN NUMBER Optional
1871 -- Corresponds to the column LOGIN_ID in the
1872 -- table FND_LOGINS, and identifies the
1873 -- login session
1874 -- Default = FND_GLOBAL.LOGIN_ID or NULL
1875 --
1876 -- p_media IN media_rec_type
1877 --
1878 -- Version : Initial version 1.0
1879 --
1880 -- Notes :
1881 -- (1) The application ID, responsibility ID, and user ID determine which
1882 -- profile values are used as default.
1883 --
1884 -- End of comments
1885
1886 /*#
1887 * Updates an active Media Item.
1888 * identifier provided and the values supplied by the calling application.
1889 * The record remains in an active status.
1890 * @param p_api_version This must match the version number of the API.
1894 * should be initialized. The values that are valid for this parameter are:
1891 * An unexpected error is returned if the calling program version number
1892 * is incompatible with the current API version number.
1893 * @param p_init_msg_list This flag is used to indicate if the message stack
1895 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
1896 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
1897 * to the fnd_msg_pub.initialize to initialize the message stack. When
1898 * set to 'False', it is the responsibility of the calling program to
1899 * initialize the message stack. It is only required that this action be
1900 * performed once, even when more than one API is called.
1901 * @param p_commit This flag is used to indicate if changes made to the
1902 * transaction should be committed on success. The values that are valid
1903 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
1904 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
1905 * before returning to the calling program. When set to 'False', it is the
1906 * responsibility of the calling program to commit the transaction.
1907 * @param p_resp_appl_id This represents the unique application identifier.
1908 * @param p_resp_id This is a unique identifier for the responsibility.
1909 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
1910 * table and identifies the Oracle Applications user.
1911 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
1912 * table and identifies the login session.
1913 * @param x_return_status This flag is used to indicate the return
1914 * status of the API. The values that are valid for this parameter are:
1915 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
1916 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
1917 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
1918 * value is returned, a validation or missing data error has occurred. If
1919 * the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
1920 * has occurred and the calling program cannot correct the error.
1921 * @param x_msg_count This represents the count of error messages in the
1922 * message list.
1923 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
1924 * @param p_media_rec A PL/SQL record of type media_rec_type. The media item
1925 * values specified in this record will be updated on the specified media item.
1926 * @param p_object_version The version number of the record to be updated.
1927 * @rep:scope public
1928 * @rep:displayname Update Media Item
1929 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
1930 */
1931 PROCEDURE Update_MediaItem
1932 (
1933 p_api_version IN NUMBER,
1934 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1935 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
1936 p_resp_appl_id IN NUMBER DEFAULT NULL,
1937 p_resp_id IN NUMBER DEFAULT NULL,
1938 p_user_id IN NUMBER,
1939 p_login_id IN NUMBER DEFAULT NULL,
1940 x_return_status OUT NOCOPY VARCHAR2,
1941 x_msg_count OUT NOCOPY NUMBER,
1942 x_msg_data OUT NOCOPY VARCHAR2,
1943 p_media_rec IN media_rec_type,
1944 -- Bug# 2012159
1945 p_object_version IN NUMBER DEFAULT NULL
1946
1947 );
1948
1949
1950 -- Start of comments
1951 -- Author : James Baldo Jr.
1952 -- History :
1953 -- 29 February 2000 Created
1954 -- Procedure : Close_MediaItem
1955 -- Type : Public API
1956 -- Usage : Updates an existing media item record in the table JTF_IH_MEDIA_ITEMS.
1957 -- Procedure will only update columns with valid values. All input values must
1958 -- be valid. Procedure will not perform a partial update. Will mark the state of the
1959 -- Media_ID and associated Milcs_ID Active = 'N'. The record set, media item and associated
1960 -- milcs_id(s) are now considered historical records and immutable.
1961 --
1962 -- Pre-conditions : Media_ID state Active = 'Y'
1963 -- : Milcs_ID (i.e., all media_item_lifecycle_segments associated with Media_ID)
1964 -- state Active = 'Y'
1965 --
1966 -- Post-conditions : Media_ID update state Active = 'N'
1967 -- : Updated columns changed to valid values
1968 -- : Milcs_ID(s) update state Active = 'N'
1969 --
1970 -- Standard IN Parameters:
1971 -- p_api_version IN NUMBER Required
1972 -- p_init_msg_list IN VARCHAR2(1) Optional
1973 -- Default = FND_API.G_FALSE
1974 -- p_commit IN VARCHAR2(1) Optional
1975 -- Default = FND_API.G_FALSE
1976 --
1977 -- Standard OUT Parameters:
1978 -- x_return_status OUT VARCHAR2(1)
1979 -- x_msg_count OUT NUMBER
1980 -- x_msg_data OUT VARCHAR2(2000)
1981 --
1982 -- MediaItem IN Parameters:
1983 -- p_resp_appl_id IN NUMBER Optional(1)
1984 -- Application identifier
1985 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
1986 -- p_resp_id IN NUMBER Optional(1)
1987 -- Responsibility identifier
1988 -- Default = FND_GLOBAL.RESP_ID or NULL
1989 -- p_user_id IN NUMBER Optional
1990 -- Corresponds to the column USER_ID in the table
1991 -- FND_USER, and identifies the Oracle
1992 -- Applications user
1993 -- Default = FND_GLOBAL.USER_ID
1994 -- p_login_id IN NUMBER Optional
1995 -- Corresponds to the column LOGIN_ID in the
1999 --
1996 -- table FND_LOGINS, and identifies the
1997 -- login session
1998 -- Default = FND_GLOBAL.LOGIN_ID or NULL
2000 -- p_media IN media_rec_type
2001 --
2002 -- Version : Initial version 1.0
2003 --
2004 -- Notes :
2005 -- (1) The application ID, responsibility ID, and user ID determine which
2006 -- profile values are used as default.
2007 --
2008 -- End of comments
2009
2010 /*#
2011 * Closes a Media Item by updating the end date and sets the
2012 * Media Item status to indicate that it is inactive.
2013 * @param p_api_version This must match the version number of the API.
2014 * An unexpected error is returned if the calling program version number
2015 * is incompatible with the current API version number.
2016 * @param p_init_msg_list This flag is used to indicate if the message stack
2017 * should be initialized. The values that are valid for this parameter are:
2018 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
2019 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
2020 * to the fnd_msg_pub.initialize to initialize the message stack. When
2021 * set to 'False', it is the responsibility of the calling program to
2022 * initialize the message stack. It is only required that this action be
2023 * performed once, even when more than one API is called.
2024 * @param p_commit This flag is used to indicate if changes made to the
2025 * transaction should be committed on success. The values that are valid
2026 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
2027 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
2028 * before returning to the calling program. When set to 'False', it is the
2029 * responsibility of the calling program to commit the transaction.
2030 * @param p_resp_appl_id This represents the unique application identifier.
2031 * @param p_resp_id This is a unique identifier for the responsibility.
2032 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
2033 * table and identifies the Oracle Applications user.
2034 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
2035 * table and identifies the login session.
2036 * @param x_return_status This flag is used to indicate the return
2037 * status of the API. The values that are valid for this parameter are:
2038 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
2039 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
2040 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
2041 * value is returned, a validation or missing data error has occurred. If
2042 * the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
2043 * has occurred and the calling program cannot correct the error.
2044 * @param x_msg_count This represents the count of error messages in the
2045 * message list.
2046 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
2047 * @param p_media_rec A PL/SQL record of type media_rec_type. The media item
2048 * values specified in this record will be updated on the specified media item.
2049 * @param p_object_version The version number of the record to be updated.
2050 * @rep:scope public
2051 * @rep:displayname Close Media Item
2052 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
2053 */
2054 PROCEDURE Close_MediaItem
2055 (
2056 p_api_version IN NUMBER,
2057 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
2058 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
2059 p_resp_appl_id IN NUMBER DEFAULT NULL,
2060 p_resp_id IN NUMBER DEFAULT NULL,
2061 p_user_id IN NUMBER,
2062 p_login_id IN NUMBER DEFAULT NULL,
2063 x_return_status OUT NOCOPY VARCHAR2,
2064 x_msg_count OUT NOCOPY NUMBER,
2065 x_msg_data OUT NOCOPY VARCHAR2,
2066 p_media_rec IN media_rec_type,
2067 p_object_version IN NUMBER DEFAULT NULL
2068 );
2069
2070 -- Start of comments
2071 -- Procedure : Add_MediaLifecycle
2072 -- Type : Public API
2073 -- Author : James Baldo Jr.
2074 -- History :
2075 -- 29 February 2000 Created
2076 -- Usage : Creates a media lifecycle record in the table JTF_IH_MEDIA_ITEM_LC_SEGS,
2077 -- returns a Milcs_ID, and sets the state of the record Active = 'Y'.
2078 -- All parameter values passed-in must be valid. The procedure will not create
2079 -- a record with a partial set of valid values.
2080 --
2081 --
2082 -- Pre-reqs : None
2083 --
2084 -- Standard IN Parameters:
2085 -- p_api_version IN NUMBER Required
2086 -- p_init_msg_list IN VARCHAR2(1) Optional
2087 -- Default = FND_API.G_FALSE
2088 -- p_commit IN VARCHAR2(1) Optional
2089 -- Default = FND_API.G_FALSE
2090 --
2091 -- Standard OUT Parameters:
2092 -- x_return_status OUT VARCHAR2(1)
2093 -- x_msg_count OUT NUMBER
2094 -- x_msg_data OUT VARCHAR2(2000)
2095 --
2096 -- MediaItem IN Parameters:
2097 -- p_resp_appl_id IN NUMBER Optional(1)
2098 -- Application identifier
2099 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
2100 -- p_resp_id IN NUMBER Optional(1)
2101 -- Responsibility identifier
2102 -- Default = FND_GLOBAL.RESP_ID or NULL
2103 -- p_user_id IN NUMBER Optional
2104 -- Corresponds to the column USER_ID in the table
2105 -- FND_USER, and identifies the Oracle
2109 -- Corresponds to the column LOGIN_ID in the
2106 -- Applications user
2107 -- Default = FND_GLOBAL.USER_ID
2108 -- p_login_id IN NUMBER Optional
2110 -- table FND_LOGINS, and identifies the
2111 -- login session
2112 -- Default = FND_GLOBAL.LOGIN_ID or NULL
2113 --
2114 -- p_media_lc_rec IN media_lc_rec_type
2115 --
2116 -- x_milcs_id OUT NUMBER
2117 --
2118 --
2119 -- Version : Initial version 1.0
2120 --
2121 -- Notes :
2122 -- (1) The application ID, responsibility ID, and user ID determine which
2123 -- profile values are used as default.
2124 --
2125 -- End of comments
2126
2127 /*#
2128 * This procedure creates a media lifecycle record in the Media Lifecycle
2129 * table. It associates the media lifecycle record with a media item that is
2130 * passed by the calling application. It leaves the record in an active status
2131 * and returns a sequence generated milcs_id number.
2132 * @param p_api_version This must match the version number of the API.
2133 * An unexpected error is returned if the calling program version number
2134 * is incompatible with the current API version number.
2135 * @param p_init_msg_list This flag is used to indicate if the message stack
2136 * should be initialized. The values that are valid for this parameter are:
2137 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
2138 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
2139 * to the fnd_msg_pub.initialize to initialize the message stack. When
2140 * set to 'False', it is the responsibility of the calling program to
2141 * initialize the message stack. It is only required that this action be
2142 * performed once, even when more than one API is called.
2143 * @param p_commit This flag is used to indicate if changes made to the
2144 * transaction should be committed on success. The values that are valid
2145 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
2146 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
2147 * before returning to the calling program. When set to 'False', it is the
2148 * responsibility of the calling program to commit the transaction.
2149 * @param p_resp_appl_id This represents the unique application identifier.
2150 * @param p_resp_id This is a unique identifier for the responsibility.
2151 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
2152 * table and identifies the Oracle Applications user.
2153 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
2154 * table and identifies the login session.
2155 * @param x_return_status This flag is used to indicate the return
2156 * status of the API. The values that are valid for this parameter are:
2157 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
2158 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
2159 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
2160 * value is returned, a validation or missing data error has occurred. If
2161 * the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
2162 * has occurred and the calling program cannot correct the error.
2163 * @param x_msg_count This represents the count of error messages in the
2167 * elements that comprise a media lifecycle.
2164 * message list.
2165 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
2166 * @param p_media_lc_rec This is a composite record that enumerates the
2168 * @param x_milcs_id This corresponds to the sequence-generated
2169 * media lifecycle identifier for the created record.
2170 * @rep:scope internal
2171 * @rep:displayname Add Media Lifecycle
2172 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
2173 */
2174 PROCEDURE Add_MediaLifecycle
2175 (
2176 p_api_version IN NUMBER,
2177 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
2178 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
2179 p_resp_appl_id IN NUMBER DEFAULT NULL,
2180 p_resp_id IN NUMBER DEFAULT NULL,
2181 p_user_id IN NUMBER,
2182 p_login_id IN NUMBER DEFAULT NULL,
2183 x_return_status OUT NOCOPY VARCHAR2,
2184 x_msg_count OUT NOCOPY NUMBER,
2185 x_msg_data OUT NOCOPY VARCHAR2,
2186 p_media_lc_rec IN media_lc_rec_type,
2187 x_milcs_id OUT NOCOPY NUMBER
2188 );
2189
2190 -- Start of comments
2191 -- Procedure : Update_MediaLifecycle
2192 -- Type : Public API
2193 -- Author : James Baldo Jr.
2194 -- History :
2195 -- 29 February 2000 Created
2196 -- Usage : Update a media lifecycle record in the table JTF_IH_MEDIA_ITEM_LC_SEGS.
2197 -- All parameter values passed-in must be valid. The procedure will not update
2198 -- a record with a partial set of valid values.
2199 --
2200 --
2201 -- Pre-reqs : None
2202 --
2203 -- Standard IN Parameters:
2204 -- p_api_version IN NUMBER Required
2205 -- p_init_msg_list IN VARCHAR2(1) Optional
2206 -- Default = FND_API.G_FALSE
2207 -- p_commit IN VARCHAR2(1) Optional
2208 -- Default = FND_API.G_FALSE
2209 --
2210 -- Standard OUT Parameters:
2211 -- x_return_status OUT VARCHAR2(1)
2212 -- x_msg_count OUT NUMBER
2213 -- x_msg_data OUT VARCHAR2(2000)
2214 --
2215 -- MediaItem IN Parameters:
2216 -- p_resp_appl_id IN NUMBER Optional(1)
2217 -- Application identifier
2218 -- Default = FND_GLOBAL.RESP_APPL_ID or NULL
2219 -- p_resp_id IN NUMBER Optional(1)
2220 -- Responsibility identifier
2221 -- Default = FND_GLOBAL.RESP_ID or NULL
2222 -- p_user_id IN NUMBER Optional
2223 -- Corresponds to the column USER_ID in the table
2224 -- FND_USER, and identifies the Oracle
2225 -- Applications user
2226 -- Default = FND_GLOBAL.USER_ID
2227 -- p_login_id IN NUMBER Optional
2228 -- Corresponds to the column LOGIN_ID in the
2229 -- table FND_LOGINS, and identifies the
2230 -- login session
2231 -- Default = FND_GLOBAL.LOGIN_ID or NULL
2232 --
2233 -- p_media_lc_rec IN media_lc_rec_type
2234 --
2235 --
2236 --
2237 -- Version : Initial version 1.0
2238 --
2239 -- Notes :
2240 -- (1) The application ID, responsibility ID, and user ID determine which
2241 -- profile values are used as default.
2242 --
2243 -- End of comments
2244 /*#
2245 * This procedure updates a media lifecycle record based on the media
2246 * lifecycle identifier and the values supplied by the calling application.
2247 * The record remains in an active status.
2248 * @param p_api_version This must match the version number of the API.
2249 * An unexpected error is returned if the calling program version number
2250 * is incompatible with the current API version number.
2251 * @param p_init_msg_list This flag is used to indicate if the message stack
2252 * should be initialized. The values that are valid for this parameter are:
2253 * True = FND_API.G_TRUE, False = FND_API.G_FALSE, and
2254 * Default = FND_API.G_FALSE. When set to 'True',the API makes a call
2255 * to the fnd_msg_pub.initialize to initialize the message stack. When
2256 * set to 'False', it is the responsibility of the calling program to
2257 * initialize the message stack. It is only required that this action be
2258 * performed once, even when more than one API is called.
2259 * @param p_commit This flag is used to indicate if changes made to the
2260 * transaction should be committed on success. The values that are valid
2261 * for this parameter are: True = FND_API.G_TRUE, False = FND_API.G_FALSE,
2262 * and Default = FND_API.G_FALSE. When set to 'True', the API commits
2263 * before returning to the calling program. When set to 'False', it is the
2264 * responsibility of the calling program to commit the transaction.
2265 * @param p_resp_appl_id This represents the unique application identifier.
2266 * @param p_resp_id This is a unique identifier for the responsibility.
2267 * @param p_user_id This corresponds to the USER_ID column in the FND_USER
2268 * table and identifies the Oracle Applications user.
2269 * @param p_login_id Corresponds to the LOGIN_ID column in the FND_LOGINS
2270 * table and identifies the login session.
2271 * @param x_return_status This flag is used to indicate the return
2272 * status of the API. The values that are valid for this parameter are:
2273 * FND_API.G_RET_STS_SUCCESS, FND_API.G_RET_STS_ERROR, and
2274 * FND_API.G_RET_STS_UNEXP_ERROR. If the FND_API.G_RET_STS_SUCCESS value
2275 * is returned, the API call was successful. If the FND_API.G_RET_STS_ERROR
2276 * value is returned, a validation or missing data error has occurred. If
2277 * the FND_API.G_RET_STS_UNEXP_ERROR value is returned, an unexpected error
2278 * has occurred and the calling program cannot correct the error.
2279 * @param x_msg_count This represents the count of error messages in the
2280 * message list.
2281 * @param x_msg_data Holds the encoded message if x_msg_count is equal to one.
2282 * @param p_media_lc_rec This is a composite record that enumerates the
2283 * elements that comprise a media lifecycle.
2284 * @param p_object_version The version number of the record to be updated.
2285 * @rep:scope internal
2286 * @rep:displayname Update Media Lifecycle
2287 * @rep:category BUSINESS_ENTITY JTH_INTERACTION
2288 */
2289 PROCEDURE Update_MediaLifecycle
2290 (
2291 p_api_version IN NUMBER,
2292 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
2293 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
2294 p_resp_appl_id IN NUMBER DEFAULT NULL,
2295 p_resp_id IN NUMBER DEFAULT NULL,
2296 p_user_id IN NUMBER,
2297 p_login_id IN NUMBER DEFAULT NULL,
2298 x_return_status OUT NOCOPY VARCHAR2,
2299 x_msg_count OUT NOCOPY NUMBER,
2300 x_msg_data OUT NOCOPY VARCHAR2,
2301 p_media_lc_rec IN media_lc_rec_type,
2302 -- Bug# 2012159
2303 p_object_version IN NUMBER DEFAULT NULL
2304 );
2305
2306
2307 END JTF_IH_PUB;
[Home] [Help]