1 PACKAGE JTF_TASK_CONFIRMATION_PUB AS
2 /* $Header: jtfptcfs.pls 120.1 2005/07/02 00:58:17 appldev noship $ */
3 /*#
4 * This is the public interface to set task confirmation counter
5 * and status
6 *
7 * @rep:scope internal
8 * @rep:product CAC
9 * @rep:lifecycle active
10 * @rep:displayname Task Confirmation
11 * @rep:compatibility S
12 * @rep:category BUSINESS_ENTITY CAC_CAL_TASK
13 */
14
15
16 /*#
17 * sets the customer confirmation status and counter.
18 *
19 * @param p_api_version the standard API version number
20 * @param p_init_msg_list the standard API flag allows API callers to request
21 * that the API does the initialization of the message list on their behalf.
22 * By default, the message list will not be initialized.
23 * @param p_commit the standard API flag is used by API callers to ask
24 * the API to commit on their behalf after performing its function
25 * By default, the commit will not be performed.
26 * @param x_return_status returns the result of all the operations performed
27 * by the API and must have one of the following values:
28 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
29 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
30 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
31 * @param x_msg_count returns the number of messages in the API message list
32 * @param x_msg_data returns the message in an encoded format if
33 * <code>x_msg_count</code> returns number one.
34 *
35 * @param p_object_version_number is the object version number of the
36 * task that is to be updated.
37 * @param p_task_id is the task id of the task to be updated in jtf_tasks_b
38 * table.
39 * @param p_task_confirmation_status is the task confirmation status of the
40 * task to be updated in jtf_tasks_b table.
41 * @param p_task_confirmation_counter is the task confirmation counter of the
42 * task to be updated in jtf_tasks_b table.
43 * @paraminfo {@rep:precision 6000}
44 *
45 * @rep:scope internal
46 * @rep:lifecycle active
47 * @rep:displayname Reset Customer Confirmation Counter
48 * @rep:compatibility S
49 */
50
51 PROCEDURE SET_COUNTER_STATUS (
52 p_api_version IN NUMBER,
53 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
54 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
55 x_return_status OUT NOCOPY VARCHAR2,
56 x_msg_count OUT NOCOPY NUMBER,
57 x_msg_data OUT NOCOPY VARCHAR2,
58 p_object_version_number IN OUT NOCOPY NUMBER,
59 p_task_id IN NUMBER,
60 p_task_confirmation_status IN VARCHAR2,
61 p_task_confirmation_counter IN NUMBER
62 );
63
64
65
66 /*#
67 * Resets the customer confirmation counter to zero.
68 *
69 * @param p_api_version the standard API version number
70 * @param p_init_msg_list the standard API flag allows API callers to request
71 * that the API does the initialization of the message list on their behalf.
72 * By default, the message list will not be initialized.
73 * @param p_commit the standard API flag is used by API callers to ask
74 * the API to commit on their behalf after performing its function
75 * By default, the commit will not be performed.
76 * @param x_return_status returns the result of all the operations performed
77 * by the API and must have one of the following values:
78 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
79 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
80 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
81 * @param x_msg_count returns the number of messages in the API message list
82 * @param x_msg_data returns the message in an encoded format if
83 * <code>x_msg_count</code> returns number one.
84 *
85 * @param p_object_version_number is the object version number of the
86 * task that is to be updated.
87 * @param p_task_id is the task id of the task to be updated in jtf_tasks_b
88 * table.
89 * @paraminfo {@rep:precision 6000}
90 *
91 * @rep:scope internal
92 * @rep:lifecycle active
93 * @rep:displayname Reset Customer Confirmation Counter
94 * @rep:compatibility S
95 */
96
97 PROCEDURE RESET_COUNTER (
98 p_api_version IN NUMBER,
99 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
100 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
101 x_return_status OUT NOCOPY VARCHAR2,
102 x_msg_count OUT NOCOPY NUMBER,
103 x_msg_data OUT NOCOPY VARCHAR2,
104 p_object_version_number IN OUT NOCOPY NUMBER,
105 p_task_id IN NUMBER
106 );
107
108 /*#
109 * Increases the customer confirmation counter by 1.
110 *
111 * @param p_api_version the standard API version number
112 * @param p_init_msg_list the standard API flag allows API callers to request
113 * that the API does the initialization of the message list on their behalf.
114 * By default, the message list will not be initialized.
115 * @param p_commit the standard API flag is used by API callers to ask
116 * the API to commit on their behalf after performing its function
117 * By default, the commit will not be performed.
118 * @param x_return_status returns the result of all the operations performed
119 * by the API and must have one of the following values:
120 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
121 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
122 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
123 * @param x_msg_count returns the number of messages in the API message list
124 * @param x_msg_data returns the message in an encoded format if
125 * <code>x_msg_count</code> returns number one.
126 *
127 * @param p_object_version_number is the object version number of the
128 * task that is to be updated.
129 * @param p_task_id is the task id of the task to be updated in jtf_tasks_b
130 * table.
131 * @paraminfo {@rep:precision 6000}
132 *
133 * @rep:scope internal
134 * @rep:lifecycle active
135 * @rep:displayname Reset Customer Confirmation Counter
136 * @rep:compatibility S
137 */
138
139 PROCEDURE INCREASE_COUNTER (
140 p_api_version IN NUMBER,
141 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
142 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
143 x_return_status OUT NOCOPY VARCHAR2,
144 x_msg_count OUT NOCOPY NUMBER,
145 x_msg_data OUT NOCOPY VARCHAR2,
146 p_object_version_number IN OUT NOCOPY NUMBER,
147 p_task_id IN NUMBER
148 );
149
150 /*#
151 * Decreases the customer confirmation counter by 1.
152 *
153 * @param p_api_version the standard API version number
154 * @param p_init_msg_list the standard API flag allows API callers to request
155 * that the API does the initialization of the message list on their behalf.
156 * By default, the message list will not be initialized.
157 * @param p_commit the standard API flag is used by API callers to ask
158 * the API to commit on their behalf after performing its function
159 * By default, the commit will not be performed.
160 * @param x_return_status returns the result of all the operations performed
161 * by the API and must have one of the following values:
162 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
163 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
164 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
165 * @param x_msg_count returns the number of messages in the API message list
166 * @param x_msg_data returns the message in an encoded format if
167 * <code>x_msg_count</code> returns number one.
168 *
169 * @param p_object_version_number is the object version number of the
170 * task that is to be updated.
171 * @param p_task_id is the task id of the task to be updated in jtf_tasks_b
172 * table.
173 * @paraminfo {@rep:precision 6000}
174 *
175 * @rep:scope internal
176 * @rep:lifecycle active
177 * @rep:displayname Reset Customer Confirmation Counter
178 * @rep:compatibility S
179 */
180
181 PROCEDURE DECREASE_COUNTER (
182 p_api_version IN NUMBER,
183 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
184 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
185 x_return_status OUT NOCOPY VARCHAR2,
186 x_msg_count OUT NOCOPY NUMBER,
187 x_msg_data OUT NOCOPY VARCHAR2,
188 p_object_version_number IN OUT NOCOPY NUMBER,
189 p_task_id IN NUMBER
190 );
191
192 /*#
193 * Changes the sign of the customer confirmation.
194 *
195 * @param p_api_version the standard API version number
196 * @param p_init_msg_list the standard API flag allows API callers to request
197 * that the API does the initialization of the message list on their behalf.
198 * By default, the message list will not be initialized.
199 * @param p_commit the standard API flag is used by API callers to ask
200 * the API to commit on their behalf after performing its function
201 * By default, the commit will not be performed.
202 * @param x_return_status returns the result of all the operations performed
203 * by the API and must have one of the following values:
204 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
205 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
206 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
207 * @param x_msg_count returns the number of messages in the API message list
208 * @param x_msg_data returns the message in an encoded format if
209 * <code>x_msg_count</code> returns number one.
210 *
211 * @param p_object_version_number is the object version number of the
212 * task that is to be updated.
213 * @param p_task_id is the task id of the task to be updated in jtf_tasks_b
214 * table.
215 * @paraminfo {@rep:precision 6000}
216 *
217 * @rep:scope internal
218 * @rep:lifecycle active
219 * @rep:displayname Reset Customer Confirmation Counter
220 * @rep:compatibility S
221 */
222 PROCEDURE CHANGE_COUNTER_SIGN (
223 p_api_version IN NUMBER,
224 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
225 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
226 x_return_status OUT NOCOPY VARCHAR2,
227 x_msg_count OUT NOCOPY NUMBER,
228 x_msg_data OUT NOCOPY VARCHAR2,
229 p_object_version_number IN OUT NOCOPY NUMBER,
230 p_task_id IN NUMBER
231 );
232
233 /*#
234 * Resets the customer confirmation status to "N" and Counter to 0.
235 *
236 * @param p_api_version the standard API version number
237 * @param p_init_msg_list the standard API flag allows API callers to request
238 * that the API does the initialization of the message list on their behalf.
239 * By default, the message list will not be initialized.
240 * @param p_commit the standard API flag is used by API callers to ask
241 * the API to commit on their behalf after performing its function
242 * By default, the commit will not be performed.
243 * @param x_return_status returns the result of all the operations performed
244 * by the API and must have one of the following values:
245 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
246 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
247 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
248 * @param x_msg_count returns the number of messages in the API message list
249 * @param x_msg_data returns the message in an encoded format if
250 * <code>x_msg_count</code> returns number one.
251 *
252 * @param p_object_version_number is the object version number of the
253 * task that is to be updated.
254 * @param p_task_id is the task id of the task to be updated in jtf_tasks_b
255 * table.
256 * @paraminfo {@rep:precision 6000}
257 *
258 * @rep:scope internal
259 * @rep:lifecycle active
260 * @rep:displayname Reset Customer Confirmation Counter
261 * @rep:compatibility S
262 */
263 PROCEDURE RESET_CONFIRMATION_STATUS(
264 p_api_version IN NUMBER,
265 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
266 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
267 x_return_status OUT NOCOPY VARCHAR2,
268 x_msg_count OUT NOCOPY NUMBER,
269 x_msg_data OUT NOCOPY VARCHAR2,
270 p_object_version_number IN OUT NOCOPY NUMBER,
271 p_task_id IN NUMBER
272 );
273
274 /*#
275 * Resets the customer confirmation status to "R", Required.
276 *
277 * @param p_api_version the standard API version number
278 * @param p_init_msg_list the standard API flag allows API callers to request
279 * that the API does the initialization of the message list on their behalf.
280 * By default, the message list will not be initialized.
281 * @param p_commit the standard API flag is used by API callers to ask
282 * the API to commit on their behalf after performing its function
283 * By default, the commit will not be performed.
284 * @param x_return_status returns the result of all the operations performed
285 * by the API and must have one of the following values:
286 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
287 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
288 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
289 * @param x_msg_count returns the number of messages in the API message list
290 * @param x_msg_data returns the message in an encoded format if
291 * <code>x_msg_count</code> returns number one.
292 *
293 * @param p_object_version_number is the object version number of the
294 * task that is to be updated.
295 * @param p_task_id is the task id of the task to be updated in jtf_tasks_b
296 * table.
297 * @paraminfo {@rep:precision 6000}
298 *
299 * @rep:scope internal
300 * @rep:lifecycle active
301 * @rep:displayname Reset Customer Confirmation Counter
302 * @rep:compatibility S
303 */
304 PROCEDURE SET_CONFIRMATION_REQUIRED(
305 p_api_version IN NUMBER,
306 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
307 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
308 x_return_status OUT NOCOPY VARCHAR2,
309 x_msg_count OUT NOCOPY NUMBER,
310 x_msg_data OUT NOCOPY VARCHAR2,
311 p_object_version_number IN OUT NOCOPY NUMBER,
312 p_task_id IN NUMBER
313 );
314
315 /*#
316 * Resets the customer confirmation status to "C", Confirmed.
317 *
318 * @param p_api_version the standard API version number
319 * @param p_init_msg_list the standard API flag allows API callers to request
320 * that the API does the initialization of the message list on their behalf.
321 * By default, the message list will not be initialized.
322 * @param p_commit the standard API flag is used by API callers to ask
323 * the API to commit on their behalf after performing its function
324 * By default, the commit will not be performed.
325 * @param x_return_status returns the result of all the operations performed
326 * by the API and must have one of the following values:
327 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
328 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
329 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
330 * @param x_msg_count returns the number of messages in the API message list
331 * @param x_msg_data returns the message in an encoded format if
332 * <code>x_msg_count</code> returns number one.
333 *
334 * @param p_object_version_number is the object version number of the
335 * task that is to be updated.
336 * @param p_task_id is the task id of the task to be updated in jtf_tasks_b
337 * table.
338 * @paraminfo {@rep:precision 6000}
339 *
340 * @rep:scope internal
341 * @rep:lifecycle active
342 * @rep:displayname Reset Customer Confirmation Counter
343 * @rep:compatibility S
344 */
345 PROCEDURE SET_CONFIRMATION_CONFIRMED(
346 p_api_version IN NUMBER,
347 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
348 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
349 x_return_status OUT NOCOPY VARCHAR2,
350 x_msg_count OUT NOCOPY NUMBER,
351 x_msg_data OUT NOCOPY VARCHAR2,
352 p_object_version_number IN OUT NOCOPY NUMBER,
353 p_task_id IN NUMBER
354 );
355
356 END;