1 PACKAGE jtf_task_references_pub AUTHID CURRENT_USER AS
2 /* $Header: jtfptkns.pls 120.7 2006/07/27 11:23:08 sbarat ship $ */
3 /*#
4 * A public interface for Tasks that can be used to create, update, and delete task references to an object.
5 *
6 * @rep:scope public
7 * @rep:product CAC
8 * @rep:lifecycle active
9 * @rep:displayname Task Reference Management
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY CAC_CAL_TASK
12 */
13
14 type references_rec is RECORD
15 (
16 TASK_REFERENCE_ID NUMBER,
17 TASK_ID NUMBER,
18 OBJECT_TYPE_CODE VARCHAR2(30) ,
19 OBJECT_NAME VARCHAR2(80) ,
20 OBJECT_ID NUMBER,
21 OBJECT_DETAILS VARCHAR2(2000) ,
22 REFERENCE_CODE VARCHAR2(30) ,
23 ATTRIBUTE1 VARCHAR2(150) ,
24 ATTRIBUTE2 VARCHAR2(150) ,
25 ATTRIBUTE3 VARCHAR2(150) ,
26 ATTRIBUTE4 VARCHAR2(150) ,
27 ATTRIBUTE5 VARCHAR2(150) ,
28 ATTRIBUTE6 VARCHAR2(150) ,
29 ATTRIBUTE7 VARCHAR2(150) ,
30 ATTRIBUTE8 VARCHAR2(150) ,
31 ATTRIBUTE9 VARCHAR2(150) ,
32 ATTRIBUTE10 VARCHAR2(150) ,
33 ATTRIBUTE11 VARCHAR2(150) ,
34 ATTRIBUTE12 VARCHAR2(150) ,
35 ATTRIBUTE13 VARCHAR2(150) ,
36 ATTRIBUTE14 VARCHAR2(150) ,
37 ATTRIBUTE15 VARCHAR2(150) ,
38 ATTRIBUTE_CATEGORY VARCHAR2(30) ,
39 USAGE VARCHAR2(2000) ,
40 OBJECT_VERSION_NUMBER NUMBER
41 );
42
43 p_task_references_rec references_rec ;
44
45 /*#
46 * Creates an object reference for a Task.
47 *
48 * @param p_api_version Standard API version number. See "Standard IN Parameters", Oracle Common Application Calendar API Reference Guide.
49 * @rep:paraminfo {@rep:required}
50 * @param p_init_msg_list Standard API flag allows API callers to request that the API does the initialization of the message list on their behalf. By default, the message list will not be initialized.
51 * See "Standard IN Parameters", Oracle Common Application Calendar API Reference Guide.
52 * @param p_commit Standard API flag is used by API callers to ask the API to commit on their behalf after performing its function. By default, the commit will not be performed.
53 * See "Standard IN Parameters", Oracle Common Application Calendar API Reference Guide.
54 * @param p_task_id Unique Identifier for the task to be used for reference creation. Either <code>p_task_id</code> or <code>p_task_number</code> must be passed.
55 * @rep:paraminfo {@rep:required}
56 * @param p_task_number Unique task number to be used for reference creation. Either <code>p_task_id</code> or <code>p_task_number</code> must be passed.
57 * @rep:paraminfo {@rep:required}
58 * @param p_object_type_code Object type code for reference creation.
59 * @rep:paraminfo {@rep:required}
60 * @param p_object_name Object name for reference creation.
61 * @rep:paraminfo {@rep:required}
62 * @param p_object_id Object identifier for reference creation.
63 * @rep:paraminfo {@rep:required}
64 * @param p_object_details Object details for reference creation.
65 * @param p_reference_code Reference code for reference creation.
66 * @param p_usage Usage for reference creation.
67 * @param x_return_status Result of all the operations performed by the API. This will have one of the following values:
68 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code> - If the API processed the data successfully.
69 * <LI><Code>FND_API.G_RET_STS_ERROR</Code> - If there was an expected error in API processing.
70 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code> If there was an unexpected error in API processing.
71 * @param x_msg_count Number of messages returned in the API message list.
72 * @param x_msg_data Returned message data in an encoded format if <code>x_msg_count</code> returns non-zero value.
73 * @param x_task_reference_id Unique reference identifier being created.
74 * @param p_attribute1 Attribute1 of customer flex fields.
75 * @param p_attribute2 Attribute2 of customer flex fields.
76 * @param p_attribute3 Attribute3 of customer flex fields.
77 * @param p_attribute4 Attribute4 of customer flex fields.
78 * @param p_attribute5 Attribute5 of customer flex fields.
79 * @param p_attribute6 Attribute6 of customer flex fields.
80 * @param p_attribute7 Attribute7 of customer flex fields.
81 * @param p_attribute8 Attribute8 of customer flex fields.
82 * @param p_attribute9 Attribute9 of customer flex fields.
83 * @param p_attribute10 Attribute10 of customer flex fields.
84 * @param p_attribute11 Attribute11 of customer flex fields.
85 * @param p_attribute12 Attribute12 of customer flex fields.
86 * @param p_attribute13 Attribute13 of customer flex fields.
87 * @param p_attribute14 Attribute14 of customer flex fields.
88 * @param p_attribute15 Attribute15 of customer flex fields.
89 * @param p_attribute_category Attribute category for the customer flex fields.
90 *
91 * @rep:scope public
92 * @rep:lifecycle active
93 * @rep:displayname Create Task Reference
94 * @rep:compatibility S
95 */
96 PROCEDURE create_references (
97 p_api_version IN NUMBER,
98 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
99 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
100 p_task_id IN NUMBER DEFAULT NULL,
101 p_task_number IN VARCHAR2 DEFAULT NULL,
102 p_object_type_code IN VARCHAR2 DEFAULT NULL,
103 p_object_name IN VARCHAR2 ,
104 p_object_id IN NUMBER,
105 p_object_details IN VARCHAR2 DEFAULT NULL,
106 p_reference_code IN VARCHAR2 DEFAULT NULL,
107 p_usage IN VARCHAR2 DEFAULT NULL,
108 x_return_status OUT NOCOPY VARCHAR2,
109 x_msg_data OUT NOCOPY VARCHAR2,
110 x_msg_count OUT NOCOPY NUMBER,
111 x_task_reference_id OUT NOCOPY NUMBER,
112 p_attribute1 IN VARCHAR2 DEFAULT null ,
113 p_attribute2 IN VARCHAR2 DEFAULT null ,
114 p_attribute3 IN VARCHAR2 DEFAULT null ,
115 p_attribute4 IN VARCHAR2 DEFAULT null ,
116 p_attribute5 IN VARCHAR2 DEFAULT null ,
117 p_attribute6 IN VARCHAR2 DEFAULT null ,
118 p_attribute7 IN VARCHAR2 DEFAULT null ,
119 p_attribute8 IN VARCHAR2 DEFAULT null ,
120 p_attribute9 IN VARCHAR2 DEFAULT null ,
121 p_attribute10 IN VARCHAR2 DEFAULT null ,
122 p_attribute11 IN VARCHAR2 DEFAULT null ,
123 p_attribute12 IN VARCHAR2 DEFAULT null ,
124 p_attribute13 IN VARCHAR2 DEFAULT null ,
125 p_attribute14 IN VARCHAR2 DEFAULT null ,
126 p_attribute15 IN VARCHAR2 DEFAULT null ,
127 p_attribute_category IN VARCHAR2 DEFAULT null
128 );
129
130 -- Removed '#' to de-annotate this procedure. irep parser
131 -- will not pick up this annotation. Bug# 5406214
132
133 /*
134 * Locks an existing object reference for a Task.
135 *
136 * @param p_api_version Standard API version number.
137 * @rep:paraminfo {@rep:required}
141 * @rep:paraminfo {@rep:required}
138 * @param p_init_msg_list Standard API flag allows API callers to request that the API does the initialization of the message list on their behalf. By default, the message list will not be initialized.
139 * @param p_commit Standard API flag is used by API callers to ask the API to commit on their behalf after performing its function. By default, the commit will not be performed.
140 * @param p_object_version_number Object version number of the current reference record.
142 * @param p_task_reference_id Unique reference identifier of the reference to be locked.
143 * @rep:paraminfo {@rep:required}
144 * @param x_return_status Result of all the operations performed by the API. This will have one of the following values:
145 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code> - If the API processed the data successfully.
146 * <LI><Code>FND_API.G_RET_STS_ERROR</Code> - If there was an expected error in API processing.
147 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code> If there was an unexpected error in API processing.
148 * @param x_msg_count Number of messages returned in the API message list.
149 * @param x_msg_data Returned message data in an encoded format if <code>x_msg_count</code> returns non-zero value.
150 *
151 * @rep:scope public
152 * @rep:lifecycle active
153 * @rep:displayname Lock Task Reference
154 * @rep:compatibility S
155 */
156 PROCEDURE lock_references (
157 p_api_version IN NUMBER,
158 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
159 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
160 p_task_reference_id IN NUMBER,
161 p_object_version_number IN NUMBER,
162 x_return_status OUT NOCOPY VARCHAR2,
163 x_msg_data OUT NOCOPY VARCHAR2,
164 x_msg_count OUT NOCOPY NUMBER
165 ) ;
166
167 /*#
168 * Updates an existing object reference for a Task.
169 *
170 * @param p_api_version Standard API version number. See "Standard IN Parameters", Oracle Common Application Calendar API Reference Guide.
171 * @rep:paraminfo {@rep:required}
172 * @param p_init_msg_list Standard API flag allows API callers to request that the API does the initialization of the message list on their behalf. By default, the message list will not be initialized.
173 * See "Standard IN Parameters", Oracle Common Application Calendar API Reference Guide.
174 * @param p_commit Standard API flag is used by API callers to ask the API to commit on their behalf after performing its function. By default, the commit will not be performed.
175 * See "Standard IN Parameters", Oracle Common Application Calendar API Reference Guide.
176 * @param p_object_version_number Object version number of the current reference record.
177 * @rep:paraminfo {@rep:required}
178 * @param p_task_reference_id Unique reference identifier of the reference to be updated.
179 * @rep:paraminfo {@rep:required}
180 * @param p_object_type_code Object type code for reference update.
181 * @param p_object_name Object name for reference update.
182 * @param p_object_id Object identifier for reference update.
183 * @param p_object_details Object details for reference update.
184 * @param p_reference_code Reference code for reference update.
185 * @param p_usage Usage for reference update.
186 * @param x_return_status Result of all the operations performed by the API. This will have one of the following values:
187 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code> - If the API processed the data successfully.
188 * <LI><Code>FND_API.G_RET_STS_ERROR</Code> - If there was an expected error in API processing.
189 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code> If there was an unexpected error in API processing.
190 * @param x_msg_count Number of messages returned in the API message list.
191 * @param x_msg_data Returned message data in an encoded format if <code>x_msg_count</code> returns non-zero value.
192 * @param p_attribute1 Attribute1 of customer flex fields.
193 * @param p_attribute2 Attribute2 of customer flex fields.
194 * @param p_attribute3 Attribute3 of customer flex fields.
195 * @param p_attribute4 Attribute4 of customer flex fields.
196 * @param p_attribute5 Attribute5 of customer flex fields.
197 * @param p_attribute6 Attribute6 of customer flex fields.
198 * @param p_attribute7 Attribute7 of customer flex fields.
199 * @param p_attribute8 Attribute8 of customer flex fields.
200 * @param p_attribute9 Attribute9 of customer flex fields.
201 * @param p_attribute10 Attribute10 of customer flex fields.
202 * @param p_attribute11 Attribute11 of customer flex fields.
203 * @param p_attribute12 Attribute12 of customer flex fields.
204 * @param p_attribute13 Attribute13 of customer flex fields.
205 * @param p_attribute14 Attribute14 of customer flex fields.
206 * @param p_attribute15 Attribute15 of customer flex fields.
207 * @param p_attribute_category Attribute category for the customer flex fields.
208 *
209 * @rep:scope public
210 * @rep:lifecycle active
211 * @rep:displayname Update Task Reference
212 * @rep:compatibility S
213 */
214 PROCEDURE update_references (
215 p_api_version IN NUMBER,
216 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
217 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
218 p_object_version_number IN OUT NOCOPY NUMBER ,
219 p_task_reference_id IN NUMBER,
220 p_object_type_code IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
221 p_object_name IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
222 p_object_id IN NUMBER DEFAULT fnd_api.g_miss_num,
223 p_object_details IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
224 p_reference_code IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
225 p_usage IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
226 x_return_status OUT NOCOPY VARCHAR2,
227 x_msg_data OUT NOCOPY VARCHAR2,
228 x_msg_count OUT NOCOPY NUMBER,
229 p_attribute1 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
230 p_attribute2 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
231 p_attribute3 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
232 p_attribute4 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
233 p_attribute5 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
234 p_attribute6 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
235 p_attribute7 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
236 p_attribute8 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
237 p_attribute9 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
238 p_attribute10 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
239 p_attribute11 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
240 p_attribute12 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
241 p_attribute13 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
242 p_attribute14 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
243 p_attribute15 IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
244 p_attribute_category IN VARCHAR2 DEFAULT jtf_task_utl.g_miss_char
245 );
246
247 /*#
248 * Deletes an existing object reference for a Task.
249 *
250 * @param p_api_version Standard API version number. See "Standard IN Parameters", Oracle Common Application Calendar API Reference Guide.
251 * @rep:paraminfo {@rep:required}
252 * @param p_init_msg_list Standard API flag allows API callers to request that the API does the initialization of the message list on their behalf. By default, the message list will not be initialized.
253 * See "Standard IN Parameters", Oracle Common Application Calendar API Reference Guide.
254 * @param p_commit Standard API flag is used by API callers to ask the API to commit on their behalf after performing its function. By default, the commit will not be performed.
255 * See "Standard IN Parameters", Oracle Common Application Calendar API Reference Guide.
256 * @param p_object_version_number Object version number of the current reference record.
257 * @rep:paraminfo {@rep:required}
258 * @param p_task_reference_id Unique reference identifier of the reference to be deleted.
259 * @rep:paraminfo {@rep:required}
260 * @param x_return_status Result of all the operations performed by the API. This will have one of the following values:
261 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code> - If the API processed the data successfully.
262 * <LI><Code>FND_API.G_RET_STS_ERROR</Code> - If there was an expected error in API processing.
263 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code> If there was an unexpected error in API processing.
264 * @param x_msg_count Number of messages returned in the API message list.
265 * @param x_msg_data Returned message data in an encoded format if <code>x_msg_count</code> returns non-zero value.
266 *
267 * @rep:scope public
268 * @rep:lifecycle active
269 * @rep:displayname Delete Task Reference
270 * @rep:compatibility S
271 */
272 PROCEDURE delete_references (
273 p_api_version IN NUMBER,
274 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
275 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
276 p_object_version_number IN NUMBER ,
277 p_task_reference_id IN NUMBER,
278 x_return_status OUT NOCOPY VARCHAR2,
279 x_msg_data OUT NOCOPY VARCHAR2,
280 x_msg_count OUT NOCOPY NUMBER
281 );
282 END;
[Home] [Help]