1 PACKAGE jtf_task_recurrences_pub AS
2 /* $Header: jtfptkus.pls 120.1 2005/07/02 01:00:16 appldev ship $ */
3 /*#
4 * This is the public package to validate, crete, update, and delete task recurrence.
5 *
6 * @rep:scope internal
7 * @rep:product CAC
8 * @rep:displayname Task Recurrence
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY CAC_CAL_TASK
12 */
13
14 g_pkg_name VARCHAR2(30) := 'JTF_TASK_RECURRENCES_PUB';
15
16 TYPE output_dates_rec IS TABLE OF DATE
17 INDEX BY BINARY_INTEGER;
18
19 TYPE task_details_rec IS RECORD (
20 task_id NUMBER,
21 task_number NUMBER,
22 task_name VARCHAR2(30)
23 );
24
25 TYPE task_recurrence_rec IS RECORD (
26 recurrence_rule_id NUMBER,
27 object_version_number NUMBER,
28 occurs_which NUMBER,
29 day_of_week NUMBER,
30 date_of_month NUMBER,
31 occurs_month NUMBER,
32 occurs_uom VARCHAR2(3),
33 occurs_every NUMBER,
34 occurs_number NUMBER,
35 start_date_active DATE,
36 end_date_active DATE,
37 attribute1 VARCHAR2(150),
38 attribute2 VARCHAR2(150),
39 attribute3 VARCHAR2(150),
40 attribute4 VARCHAR2(150),
41 attribute5 VARCHAR2(150),
42 attribute6 VARCHAR2(150),
43 attribute7 VARCHAR2(150),
44 attribute8 VARCHAR2(150),
45 attribute9 VARCHAR2(150),
46 attribute10 VARCHAR2(150),
47 attribute11 VARCHAR2(150),
48 attribute12 VARCHAR2(150),
49 attribute13 VARCHAR2(150),
50 attribute14 VARCHAR2(150),
51 attribute15 VARCHAR2(150),
52 attribute_category VARCHAR2(30) ,
53 sunday VARCHAR2(1) ,
54 monday VARCHAR2(1) ,
55 tuesday VARCHAR2(1) ,
56 wednesday VARCHAR2(1) ,
57 thursday VARCHAR2(1) ,
58 friday VARCHAR2(1) ,
59 saturday VARCHAR2(1)
60 );
61
62
63 creating_recurrences BOOLEAN := FALSE;
64
65 /*#
66 * Creates a Task recurrence.
67 *
68 * @param p_api_version the standard API version number
69 * @param p_init_msg_list the standard API flag allows API callers to request
70 * that the API does the initialization of the message list on their behalf.
71 * By default, the message list will not be initialized.
72 * @param p_commit the standard API flag is used by API callers to ask
73 * the API to commit on their behalf after performing its function
74 * By default, the commit will not be performed.
75 * @param p_task_id the task id for recurrence creation
76 * @param p_task_number the task number for recurrence creation
77 * @param p_occurs_which the occurs which for recurrence creation
78 * @param p_template_flag the template flag for recurrence creation
79 * @param p_day_of_week the day of week for recurrence creation
80 * @param p_date_of_month the date of month for recurrence creation
81 * @param p_occurs_month the occurs month for recurrence creation
82 * @param p_occurs_uom the occurs uom for recurrence creation
83 * @param p_occurs_every the occurs every for recurrence creation
84 * @param p_occurs_number the occurs number for recurrence creation
85 * @param p_start_date_active the start date active for recurrence creation
86 * @param p_end_date_active the end date active for recurrence creation
87 * @param x_return_status returns the result of all the operations performed
88 * by the API and must have one of the following values:
89 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
90 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
91 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
92 * @param x_msg_count returns the number of messages in the API message list
93 * <code>x_msg_count</code> returns number one.
94 * @param x_msg_data returns the message in an encoded format if
95 * @param x_recurrence_rule_id the recurrence rule id being created
96 * @param x_task_rec the task record being created
97 * @param x_reccurences_generated the recurrences generated
98 * @param p_attribute1 attribute1 for flexfield
99 * @param p_attribute2 attribute2 for flexfield
100 * @param p_attribute3 attribute3 for flexfield
101 * @param p_attribute4 attribute4 for flexfield
102 * @param p_attribute5 attribute5 for flexfield
103 * @param p_attribute6 attribute6 for flexfield
104 * @param p_attribute7 attribute7 for flexfield
105 * @param p_attribute8 attribute8 for flexfield
106 * @param p_attribute9 attribute9 for flexfield
107 * @param p_attribute10 attribute10 for flexfield
108 * @param p_attribute11 attribute11 for flexfield
109 * @param p_attribute12 attribute12 for flexfield
110 * @param p_attribute13 attribute13 for flexfield
111 * @param p_attribute14 attribute14 for flexfield
112 * @param p_attribute15 attribute15 for flexfield
113 * @param p_attribute_category attribute category
114 * @param p_sunday sunday
115 * @param p_monday monday
116 * @param p_tuesday tuesday
117 * @param p_wednesday wednesday
118 * @param p_thursday thursday
119 * @param p_friday friday
120 * @param p_saturday saturday
121 * @rep:scope internal
122 * @rep:lifecycle active
123 * @rep:displayname Create Task Recurrence
124 * @rep:compatibility S
125 */
126
127 PROCEDURE create_task_recurrence (
128 p_api_version IN NUMBER,
129 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
130 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
131 p_task_id IN NUMBER DEFAULT NULL,
132 p_task_number IN VARCHAR2 DEFAULT NULL,
133 p_occurs_which IN INTEGER DEFAULT NULL,
134 p_template_flag IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
135 p_day_of_week IN INTEGER DEFAULT NULL,
136 p_date_of_month IN INTEGER DEFAULT NULL,
137 p_occurs_month IN INTEGER DEFAULT NULL,
138 p_occurs_uom IN VARCHAR2 DEFAULT NULL,
139 p_occurs_every IN INTEGER DEFAULT NULL,
140 p_occurs_number IN INTEGER DEFAULT NULL,
141 p_start_date_active IN DATE DEFAULT NULL,
142 p_end_date_active IN DATE DEFAULT NULL,
143 x_return_status OUT NOCOPY VARCHAR2,
144 x_msg_count OUT NOCOPY NUMBER,
145 x_msg_data OUT NOCOPY VARCHAR2,
146 x_recurrence_rule_id OUT NOCOPY NUMBER,
147 x_task_rec OUT NOCOPY jtf_task_recurrences_pub.task_details_rec,
148 x_reccurences_generated OUT NOCOPY INTEGER,
149 p_attribute1 IN VARCHAR2 DEFAULT null ,
150 p_attribute2 IN VARCHAR2 DEFAULT null ,
151 p_attribute3 IN VARCHAR2 DEFAULT null ,
152 p_attribute4 IN VARCHAR2 DEFAULT null ,
153 p_attribute5 IN VARCHAR2 DEFAULT null ,
154 p_attribute6 IN VARCHAR2 DEFAULT null ,
155 p_attribute7 IN VARCHAR2 DEFAULT null ,
156 p_attribute8 IN VARCHAR2 DEFAULT null ,
157 p_attribute9 IN VARCHAR2 DEFAULT null ,
158 p_attribute10 IN VARCHAR2 DEFAULT null ,
159 p_attribute11 IN VARCHAR2 DEFAULT null ,
160 p_attribute12 IN VARCHAR2 DEFAULT null ,
161 p_attribute13 IN VARCHAR2 DEFAULT null ,
162 p_attribute14 IN VARCHAR2 DEFAULT null ,
163 p_attribute15 IN VARCHAR2 DEFAULT null ,
164 p_attribute_category IN VARCHAR2 DEFAULT null ,
165 p_sunday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
166 p_monday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
167 p_tuesday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
168 p_wednesday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
169 p_thursday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
170 p_friday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
171 p_saturday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char
172 );
173
174
175
176 /*#
177 * Updates a Task recurrence.
178 *
179 * @param p_api_version the standard API version number
180 * @param p_init_msg_list the standard API flag allows API callers to request
181 * that the API does the initialization of the message list on their behalf.
182 * By default, the message list will not be initialized.
183 * @param p_commit the standard API flag is used by API callers to ask
184 * the API to commit on their behalf after performing its function
185 * By default, the commit will not be performed.
186 * @param p_task_id the task id for recurrence update
187 * @param p_recurrence_rule_id the recurrence rule id for recurrence update
188 * @param p_occurs_which the occurs which for recurrence update
189 * @param p_day_of_week the day of week for recurrence update
190 * @param p_date_of_month the date of month for recurrence update
191 * @param p_occurs_month the occurs month for recurrence update
192 * @param p_occurs_uom the occurs uom for recurrence update
193 * @param p_occurs_every the occurs every for recurrence update
194 * @param p_occurs_number the occurs number for recurrence update
195 * @param p_start_date_active the start date active for recurrence update
196 * @param p_end_date_active the end date active for recurrence update
197 * @param p_template_flag the template flag for recurrence update
198 * @param p_attribute1 attribute1 for flexfield
199 * @param p_attribute2 attribute2 for flexfield
200 * @param p_attribute3 attribute3 for flexfield
201 * @param p_attribute4 attribute4 for flexfield
202 * @param p_attribute5 attribute5 for flexfield
203 * @param p_attribute6 attribute6 for flexfield
204 * @param p_attribute7 attribute7 for flexfield
205 * @param p_attribute8 attribute8 for flexfield
206 * @param p_attribute9 attribute9 for flexfield
207 * @param p_attribute10 attribute10 for flexfield
208 * @param p_attribute11 attribute11 for flexfield
209 * @param p_attribute12 attribute12 for flexfield
210 * @param p_attribute13 attribute13 for flexfield
211 * @param p_attribute14 attribute14 for flexfield
212 * @param p_attribute15 attribute15 for flexfield
213 * @param p_attribute_category attribute category
214 * @param p_sunday sunday
215 * @param p_monday monday
216 * @param p_tuesday tuesday
217 * @param p_wednesday wednesday
218 * @param p_thursday thursday
219 * @param p_friday friday
220 * @param p_saturday saturday
221 * @param x_new_recurrence_rule_id the new recurrence rule id being created
222 * @param x_return_status returns the result of all the operations performed
223 * by the API and must have one of the following values:
224 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
225 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
226 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
227 * @param x_msg_count returns the number of messages in the API message list
228 * <code>x_msg_count</code> returns number one.
229 * @param x_msg_data returns the message in an encoded format if
230 * @rep:scope internal
231 * @rep:lifecycle active
232 * @rep:displayname Update Task Recurrence
233 * @rep:compatibility S
234 */
235 PROCEDURE update_task_recurrence (
236 p_api_version IN NUMBER,
237 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
238 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
239 p_task_id IN NUMBER,
240 p_recurrence_rule_id IN NUMBER,
241 p_occurs_which IN INTEGER DEFAULT NULL,
242 p_day_of_week IN INTEGER DEFAULT NULL,
243 p_date_of_month IN INTEGER DEFAULT NULL,
244 p_occurs_month IN INTEGER DEFAULT NULL,
245 p_occurs_uom IN VARCHAR2 DEFAULT NULL,
246 p_occurs_every IN INTEGER DEFAULT NULL,
247 p_occurs_number IN INTEGER DEFAULT NULL,
248 p_start_date_active IN DATE DEFAULT NULL,
249 p_end_date_active IN DATE DEFAULT NULL,
250 p_template_flag IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
251 p_attribute1 IN VARCHAR2 DEFAULT NULL ,
252 p_attribute2 IN VARCHAR2 DEFAULT NULL ,
253 p_attribute3 IN VARCHAR2 DEFAULT NULL ,
254 p_attribute4 IN VARCHAR2 DEFAULT NULL ,
255 p_attribute5 IN VARCHAR2 DEFAULT NULL ,
256 p_attribute6 IN VARCHAR2 DEFAULT NULL ,
257 p_attribute7 IN VARCHAR2 DEFAULT NULL ,
258 p_attribute8 IN VARCHAR2 DEFAULT NULL ,
259 p_attribute9 IN VARCHAR2 DEFAULT NULL ,
260 p_attribute10 IN VARCHAR2 DEFAULT NULL ,
261 p_attribute11 IN VARCHAR2 DEFAULT NULL ,
262 p_attribute12 IN VARCHAR2 DEFAULT NULL ,
263 p_attribute13 IN VARCHAR2 DEFAULT NULL ,
264 p_attribute14 IN VARCHAR2 DEFAULT NULL ,
265 p_attribute15 IN VARCHAR2 DEFAULT NULL ,
266 p_attribute_category IN VARCHAR2 DEFAULT NULL ,
267 p_sunday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
268 p_monday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
269 p_tuesday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
270 p_wednesday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
271 p_thursday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
272 p_friday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
273 p_saturday IN VARCHAR2 DEFAULT jtf_task_utl.g_no_char,
274 x_new_recurrence_rule_id OUT NOCOPY NUMBER,
275 x_return_status OUT NOCOPY VARCHAR2,
276 x_msg_count OUT NOCOPY NUMBER,
277 x_msg_data OUT NOCOPY VARCHAR2
278 );
279 END;
[Home] [Help]