1 PACKAGE JTF_CAL_ITEMS_PUB AUTHID CURRENT_USER AS
2 /* $Header: jtfpcis.pls 120.2 2006/06/30 10:42:44 sbarat ship $ */
3 /*#
4 * Public APIs for the HTML Calendar module.
5 * This API facilitates create, update and delete of calendar items like 'CALENDAR', 'MEMO', 'TASK'
6 * @rep:scope internal
7 * @rep:product CAC
8 * @rep:displayname JTF Calendar Items Public API
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY CAC_APPOINTMENT
12 */
13
14 TYPE calItemRec IS RECORD
15 ( CAL_RESOURCE_ID NUMBER := FND_API.g_miss_num -- JTF Resource ID of calendar on which Item
16 -- should be displayed
17 , CAL_RESOURCE_TYPE VARCHAR2(30) := FND_API.g_miss_char -- JTF Resource Type of resource on which
18 -- item should be displayed values:
19 -- RS_EMPLOYEE and RS_GROUP
20 , CAL_ITEM_ID NUMBER := FND_API.g_miss_num -- Calendar Item key only used for update
21 -- and delete
22 , ITEM_TYPE_CODE VARCHAR2(30) := FND_API.g_miss_char -- 'CALENDAR', 'MEMO', 'TASK' determines
23 -- where the item will be displayed
24 , ITEM_NAME VARCHAR2(80) := FND_API.g_miss_char -- Short Name/description that will be
25 -- (partly)displayed
26 , ITEM_DESCRIPTION VARCHAR2(2000) := FND_API.g_miss_char -- Description of the item, for future use
27 -- think balloon text
28 , SOURCE_CODE VARCHAR2(30) := FND_API.g_miss_char -- JTF_OBJECTS source code of the parent
29 -- object, may be used in future for drill
30 -- down
31 , SOURCE_ID NUMBER := FND_API.g_miss_num -- Primary key for the parent object as
32 -- defined in JTF_OBJECTS, may be used in
33 -- future for drill down
34 , START_DATE DATE := FND_API.g_miss_date -- Start date and time for the item
35 , END_DATE DATE := FND_API.g_miss_date -- End date and time for the item
36 , TIMEZONE_ID NUMBER := FND_API.g_miss_num -- Timezone ID from HZ_TIMEZONES
37 , URL VARCHAR2(4000) := FND_API.g_miss_char -- URL to drill down to parent object
38 , CREATED_BY NUMBER := FND_API.g_miss_num -- Standard Who Column (only used by CreateItem)
39 , CREATION_DATE DATE := FND_API.g_miss_date -- Standard Who Column (only used by CreateItem)
40 , LAST_UPDATED_BY NUMBER := FND_API.g_miss_num -- Standard Who Column
41 , LAST_UPDATE_DATE DATE := FND_API.g_miss_date -- Standard Who Column
42 , LAST_UPDATE_LOGIN NUMBER := FND_API.g_miss_num -- Standard Who Column
43 , OBJECT_VERSION_NUMBER NUMBER := FND_API.g_miss_num -- Object version number for the Calendar Item
44 -- can be obtained with GetObjectVerion
45 , APPLICATION_ID NUMBER := FND_API.g_miss_num -- Application ID of parent object
46 );
47
48 --------------------------------------------------------------------------
49 -- Start of comments
50 -- API name : CreateItem
51 -- Type : Public
52 -- Function : Create Calendar Item in JTF_CAL_ITEMS table.
53 -- Pre-reqs : None.
54 -- Parameters :
55 -- name direction type required?
56 -- ---- --------- ---- ---------
57 -- p_api_version IN NUMBER required
58 -- p_init_msg_list IN VARCHAR2 optional
59 -- p_commit IN VARCHAR2 optional
60 -- p_validation_level IN NUMBER optional
61 -- x_return_status OUT VARCHAR2 required
62 -- x_msg_count OUT NUMBER required
63 -- x_msg_data OUT VARCHAR2 required
64 -- p_itm_rec IN CALItemRec required
65 -- x_item_id OUT NUMBER required
66 --
67 -- Version : Current version 1.0
68 -- Previous version 1.0
69 -- Initial version 1.0
70 --
71 -- Notes: The object_version_number of a new entry is always 1.
72 --
73 -- End of comments
74 --------------------------------------------------------------------------
75 /*#
76 * Create Item, inserts a calendar item into JTF_CAL_ITEMS_B table
77 * @param p_api_version API Version Required
78 * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
79 * @param p_commit Optional Default = FND_API.G_FALSE
80 * @param x_return_status Required Length = 1
81 * @param x_msg_count API Error message count, Required
82 * @param x_msg_data API Error message data, Required Length = 2000
83 * @param p_itm_rec Required take input record type object "CALItemRec"
84 * @param x_cal_item_id Required
85 * @rep:scope internal
86 * @rep:lifecycle active
87 * @rep:displayname Create Item
88 */
89 PROCEDURE CreateItem
90 ( p_api_version IN NUMBER
91 , p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false
92 , p_commit IN VARCHAR2 DEFAULT fnd_api.g_false
93 , x_return_status OUT NOCOPY VARCHAR2
94 , x_msg_count OUT NOCOPY NUMBER
95 , x_msg_data OUT NOCOPY VARCHAR2
96 , p_itm_rec IN CalItemRec
97 , x_cal_item_id OUT NOCOPY NUMBER
98 );
99
100 --------------------------------------------------------------------------
101 -- Start of comments
102 -- API name : UpdateItem
103 -- Type : Public
104 -- Function : Update a Calendar Item in the JTF_CAL_ITEMS tables.
105 -- Pre-reqs : None.
106 -- Parameters :
107 -- name direction type required?
108 -- ---- --------- -------- ---------
109 -- p_api_version IN NUMBER required
110 -- p_init_msg_list IN VARCHAR2 optional
111 -- p_commit IN VARCHAR2 optional
112 -- p_validation_level IN NUMBER optional
113 -- x_return_status OUT VARCHAR2 required
114 -- x_msg_count OUT NUMBER required
115 -- x_msg_data OUT VARCHAR2 required
116 -- p_itm_rec IN CalItemRec required
117 -- x_object_version_number OUT NUMBER required
118 --
119 -- Version : Current version 1.0
120 -- Previous version 1.0
121 -- Initial version 1.0
122 --
123 -- Notes: - An item can only be updated if the object_version_number
124 -- is an exact match.
125 -- - When an update was successful the the new object_version_number
126 -- will be returned.
127 --
128 -- End of comments
129 --------------------------------------------------------------------------
130 /*#
131 * Update Item, updates a calendar item into JTF_CAL_ITEMS_B table
132 * @param p_api_version API Version Required
133 * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
134 * @param p_commit Optional Default = FND_API.G_FALSE
135 * @param p_validation_level Optional DEFAULT fnd_api.g_valid_level_full
136 * @param x_return_status Required Length = 1
137 * @param x_msg_count API Error message count, Required
138 * @param x_msg_data API Error message data, Required Length = 2000
139 * @param p_itm_rec Required take input record type object "CALItemRec"
140 * @param x_object_version_number Object Version Number
141 * @rep:scope internal
142 * @rep:lifecycle active
143 * @rep:displayname Update Item
144 */
145 PROCEDURE UpdateItem
146 ( p_api_version IN NUMBER
147 , p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false
148 , p_commit IN VARCHAR2 DEFAULT fnd_api.g_false
149 , p_validation_level IN NUMBER DEFAULT fnd_api.g_valid_level_full
150 , x_return_status OUT NOCOPY VARCHAR2
151 , x_msg_count OUT NOCOPY NUMBER
152 , x_msg_data OUT NOCOPY VARCHAR2
153 , p_itm_rec IN CalItemRec
154 , x_object_version_number OUT NOCOPY NUMBER
155 );
156
157 --------------------------------------------------------------------------
158 -- Start of comments
159 -- API Name : DeleteItem
160 -- Type : Public
161 -- Description : Delete a Calendar Item from the JTF_CAL_ITEMS_B and
162 -- JTF_CAL_ITEMS_TL table
163 -- Pre-reqs : None
164 -- Parameters :
165 -- name direction type required?
166 -- ---- --------- ---- ---------
167 -- p_api_version IN NUMBER required
168 -- p_init_msg_list IN VARCHAR2 optional
169 -- p_commit IN VARCHAR2 optional
170 -- p_validation_level IN NUMBER optional
171 -- x_return_status OUT VARCHAR2 required
172 -- x_msg_count OUT NUMBER required
173 -- x_msg_data OUT VARCHAR2 required
174 -- p_cal_item_id IN NUMBER required
175 -- p_object_version_number IN NUMBER required
176 --
177 -- Version : Current version 1.0
178 -- Previous version 1.0
179 -- Initial version 1.0
180 --
181 -- Notes: An item can only be deleted if the object_version_number
182 -- is an exact match.
183 --
184 -- End of comments
185 --------------------------------------------------------------------------
186 /*#
187 * Delete Item, deletes a calendar item from JTF_CAL_ITEMS_B table
188 * @param p_api_version API Version Required
189 * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
190 * @param p_commit Optional Default = FND_API.G_FALSE
191 * @param p_validation_level Optional DEFAULT fnd_api.g_valid_level_full
192 * @param x_return_status Required Length = 1
193 * @param x_msg_count API Error message count, Required
194 * @param x_msg_data API Error message data, Required Length = 2000
195 * @param p_cal_item_id Required
196 * @param p_object_version_number Object Version number
197 * @rep:scope internal
198 * @rep:lifecycle active
199 * @rep:displayname Delete Item
200 */
201 PROCEDURE DeleteItem
202 ( p_api_version IN NUMBER
203 , p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false
204 , p_commit IN VARCHAR2 DEFAULT fnd_api.g_false
205 , p_validation_level IN NUMBER DEFAULT fnd_api.g_valid_level_full
206 , x_return_status OUT NOCOPY VARCHAR2
207 , x_msg_count OUT NOCOPY NUMBER
208 , x_msg_data OUT NOCOPY VARCHAR2
209 , p_cal_item_id IN NUMBER
210 , p_object_version_number IN NUMBER
211 );
212
213 --------------------------------------------------------------------------
214 -- Start of comments
215 -- API name : GetObjectVersion
216 -- Type : Public
217 -- Function : Returns the current object version number for the given
218 -- Calendar Item.
219 -- Pre-reqs : None.
220 -- Parameters :
221 -- name direction type required?
222 -- ---- --------- ---- ---------
223 -- p_api_version IN NUMBER required
224 -- p_init_msg_list IN VARCHAR2 optional
225 -- p_commit IN VARCHAR2 optional
226 -- p_validation_level IN NUMBER optional
227 -- x_return_status OUT VARCHAR2 required
228 -- x_msg_count OUT NUMBER required
229 -- x_msg_data OUT VARCHAR2 required
230 -- p_Calendar_Item IN NUMBER required
231 -- x_object_version_number OUT NUMBER required
232 --
233 -- Version : Current version 1.0
234 -- Previous version 1.0
235 -- Initial version 1.0
236 --
237 -- Notes:
238 --
239 -- End of comments
240 --------------------------------------------------------------------------
241 /*#
242 * Get Object Version, Returns the current object version number for the given
243 * Calendar Item.
244 * @param p_api_version API Version Required
245 * @param p_init_msg_list Initialize message list flag, Optional Default = FND_API.G_FALSE
246 * @param p_validation_level Optional DEFAULT fnd_api.g_valid_level_full
247 * @param x_return_status Required Length = 1
248 * @param x_msg_count API Error message count, Required
249 * @param x_msg_data API Error message data, Required Length = 2000
250 * @param p_cal_item_id Required
251 * @param x_object_version_number Out parameter
252 * @rep:scope internal
253 * @rep:lifecycle active
254 * @rep:displayname Get Object Version
255 */
256 PROCEDURE GetObjectVersion
257 ( p_api_version IN NUMBER
258 , p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false
259 , p_validation_level IN NUMBER DEFAULT fnd_api.g_valid_level_full
260 , x_return_status OUT NOCOPY VARCHAR2
261 , x_msg_count OUT NOCOPY NUMBER
262 , x_msg_data OUT NOCOPY VARCHAR2
263 , p_cal_item_id IN NUMBER
264 , x_object_version_number OUT NOCOPY NUMBER
265 );
266
267 END JTF_CAL_Items_PUB;
[Home] [Help]