1 PACKAGE AMS_EventHeader_PVT AUTHID CURRENT_USER as
2 /* $Header: amsvevhs.pls 115.20 2002/11/22 23:37:01 dbiswas ship $ */
3
4 TYPE evh_rec_type IS RECORD(
5 event_header_id NUMBER
6 ,last_update_date DATE
7 ,last_updated_by NUMBER
8 ,creation_date DATE
9 ,created_by NUMBER
10 ,last_update_login NUMBER
11 ,object_version_number NUMBER
12 ,event_level VARCHAR2(30)
13 ,application_id NUMBER
14 ,event_type_code VARCHAR2(30)
15 ,active_flag VARCHAR2(1)
16 ,private_flag VARCHAR2(1)
17 ,user_status_id NUMBER
18 ,system_status_code VARCHAR2(30)
19 ,last_status_date DATE
20 ,stream_type_code VARCHAR2(30)
21 ,source_code VARCHAR2(30)
22 ,event_standalone_flag VARCHAR2(1)
23 ,day_of_event VARCHAR2(30)
24 ,agenda_start_time DATE
25 ,agenda_end_time DATE
26 ,reg_required_flag VARCHAR2(1)
27 ,reg_charge_flag VARCHAR2(1)
28 ,reg_invited_only_flag VARCHAR2(1)
29 ,partner_flag VARCHAR2(1)
30 ,overflow_flag VARCHAR2(1)
31 ,parent_event_header_id NUMBER
32 ,duration NUMBER
33 ,duration_uom_code VARCHAR2(3)
34 ,active_from_date DATE
35 ,active_to_date DATE
36 ,reg_maximum_capacity NUMBER
37 ,reg_minimum_capacity NUMBER
38 ,main_language_code VARCHAR2(4)
39 ,cert_credit_type_code VARCHAR2(30)
40 ,certification_credits NUMBER
41 ,inventory_item_id NUMBER
42 ,organization_id NUMBER
43 ,org_id NUMBER
44 ,forecasted_revenue NUMBER
45 ,actual_revenue NUMBER
46 ,forecasted_cost NUMBER
47 ,actual_cost NUMBER
48 ,coordinator_id NUMBER
49 ,fund_source_type_code VARCHAR2(30)
50 ,fund_source_id NUMBER
51 ,fund_amount_tc NUMBER
52 ,fund_amount_fc NUMBER
53 ,currency_code_tc VARCHAR2(30)
54 ,currency_code_fc VARCHAR2(30)
55 ,owner_user_id NUMBER
56 ,url VARCHAR2(4000)
57 ,email VARCHAR2(120)
58 ,phone VARCHAR2(25)
59 ,priority_type_code VARCHAR2(30)
60 ,cancellation_reason_code VARCHAR2(30)
61 ,inbound_script_name VARCHAR2(240)
62 ,attribute_category VARCHAR2(30)
63 ,attribute1 VARCHAR2(150)
64 ,attribute2 VARCHAR2(150)
65 ,attribute3 VARCHAR2(150)
66 ,attribute4 VARCHAR2(150)
67 ,attribute5 VARCHAR2(150)
68 ,attribute6 VARCHAR2(150)
69 ,attribute7 VARCHAR2(150)
70 ,attribute8 VARCHAR2(150)
71 ,attribute9 VARCHAR2(150)
72 ,attribute10 VARCHAR2(150)
73 ,attribute11 VARCHAR2(150)
74 ,attribute12 VARCHAR2(150)
75 ,attribute13 VARCHAR2(150)
76 ,attribute14 VARCHAR2(150)
77 ,attribute15 VARCHAR2(150)
78 ,event_header_name VARCHAR2(240)
79 ,event_mktg_message VARCHAR2(4000)
80 ,description VARCHAR2(4000)
81 ,custom_setup_id NUMBER
82 ,country_code VARCHAR2(30)
83 ,business_unit_id NUMBER
84 ,event_calendar VARCHAR2(15)
85 ,start_period_name VARCHAR2(15)
86 ,end_period_name VARCHAR2(15)
87 ,global_flag VARCHAR2(1)
88 ,task_id NUMBER
89 ,program_id NUMBER
90 ,CREATE_ATTENDANT_LEAD_FLAG VARCHAR2(1) /*hornet*/
91 ,CREATE_REGISTRANT_LEAD_FLAG VARCHAR2(1) /*hornet*/
92 ,EVENT_PURPOSE_CODE VARCHAR2(30) /*hornet*/
93 );
94
95 ---------------------------------------------------------------------
96 -- PROCEDURE
97 -- create_event_header
98 --
99 -- PURPOSE
100 -- Create a new event header or agenda item for the event header.
101 --
102 -- PARAMETERS
103 -- p_evh_rec: the new record to be inserted
104 -- x_evh_id: return the event_header_id of the new event header
105 --
106 -- NOTES
107 -- 1. object_version_number will be set to 1.
108 -- 2. If event_header_id is passed in, the uniqueness will be checked.
109 -- Raise exception in case of duplicates.
110 -- 3. If event_header_id is not passed in, generate a unique one from
111 -- the sequence.
112 -- 4. If a flag column is passed in, check if it is 'Y' or 'N'.
113 -- Raise exception for invalid flag.
114 -- 5. If a flag column is not passed in, default it to 'Y' or 'N'.
115 -- 6. Please don't pass in any FND_API.g_miss_char/num/date.
116 ---------------------------------------------------------------------
117
118 PROCEDURE create_event_header(
119 p_api_version IN NUMBER,
120 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
121 p_commit IN VARCHAR2 := FND_API.g_false,
122 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
123
124 x_return_status OUT NOCOPY VARCHAR2,
125 x_msg_count OUT NOCOPY NUMBER,
126 x_msg_data OUT NOCOPY VARCHAR2,
127
128 p_evh_rec IN evh_rec_type,
129 x_evh_id OUT NOCOPY NUMBER
130 );
131
132
133 --------------------------------------------------------------------
134 -- PROCEDURE
135 -- delete_event_header
136 --
137 -- PURPOSE
138 -- Delete an event header.
139 --
140 -- PARAMETERS
141 -- p_evh_id: the event_header_id
142 -- p_object_version: the object_version_number
143 --
144 -- NOTES
145 -- 1. Raise exception if the object_version_number doesn't match.
146 --------------------------------------------------------------------
147 PROCEDURE delete_event_header(
148 p_api_version IN NUMBER,
149 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
150 p_commit IN VARCHAR2 := FND_API.g_false,
151
152 x_return_status OUT NOCOPY VARCHAR2,
153 x_msg_count OUT NOCOPY NUMBER,
154 x_msg_data OUT NOCOPY VARCHAR2,
155
156 p_evh_id IN NUMBER,
157 p_object_version IN NUMBER
158 );
159
160
161 -------------------------------------------------------------------
162 -- PROCEDURE
163 -- lock_event_header
164 --
165 -- PURPOSE
166 -- Lock the event header.
167 --
168 -- PARAMETERS
169 -- p_evh_id: the event_header_id
170 -- p_object_version: the object_version_number
171 --
172 -- NOTES
173 -- 1. Raise exception if the object_version_number doesn't match.
174 --------------------------------------------------------------------
175 PROCEDURE lock_event_header(
176 p_api_version IN NUMBER,
177 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
178
179 x_return_status OUT NOCOPY VARCHAR2,
180 x_msg_count OUT NOCOPY NUMBER,
181 x_msg_data OUT NOCOPY VARCHAR2,
182
183 p_evh_id IN NUMBER,
184 p_object_version IN NUMBER
185 );
186
187
188 ---------------------------------------------------------------------
189 -- PROCEDURE
190 -- update_event_header
191 --
192 -- PURPOSE
193 -- Update the event header.
194 --
195 -- PARAMETERS
196 -- p_evh_rec: the record with new items
197 --
198 -- NOTES
199 -- 1. Raise exception if the object_version_number doesn't match.
200 -- 2. If an attribute is passed in as FND_API.g_miss_char/num/date,
201 -- that column won't be updated.
202 ----------------------------------------------------------------------
203 PROCEDURE update_event_header(
204 p_api_version IN NUMBER,
205 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
206 p_commit IN VARCHAR2 := FND_API.g_false,
207 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
208
209 x_return_status OUT NOCOPY VARCHAR2,
210 x_msg_count OUT NOCOPY NUMBER,
211 x_msg_data OUT NOCOPY VARCHAR2,
212
213 p_evh_rec IN evh_rec_type
214 );
215
216
217 ---------------------------------------------------------------------
218 -- PROCEDURE
219 -- validate_event_header
220 --
221 -- PURPOSE
222 -- Validate the event header record.
223 --
224 -- PARAMETERS
225 -- p_evh_rec: the event header record to be validated
226 --
227 -- NOTES
228 -- 1. p_evh_rec should be the complete event header record. There
229 -- should not be any FND_API.g_miss_char/num/date in it.
230 ----------------------------------------------------------------------
231 PROCEDURE validate_event_header(
232 p_api_version IN NUMBER,
233 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
234 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
235
236 x_return_status OUT NOCOPY VARCHAR2,
237 x_msg_count OUT NOCOPY NUMBER,
238 x_msg_data OUT NOCOPY VARCHAR2,
239
240 p_evh_rec IN evh_rec_type
241 );
242
243
244 ---------------------------------------------------------------------
245 -- PROCEDURE
246 -- check_evh_items
247 --
248 -- PURPOSE
249 -- Perform the item level checking including unique keys,
250 -- required columns, foreign keys, domain constraints.
251 --
252 -- PARAMETERS
253 -- p_evh_rec: the record to be validated
254 -- p_validation_mode: JTF_PLSQL_API.g_create/g_update
255 ---------------------------------------------------------------------
256 PROCEDURE check_evh_items(
257 p_evh_rec IN evh_rec_type,
258 p_validation_mode IN VARCHAR2 := JTF_PLSQL_API.g_create,
259 x_return_status OUT NOCOPY VARCHAR2
260 );
261
262
263 ---------------------------------------------------------------------
264 -- PROCEDURE
265 -- check_evh_record
266 --
267 -- PURPOSE
268 -- Check the record level business rules.
269 --
270 -- PARAMETERS
271 -- p_evh_rec: the record to be validated; may contain attributes
272 -- as FND_API.g_miss_char/num/date
273 -- p_complete_rec: the complete record after all "g_miss" items
274 -- have been replaced by current database values
275 ---------------------------------------------------------------------
276 PROCEDURE check_evh_record(
277 p_evh_rec IN evh_rec_type,
278 p_complete_rec IN evh_rec_type := NULL,
279 x_return_status OUT NOCOPY VARCHAR2
280 );
281
282
283 ---------------------------------------------------------------------
284 -- PROCEDURE
285 -- init_evh_rec
286 --
287 -- PURPOSE
288 -- Initialize all attributes to be FND_API.g_miss_char/num/date.
289 ---------------------------------------------------------------------
290 PROCEDURE init_evh_rec(
291 x_evh_rec OUT NOCOPY evh_rec_type
292 );
293
294
295 ---------------------------------------------------------------------
296 -- PROCEDURE
297 -- complete_evh_rec
298 --
299 -- PURPOSE
300 -- For update_event_header, some attributes may be passed in as
301 -- FND_API.g_miss_char/num/date if the user doesn't want to
302 -- update those attributes. This procedure will replace the
303 -- "g_miss" attributes with current database values.
304 --
305 -- PARAMETERS
306 -- p_evh_rec: the record which may contain attributes as
307 -- FND_API.g_miss_char/num/date
308 -- x_complete_rec: the complete record after all "g_miss" items
309 -- have been replaced by current database values
310 ---------------------------------------------------------------------
311 PROCEDURE complete_evh_rec(
312 p_evh_rec IN evh_rec_type,
313 x_complete_rec OUT NOCOPY evh_rec_type
314 );
315
316
317 ---------------------------------------------------------------------
318 -- PROCEDURE
319 -- check_evh_inter_entity
320 --
321 -- PURPOSE
322 -- Check the inter-entity level business rules.
323 --
324 -- PARAMETERS
325 -- p_evh_rec: the record to be validated; may contain attributes
326 -- as FND_API.g_miss_char/num/date
327 -- p_complete_rec: the complete record after all "g_miss" items
328 -- have been replaced by current database values
329 -- p_validation_mode: JTF_PLSQL_API.g_create/g_update
330 ---------------------------------------------------------------------
331 PROCEDURE check_evh_inter_entity(
332 p_evh_rec IN evh_rec_type,
333 p_complete_rec IN evh_rec_type,
334 p_validation_mode IN VARCHAR2,
335 x_return_status OUT NOCOPY VARCHAR2
336 );
337
338
339
340 END AMS_EventHeader_PVT;
[Home] [Help]