1 PACKAGE JTF_CAL_ITEMS_PVT AUTHID CURRENT_USER AS
2 /* $Header: jtfvcis.pls 120.1 2005/06/24 02:01:49 sanandan ship $ */
3 /*#
4 * Private APIs for the HTML Calendar module
5 * Access is restricted to Oracle Foundation internal development
6 * @rep:scope private
7 * @rep:product CAC
8 * @rep:displayname JTF Calendar Items Private API
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY CAC_APPOINTMENT
12 */
13
14 TYPE cal_item_rec_type IS RECORD
15 ( CAL_ITEM_ID NUMBER
16 , RESOURCE_ID NUMBER
17 , RESOURCE_TYPE VARCHAR2(30)
18 , ITEM_TYPE VARCHAR2(30)
19 , ITEM_TYPE_CODE VARCHAR2(30)
20 , ITEM_NAME VARCHAR2(80)
21 , ITEM_DESCRIPTION VARCHAR2(2000)
22 , SOURCE_CODE VARCHAR2(30)
23 , SOURCE_ID NUMBER
24 , START_DATE DATE
25 , END_DATE DATE
26 , TIMEZONE_ID NUMBER
27 , URL VARCHAR2(4000)
28 , CREATED_BY NUMBER
29 , CREATION_DATE DATE
30 , LAST_UPDATED_BY NUMBER
31 , LAST_UPDATE_DATE DATE
32 , LAST_UPDATE_LOGIN NUMBER
33 , OBJECT_VERSION_NUMBER NUMBER
34 , APPLICATION_ID NUMBER
35 );
36
37 --------------------------------------------------------------------------
38 -- Start of comments
39 -- API name : Insert_Row
40 -- Type : Private
41 -- Function : Create record in JTF_CAL_ITEMS table.
42 -- Pre-reqs : None.
43 -- Parameters :
44 -- name direction type required?
45 -- ---- --------- ---- ---------
46 -- p_api_version IN NUMBER required
47 -- p_init_msg_list IN VARCHAR2 optional
48 -- p_commit IN VARCHAR2 optional
49 -- p_validation_level IN NUMBER optional
50 -- x_return_status OUT VARCHAR2 required
51 -- x_msg_count OUT NUMBER required
52 -- x_msg_data OUT VARCHAR2 required
53 -- p_itm_rec IN cal_item_rec_type required
54 -- x_item_id OUT NUMBER required
55 --
56 -- Version : Current version 1.0
57 -- Previous version 1.0
58 -- Initial version 1.0
59 --
60 -- Notes: The object_version_number of a new entry is always 1.
61 --
62 -- End of comments
63 --------------------------------------------------------------------------
64 /*#
65 * Insert Row, inserts a calendar item into JTF_CAL_ITEMS_B table
66 * @param p_api_version API Version Required
67 * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
68 * @param p_commit Optional Default = FND_API.G_FALSE
69 * @param x_return_status Required Length = 1
70 * @param x_msg_count API Error message count, Required
71 * @param x_msg_data API Error message data, Required Length = 2000
72 * @param p_itm_rec Required take input record type object "cal_item_rec_type"
73 * @param x_cal_item_id Required
74 * @rep:scope private
75 * @rep:lifecycle active
76 * @rep:displayname Insert Row
77 */
78 PROCEDURE Insert_Row
79 ( p_api_version IN NUMBER
80 , p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false
81 , p_commit IN VARCHAR2 DEFAULT fnd_api.g_false
82 , p_validation_level IN NUMBER DEFAULT fnd_api.g_valid_level_full
83 , x_return_status OUT NOCOPY VARCHAR2
84 , x_msg_count OUT NOCOPY NUMBER
85 , x_msg_data OUT NOCOPY VARCHAR2
86 , p_itm_rec IN cal_item_rec_type
87 , x_cal_item_id OUT NOCOPY NUMBER
88 );
89
90 --------------------------------------------------------------------------
91 -- Start of comments
92 -- API name : Update_Row
93 -- Type : Private
94 -- Function : Update record in JTF_CAL_ITEMS table.
95 -- Pre-reqs : None.
96 -- Parameters :
97 -- name direction type required?
98 -- ---- --------- -------- ---------
99 -- p_api_version IN NUMBER required
100 -- p_init_msg_list IN VARCHAR2 optional
101 -- p_commit IN VARCHAR2 optional
102 -- p_validation_level IN NUMBER optional
103 -- x_return_status OUT VARCHAR2 required
104 -- x_msg_count OUT NUMBER required
105 -- x_msg_data OUT VARCHAR2 required
106 -- p_itm_rec IN cal_item_rec_type required
107 -- x_object_version_number OUT NUMBER required
108 --
109 -- Version : Current version 1.0
110 -- Previous version 1.0
111 -- Initial version 1.0
112 --
113 -- Notes: An item can only be updated if the object_version_number
114 -- is an exact match.
115 --
116 -- End of comments
117 --------------------------------------------------------------------------
118 /*#
119 * Update Item row, updates a calendar item into JTF_CAL_ITEMS_B table
120 * @param p_api_version API Version Required
121 * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
122 * @param p_commit Optional Default = FND_API.G_FALSE
123 * @param p_validation_level Optional DEFAULT fnd_api.g_valid_level_full
124 * @param x_return_status Required Length = 1
125 * @param x_msg_count API Error message count, Required
126 * @param x_msg_data API Error message data, Required Length = 2000
127 * @param p_itm_rec Required take input record type object "cal_item_rec_type"
128 * @param x_object_version_number Object Version Number
129 * @rep:scope private
130 * @rep:lifecycle active
131 * @rep:displayname Update Row
132 */
133 PROCEDURE Update_Row
134 ( p_api_version IN NUMBER
135 , p_init_msg_list IN VARCHAR2 := fnd_api.g_false
136 , p_commit IN VARCHAR2 := fnd_api.g_false
137 , p_validation_level IN NUMBER := fnd_api.g_valid_level_full
138 , x_return_status OUT NOCOPY VARCHAR2
139 , x_msg_count OUT NOCOPY NUMBER
140 , x_msg_data OUT NOCOPY VARCHAR2
141 , p_itm_rec IN cal_item_rec_type
142 , x_object_version_number OUT NOCOPY NUMBER
143 );
144 --------------------------------------------------------------------------
145 -- Start of comments
146 -- API Name : Delete_Row
147 -- Type : Private
148 -- Description : Delete record in JTF_CAL_ITEMS_B and
149 -- JTF_CAL_ITEMS_TL table
150 -- Pre-reqs : None
151 -- Parameters :
152 -- name direction type required?
153 -- ---- --------- ---- ---------
154 -- p_api_version IN NUMBER required
155 -- p_init_msg_list IN VARCHAR2 optional
156 -- p_commit IN VARCHAR2 optional
157 -- p_validation_level IN NUMBER optional
158 -- x_return_status OUT VARCHAR2 required
159 -- x_msg_count OUT NUMBER required
160 -- x_msg_data OUT VARCHAR2 required
161 -- p_cal_item_id IN NUMBER required
162 -- p_object_version_number IN NUMBER required
163 --
164 -- Version : Current version 1.0
165 -- Previous version 1.0
166 -- Initial version 1.0
167 --
168 -- Notes: An item can only be deleted if the object_version_number
169 -- is an exact match.
170 --
171 -- End of comments
172 --------------------------------------------------------------------------
173 /*#
174 * Delete Item row, deletes a calendar item from JTF_CAL_ITEMS_B table
175 * @param p_api_version API Version Required
176 * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
177 * @param p_commit Optional Default = FND_API.G_FALSE
178 * @param p_validation_level Optional DEFAULT fnd_api.g_valid_level_full
179 * @param x_return_status Required Length = 1
180 * @param x_msg_count API Error message count, Required
181 * @param x_msg_data API Error message data, Required Length = 2000
182 * @param p_cal_item_id Required
183 * @param p_object_version_number Object Version Number
184 * @rep:scope private
185 * @rep:lifecycle active
186 * @rep:displayname Delete Row
187 */
188 PROCEDURE Delete_Row
189 ( p_api_version IN NUMBER
190 , p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false
191 , p_commit IN VARCHAR2 DEFAULT fnd_api.g_false
192 , p_validation_level IN NUMBER DEFAULT fnd_api.g_valid_level_full
193 , x_return_status OUT NOCOPY VARCHAR2
194 , x_msg_count OUT NOCOPY NUMBER
195 , x_msg_data OUT NOCOPY VARCHAR2
196 , p_cal_item_id IN NUMBER
197 , p_object_version_number IN NUMBER
198 );
199
200 --------------------------------------------------------------------------
201 -- Start of comments
202 -- API name : Get_Object_Version
203 -- Type : Private
204 -- Function : Returns the current object version number for the given
205 -- Calendar Item.
206 -- Pre-reqs : None.
207 -- Parameters :
208 -- name direction type required?
209 -- ---- --------- ---- ---------
210 -- p_api_version IN NUMBER required
211 -- p_init_msg_list IN VARCHAR2 optional
212 -- p_commit IN VARCHAR2 optional
213 -- p_validation_level IN NUMBER optional
214 -- x_return_status OUT VARCHAR2 required
215 -- x_msg_count OUT NUMBER required
216 -- x_msg_data OUT VARCHAR2 required
217 -- p_Calendar_Item IN NUMBER required
218 -- x_object_version_number OUT NUMBER required
219 --
220 -- Version : Current version 1.0
221 -- Previous version 1.0
222 -- Initial version 1.0
223 --
224 -- Notes:
225 --
226 -- End of comments
227 --------------------------------------------------------------------------
228 /*#
229 * Get Object Version, Returns the current object version number for the given
230 * Calendar Item.
231 * @param p_api_version API Version Required
232 * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
233 * @param p_validation_level Optional DEFAULT fnd_api.g_valid_level_full
234 * @param x_return_status Required Length = 1
235 * @param x_msg_count API Error message count, Required
236 * @param x_msg_data API Error message data, Required Length = 2000
237 * @param p_cal_item_id Required
238 * @param x_object_version_number Out parameter
239 * @rep:scope private
240 * @rep:lifecycle active
241 * @rep:displayname Get Object Version
242 */
243 PROCEDURE Get_Object_Version
244 ( p_api_version IN NUMBER
245 , p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false
246 , p_validation_level IN NUMBER DEFAULT fnd_api.g_valid_level_full
247 , x_return_status OUT NOCOPY VARCHAR2
248 , x_msg_count OUT NOCOPY NUMBER
249 , x_msg_data OUT NOCOPY VARCHAR2
250 , p_cal_item_id IN NUMBER
251 , x_object_version_number OUT NOCOPY NUMBER
252 );
253
254
255 --------------------------------------------------------------------------
256 -- Start of comments
257 -- API name : GetUrl
258 -- Type : Private
259 -- Function : Returns the URL for given object/item. Used in JTF_CAL_PUB
260 -- API to populate url column in jtf_cal_items table
261 -- Pre-reqs : None.
262 -- Parameters :
263 -- name direction type required?
264 -- ---- --------- ---- ---------
265 -- p_source_code IN VARCHAR2 optional
266 -- p_source_id IN NUMBER optional
267 --
268 -- Version : Current version 1.0
269 -- Previous version 1.0
270 -- Initial version 1.0
271 --
272 -- Notes:
273 --
274 -- End of comments
275 --------------------------------------------------------------------------
276
277 FUNCTION GetUrl(p_source_code IN VARCHAR2)
278 RETURN VARCHAR2;
279
280 FUNCTION GetUrlParams(p_source_code IN VARCHAR2,
281 p_source_id IN NUMBER)
282 RETURN VARCHAR2;
283
284 --------------------------------------------------------------------------
285 -- Start of comments
286 -- API name : GetName
287 -- Type : Private
288 -- Function : Returns name for given object/item. Used in JTF_CAL_PVT
289 -- to collect calendar view data
290 -- Pre-reqs : None.
291 -- Parameters :
292 -- name direction type required?
293 -- ---- --------- ---- ---------
294 -- p_source_code IN VARCHAR2 optional
295 -- p_source_id IN NUMBER optional
296 --
297 -- Version : Current version 1.0
298 -- Previous version 1.0
299 -- Initial version 1.0
300 --
301 -- Notes:
302 --
303 -- End of comments
304 --------------------------------------------------------------------------
305
306 FUNCTION GetName(p_source_code IN VARCHAR2,
307 p_source_id IN NUMBER)
308 RETURN VARCHAR2;
309
310 --------------------------------------------------------------------------
311 -- Start of comments
312 -- API Name : Add_Language
313 -- Type : Private
314 -- Description : Additional Language processing for JTF_CAL_ITEMS_B and
315 -- _TL tables.
316 -- Pre-reqs : None
317 -- Parameters : None
318 -- Version : Current version 1.0
319 -- Previous version none
320 -- Initial version 1.0
321 --
322 -- Notes:
323 --
324 -- End of comments
325 --------------------------------------------------------------------------
326 PROCEDURE Add_Language;
327
328 --------------------------------------------------------------------------
329 -- Start of comments
330 -- API Name : Translate_Row
331 -- Type : Private
332 -- Description : Additional Language processing for JTF_CAL_ITEMS_B and
333 -- _TL tables. Used in the FNDLOAD definition file (.lct)
334 -- Pre-reqs : None
335 -- Parameters : None
336 -- Version : Current version 1.0
337 -- Previous version none
338 -- Initial version 1.0
339 --
340 -- Notes: :
341 --
342 -- End of comments
343 --------------------------------------------------------------------------
344 PROCEDURE Translate_Row
345 ( p_cal_item_id IN NUMBER
346 , p_item_name IN VARCHAR2
347 , p_item_description IN VARCHAR2
348 , p_owner IN VARCHAR2
349 );
350
351 --------------------------------------------------------------------------
352 -- Start of comments
353 -- API Name : Load_Row
354 -- Type : Private
355 -- Description : Additional Language processing for JTF_CAL_ITEMS_B and
356 -- _TL tables. Used in the FNDLOAD definition file (.lct)
357 -- Pre-reqs : None
358 -- Parameters : None
359 -- Version : Current version 1.0
360 -- Previous version none
361 -- Initial version 1.0
362 --
363 -- Notes: :
364 --
365 -- End of comments
366 --------------------------------------------------------------------------
367 PROCEDURE Load_Row
368 ( p_cal_item_id IN NUMBER
369 , p_itm_rec IN Cal_Item_rec_type
370 , p_owner IN VARCHAR2
371 );
372
373
374
375 END JTF_CAL_Items_PVT;
[Home] [Help]