1 PACKAGE ams_adi_media_planner_pvt AUTHID CURRENT_USER AS
2 /* $Header: amsvwmps.pls 120.0 2005/07/01 03:59:38 appldev noship $ */
3 -- ===============================================================
4 -- Start of Comments
5 -- Package name
6 -- Web ADI Media Planner
7 --
8 -- Purpose
9 -- This package contains program units used in the integration of
10 -- Web ADI and Marketing Metrics. APIs will handle concurrent
11 -- processing and metrics upload from schedule import and
12 -- media planner (which is metric update for multiple schedules).
13 --
14 -- History
15 --
16 -- NOTE
17 --
18 -- End of Comments
19 -- ===============================================================
20
21 -- ==============================================================================
22 -- Start of Comments
23 -- ==============================================================================
24 -- API Name
25 -- Load Metrics
26 -- Type
27 -- Private
28 -- Pre-Req
29 --
30 -- Parameters
31 --
32 -- IN
33 -- p_api_version
34 -- p_init_msg_list Default FND_API.g_false; indicate whether to
35 -- initialize the message buffer.
36 -- p_commit Default FND_API.g_false; indicate whether to
37 -- commit the transaction.
38 -- p_upload_batch_id Batch ID used to identify the records belonging
39 -- in the same upload batch.
40 -- p_object_type Default 'CSCH'; the type of object the metrics
41 -- are being loaded for.
42 -- p_object_name Name of the object the metrics are being loaded
43 -- for. The name and parent_id are used to uniquely
44 -- identify the record in the interface table
45 -- associated with the object; the object ID is not
46 -- in the interface table during import.
47 -- p_parent_type The type of object of the parent of the object.
48 -- p_parent_id The object ID of the parent object. Used with
49 -- object name to identify the record in the
50 -- interface table associated with the object; the
51 -- record in the interface table does not have the
52 -- object ID during import.
53 -- p_object_id Used with the metric API.
54 -- x_return_status Status of the API execution.
55 -- x_msg_count Number of messages in the message buffer.
56 -- x_msg_data Contents of the message buffer.
57 --
58 -- Version : Current version 1.0
59 --
60 -- History
61 --
62 -- NOTE
63 -- Invoked from the import concurrent program after the object gets
64 -- created and the objet ID is available.
65 --
66 -- End of Comments
67 -- ==============================================================================
68 PROCEDURE load_metrics (
69 p_api_version IN NUMBER,
70 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
71 p_commit IN VARCHAR2 := FND_API.g_false,
72 p_upload_batch_id IN NUMBER,
73 p_object_type IN VARCHAR2 := 'CSCH',
74 p_object_name IN VARCHAR2,
75 p_parent_type IN VARCHAR2,
76 p_parent_id IN NUMBER,
77 p_object_id IN NUMBER,
78 x_return_status OUT NOCOPY VARCHAR2,
79 x_msg_count OUT NOCOPY NUMBER,
80 x_msg_data OUT NOCOPY VARCHAR2
81 );
82
83 -- ==============================================================================
84 -- Start of Comments
85 -- ==============================================================================
86 -- API Name
87 -- Load Metrics
88 -- Type
89 -- Private
90 -- Pre-Req
91 --
92 -- Parameters
93 --
94 -- IN
95 -- p_api_version
96 -- p_init_msg_list Default FND_API.g_false; indicate whether to
97 -- initialize the message buffer.
98 -- p_commit Default FND_API.g_false; indicate whether to
99 -- commit the transaction.
100 -- p_media_planner_rec ###### description here #######
101 -- x_return_status Status of the API execution.
102 -- x_msg_count Number of messages in the message buffer.
103 -- x_msg_data Contents of the message buffer.
104 --
105 -- Version : Current version 1.0
106 --
107 -- History
108 --
109 -- NOTE
110 -- Invoked from the concurrent program after the media planner record
111 -- is constructed from the interface table data.
112 --
113 -- End of Comments
114 -- ==============================================================================
115 PROCEDURE load_metrics (
116 p_api_version IN NUMBER,
117 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
118 p_commit IN VARCHAR2 := FND_API.g_false,
119 p_media_planner_rec IN ams_adi_media_planner%ROWTYPE,
120 p_err_recs IN OUT NOCOPY AMS_ADI_COMMON_PVT.ams_adi_error_rec_t,
121 x_return_status OUT NOCOPY VARCHAR2,
122 x_msg_count OUT NOCOPY NUMBER,
123 x_msg_data OUT NOCOPY VARCHAR2
124 );
125
126 -- ==============================================================================
127 -- Start of Comments
128 -- ==============================================================================
129 -- API Name
130 -- Load Request
131 -- Type
132 -- Private
133 -- Pre-Req
134 --
135 -- Parameters
136 --
137 -- IN
138 -- errbuf Error message buffer for a concurrent program.
139 -- retcode Return code for a concurrent program.
140 -- p_upload_batch_id Batch ID used to identify the records belonging
141 -- in the same upload batch.
142 --
143 -- Version : Current version 1.0
144 --
145 -- History
146 --
147 -- NOTE
148 --
149 -- End of Comments
150 -- ==============================================================================
151 PROCEDURE load_request (
152 x_errbuf OUT NOCOPY VARCHAR2,
153 x_retcode OUT NOCOPY NUMBER,
154 p_upload_batch_id IN NUMBER
155 );
156
157 -- ==============================================================================
158 -- Start of Comments
159 -- ==============================================================================
160 -- API Name
161 -- Purge Import Metrics
162 -- Type
163 -- Private
164 -- Pre-Req
165 --
166 -- Parameters
167 --
168 -- IN
169 -- p_object_type
170 -- p_object_name
171 -- p_parent_type
172 -- p_parent_id
173 --
174 -- Version : Current version 1.0
175 --
176 -- History
177 --
178 -- NOTE
179 --
180 -- End of Comments
181 -- ==============================================================================
182
183 PROCEDURE purge_import_metrics(
184 p_object_type IN VARCHAR2,
185 p_object_name IN VARCHAR2,
186 p_parent_type IN VARCHAR2,
187 p_parent_id IN NUMBER
188 );
189
190 END ams_adi_media_planner_pvt;
[Home] [Help]