PACKAGE: APPS.AMS_ADI_COMMON_PVT

Source

1 PACKAGE AMS_ADI_COMMON_PVT AS
2 /* $Header: amsvadcs.pls 120.0 2005/07/01 03:58:19 appldev noship $ */
3 
4 
5 g_pkg_name   CONSTANT VARCHAR2(30):='AMS_ADI_COMMON_PVT';
6 g_log_level  CONSTANT NUMBER := FND_LOG.LEVEL_STATEMENT;
7 
8 g_batch_size CONSTANT NUMBER := FND_PROFILE.VALUE('AMS_ADI_BATCH_SIZE');
9 g_max_error_messages CONSTANT NUMBER := 5;
10 
11 TYPE ams_adi_error_rec IS RECORD
12 (error_code VARCHAR2(30),
13  error_message VARCHAR2(4000),
14  object_id NUMBER,
15  object_name VARCHAR2(240),
16  parent_object_id NUMBER
17 );
18 
19 TYPE ams_adi_error_rec_t IS TABLE OF ams_adi_error_rec;
20 
21 --========================================================================
22 -- PROCEDURE
23 --    handles successful API call for a row during Web ADI ->
24 --     Marketing integration call
25 -- Purpose
26 --    COMMIT successful row in database
27 -- HISTORY
28 --
29 --========================================================================
30 PROCEDURE handle_success_row(
31 p_commit IN VARCHAR2 := FND_API.G_TRUE
32 );
33 
34 
35 --========================================================================
36 -- PROCEDURE
37 --    handles ERROR in API call for a row during Web ADI ->
38 --     Marketing integration call
39 -- Purpose
40 --    COMMIT successful row in database
41 -- HISTORY
42 --
43 --========================================================================
44 PROCEDURE handle_error_row(
45 p_write_conc_log IN VARCHAR2 := FND_API.G_TRUE,
46 p_rollback IN VARCHAR2 := FND_API.G_TRUE,
47 p_error_code IN VARCHAR2 := NULL,
48 p_error_message IN VARCHAR2 := NULL,
49 p_object_id IN NUMBER,
50 p_object_name IN VARCHAR2,
51 p_parent_object_id IN NUMBER,
52 p_error_records IN OUT NOCOPY ams_adi_error_rec_t
53 );
54 
55 
56 --========================================================================
57 -- PROCEDURE
58 --    handles FATAL ERROR in API call for a row during Web ADI ->
59 --     Marketing integration call
60 -- Purpose
61 --    ROLLBACK, log messages to conc log
62 -- HISTORY
63 --
64 --========================================================================
65 PROCEDURE handle_fatal_error(
66 p_write_conc_log IN VARCHAR2 := FND_API.G_TRUE,
67 p_rollback IN VARCHAR2 := FND_API.G_TRUE
68 );
69 
70 
71 --========================================================================
72 -- PROCEDURE
73 --    initializes for all operations
74 -- Purpose
75 --
76 -- HISTORY
77 --
78 --========================================================================
79 PROCEDURE init;
80 
81 
82 --========================================================================
83 -- PROCEDURE
84 --    initializes for batch operations
85 -- Purpose
86 --    initializes error structure table
87 -- HISTORY
88 --
89 --========================================================================
90 PROCEDURE init_for_batch(
91 p_error_records IN OUT  NOCOPY ams_adi_error_rec_t
92 );
93 
94 
95 --========================================================================
96 -- PROCEDURE
97 --    needs to be called after processing a batch of batch_size
98 -- Purpose
99 --    updates all staging table rows that errored out and commits(by default)
100 -- HISTORY
101 --
102 --========================================================================
103 PROCEDURE complete_batch(
104 p_update_table_name IN VARCHAR2,
105 p_upload_batch_id IN NUMBER,
106 p_use_object_id_as_pk IN VARCHAR2 := FND_API.G_TRUE,
107 p_commit IN VARCHAR2 := FND_API.G_TRUE,
108 p_error_records IN OUT  NOCOPY ams_adi_error_rec_t
109 );
110 
111 
112 --========================================================================
113 -- PROCEDURE
114 --    needs to be called at the end of all rows processing
115 -- Purpose
116 --    updates all staging table rows that errored out and commits
117 -- HISTORY
118 --
119 --========================================================================
120 PROCEDURE complete_all(
121 p_write_conc_out IN VARCHAR2 := FND_API.G_TRUE,
122 p_commit IN VARCHAR2 := FND_API.G_TRUE,
123 p_upload_batch_id IN NUMBER := 0
124 );
125 
126 
127 
128 END AMS_ADI_COMMON_PVT;