1 PACKAGE jtf_rs_wf_events_pub AUTHID CURRENT_USER AS
2 /* $Header: jtfrswps.pls 120.0 2005/05/11 08:23:28 appldev ship $ */
3 /*#
4 * Workflow Events API
5 * This API raises business events for create/update/delete resources, roles, role relations
6 * and merge of two resources.
7 * This API contains the procedures which can be called while create/update/delete of Resources,
8 * roles, role relations and merge of two resources.
9 * @rep:scope private
10 * @rep:product JTF
11 * @rep:displayname Workflow Events API
12 * @rep:category BUSINESS_ENTITY JTF_RS_WF_EVENT
13 * @rep:businessevent oracle.apps.jtf.jres.resource.create
14 * @rep:businessevent oracle.apps.jtf.jres.resource.update.user
15 * @rep:businessevent oracle.apps.jtf.jres.resource.update.effectivedate
16 * @rep:businessevent oracle.apps.jtf.jres.resource.update.attributes
17 * @rep:businessevent oracle.apps.jtf.jres.resource.delete
18 * @rep:businessevent oracle.apps.jtf.jres.role.create
19 * @rep:businessevent oracle.apps.jtf.jres.role.update
20 * @rep:businessevent oracle.apps.jtf.jres.role.delete
21 * @rep:businessevent oracle.apps.jtf.jres.rolerelate.create
22 * @rep:businessevent oracle.apps.jtf.jres.rolerelate.update
23 * @rep:businessevent oracle.apps.jtf.jres.rolerelate.delete
24 * @rep:businessevent oracle.apps.jtf.jres.resource.merge
25 */
26 /*****************************************************************************************
27 ******************************************************************************************/
28
29 /* This procedure raises the business event oracle.apps.jtf.jres.resource.create
30 This Resource Create Event will be raised for all the newly created
31 or Imported resources */
32
33 /*#
34 * API to raise the business event while creating a resource.
35 * Resource Create Event will be raised for all the newly created / Imported resources.
36 * @param p_api_version API version
37 * @param p_init_msg_list Initialization of the message list
38 * @param p_commit Commit
39 * @param p_resource_id Resource Identifier
40 * @param p_resource_name Name of the Resource
41 * @param p_category Category of the Resource
42 * @param p_user_id User Id of the Resource
43 * @param p_start_date_active Date on which the resource becomes active.
44 * @param p_end_date_active Date on which the resource is no longer active.
45 * @param x_return_status Output parameter for return status
46 * @param x_msg_count Output parameter for number of user messages from this procedure
47 * @param x_msg_data Output parameter containing last user message from this procedure
48 * @rep:scope private
49 * @rep:displayname Resource Create Event API
50 * @rep:businessevent oracle.apps.jtf.jres.resource.create
51 */
52 PROCEDURE create_resource
53 (P_API_VERSION IN NUMBER,
54 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT NULL,
55 P_COMMIT IN VARCHAR2 DEFAULT NULL,
56 P_RESOURCE_ID IN NUMBER,
57 P_RESOURCE_NAME IN VARCHAR2,
58 P_CATEGORY IN VARCHAR2,
59 P_USER_ID IN NUMBER,
60 P_START_DATE_ACTIVE IN DATE,
61 P_END_DATE_ACTIVE IN DATE,
62 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
63 X_MSG_COUNT OUT NOCOPY NUMBER,
64 X_MSG_DATA OUT NOCOPY VARCHAR2
65 );
66
67
68 /* This procedure raises the business event oracle.apps.jtf.jres.resource.merge
69 This Resource merge Event will be raised when two resources are merged.
70 currently this API is called from party merge.*/
71 /*#
72 * API to raise the business event while merge of two resources.
73 * @param p_api_version API version
74 * @param p_init_msg_list Initialization of the message list
75 * @param p_commit Commit
76 * @param p_resource_id From Resource Identifier
77 * @param p_end_date_active Date on which the from resource is no longer active.
78 * @param p_repl_resource_id Replacement Resource Identifier
79 * @param x_return_status Output parameter for return status
80 * @param x_msg_count Output parameter for number of user messages from this procedure
81 * @param x_msg_data Output parameter containing last user message from this procedure
82 * @rep:scope private
83 * @rep:displayname Resource Merge Event API
84 * @rep:businessevent oracle.apps.jtf.jres.resource.merge
85 */
86 PROCEDURE merge_resource
87 (P_API_VERSION IN NUMBER,
88 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT NULL,
89 P_COMMIT IN VARCHAR2 DEFAULT NULL,
90 P_RESOURCE_ID IN NUMBER,
91 P_END_DATE_ACTIVE IN DATE,
92 P_REPL_RESOURCE_ID IN NUMBER,
93 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
94 X_MSG_COUNT OUT NOCOPY NUMBER,
95 X_MSG_DATA OUT NOCOPY VARCHAR2
96 );
97
98 /* This procedure raises the following business events
99 User_id change - oracle.apps.jtf.jres.resource.update.user
100 Date effective change - oracle.apps.jtf.jres.resource.update.effectivedate
101 Other attributes change - oracle.apps.jtf.jres.resource.update.attributes
102 */
103
104 /*#
105 * API to raise the business events while updating a resource.
106 * Resource Update User Event will be raised for all the resources that have a change in user_id.
107 * Resource Update dateEffectivity Event will be raised for all the resources that have a change in start date active or end date active.
108 * Resource Update Attribute Event will be raised for all the resources that have a change all other attributes.
109 * @param p_api_version API version
110 * @param p_init_msg_list Initialization of the message list
111 * @param p_commit Commit
112 * @param p_resource_rec Information about the changed resource record
113 * @param x_return_status Output parameter for return status
114 * @param x_msg_count Output parameter for number of user messages from this procedure
115 * @param x_msg_data Output parameter containing last user message from this procedure
116 * @rep:scope private
117 * @rep:displayname Resource Update Event API
118 * @rep:businessevent oracle.apps.jtf.jres.resource.update.user
119 * @rep:businessevent oracle.apps.jtf.jres.resource.update.effectivedate
120 * @rep:businessevent oracle.apps.jtf.jres.resource.update.attributes
121 */
122 PROCEDURE update_resource
123 (P_API_VERSION IN NUMBER,
124 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT NULL,
125 P_COMMIT IN VARCHAR2 DEFAULT NULL,
126 P_RESOURCE_REC IN jtf_rs_resource_pvt.RESOURCE_REC_TYPE,
127 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
128 X_MSG_COUNT OUT NOCOPY NUMBER,
129 X_MSG_DATA OUT NOCOPY VARCHAR2
130 );
131
132
133 /* This procedure raises the business event oracle.apps.jtf.jres.resource.delete
134 This Resource Delete Event will be raised for all the deleted TBH resources */
135 /*#
136 * API to raise the business events while deleting a resource.
137 * Resource Delete Event will be raised for all deleted resources.
138 * @param p_api_version API version
139 * @param p_init_msg_list Initialization of the message list
140 * @param p_commit Commit
141 * @param p_resource_id Resource Identifier
142 * @param x_return_status Output parameter for return status
143 * @param x_msg_count Output parameter for number of user messages from this procedure
144 * @param x_msg_data Output parameter containing last user message from this procedure
145 * @rep:scope private
146 * @rep:displayname Resource Delete Event API
147 * @rep:businessevent oracle.apps.jtf.jres.resource.delete
148 */
149 PROCEDURE delete_resource
150 (P_API_VERSION IN NUMBER,
151 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT NULL,
152 P_COMMIT IN VARCHAR2 DEFAULT NULL,
153 P_RESOURCE_ID IN NUMBER,
154 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
155 X_MSG_COUNT OUT NOCOPY NUMBER,
156 X_MSG_DATA OUT NOCOPY VARCHAR2
157 );
158
159 /* This procedure raises the business event oracle.apps.jtf.jres.role.create
160 This Resource Role Create Event will be raised for all the newly created resource roles */
161 /*#
162 * API to raise the business event while creating a resource role.
163 * Role Create Event will be raised for all the newly created roles
164 * @param p_api_version API version
165 * @param p_init_msg_list Initialization of the message list
166 * @param p_commit Commit
167 * @param p_role_id Role Identifier
168 * @param p_role_type_code Role Type Code
169 * @param p_role_code Role Code
170 * @param p_role_name Role name
171 * @param p_role_desc Role Description
172 * @param p_active_flag Flag indicating this role is an active role or not
173 * @param p_member_flag Flag indicating if this role is a member role or not
174 * @param p_admin_flag Flag indicating if this role is an admin role or not
175 * @param p_lead_flag Flag indicating if this role is a leader role or not
176 * @param p_manager_flag Flag indicating if this role is a manager role or not
177 * @param x_return_status Output parameter for return status
178 * @param x_msg_count Output parameter for number of user messages from this procedure
179 * @param x_msg_data Output parameter containing last user message from this procedure
180 * @rep:scope private
181 * @rep:displayname Resource Role Create Event API
182 * @rep:businessevent oracle.apps.jtf.jres.role.create
183 */
184 PROCEDURE create_resource_role
185 (P_API_VERSION IN NUMBER,
186 P_INIT_MSG_LIST IN VARCHAR2,
187 P_COMMIT IN VARCHAR2,
188 P_ROLE_ID IN NUMBER,
189 P_ROLE_TYPE_CODE IN VARCHAR2,
190 P_ROLE_CODE IN VARCHAR2,
191 P_ROLE_NAME IN VARCHAR2,
192 P_ROLE_DESC IN VARCHAR2,
193 P_ACTIVE_FLAG IN VARCHAR2,
194 P_MEMBER_FLAG IN VARCHAR2,
195 P_ADMIN_FLAG IN VARCHAR2,
196 P_LEAD_FLAG IN VARCHAR2,
197 P_MANAGER_FLAG IN VARCHAR2,
198 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
199 X_MSG_COUNT OUT NOCOPY NUMBER,
200 X_MSG_DATA OUT NOCOPY VARCHAR2
201 );
202
203 /* This procedure raises the business event oracle.apps.jtf.jres.role.update
204 This Resource Role Update Event will be raised for all upadted resource roles */
205
206 /*#
207 * API to raise the business events while updating a resource Role.
208 * Role Update Event will be raised for all the roles that have a changed.
209 * @param p_api_version API version
210 * @param p_init_msg_list Initialization of the message list
211 * @param p_commit Commit
212 * @param p_resource_role_rec Information about the changed role record
213 * @param x_return_status Output parameter for return status
214 * @param x_msg_count Output parameter for number of user messages from this procedure
215 * @param x_msg_data Output parameter containing last user message from this procedure
216 * @rep:scope private
217 * @rep:displayname Resource Role Update Event API
218 * @rep:businessevent oracle.apps.jtf.jres.role.update
219 */
220 PROCEDURE update_resource_role
221 (P_API_VERSION IN NUMBER,
222 P_INIT_MSG_LIST IN VARCHAR2,
223 P_COMMIT IN VARCHAR2,
224 P_RESOURCE_ROLE_REC IN jtf_rs_roles_pvt.RESOURCE_ROLE_REC_TYPE,
225 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
226 X_MSG_COUNT OUT NOCOPY NUMBER,
227 X_MSG_DATA OUT NOCOPY VARCHAR2
228 );
229
230 /* This procedure raises the business event oracle.apps.jtf.jres.role.delete
231 This Resource Role Delete Event will be raised for all deleted resource roles */
232
233 /*#
234 * API to raise the business events while deleting a resource Role.
235 * Role Delete Event will be raised for all deleted roles.
236 * @param p_api_version API version
237 * @param p_init_msg_list Initialization of the message list
238 * @param p_commit Commit
239 * @param p_role_id Role Identifier
240 * @param x_return_status Output parameter for return status
241 * @param x_msg_count Output parameter for number of user messages from this procedure
242 * @param x_msg_data Output parameter containing last user message from this procedure
243 * @rep:scope private
244 * @rep:displayname Resource Role Delete Event API
245 * @rep:businessevent oracle.apps.jtf.jres.role.delete
246 */
247 PROCEDURE delete_resource_role
248 (P_API_VERSION IN NUMBER,
249 P_INIT_MSG_LIST IN VARCHAR2,
250 P_COMMIT IN VARCHAR2,
251 P_ROLE_ID IN NUMBER,
252 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
253 X_MSG_COUNT OUT NOCOPY NUMBER,
254 X_MSG_DATA OUT NOCOPY VARCHAR2
255 );
256
257 /* This procedure raises the business event oracle.apps.jtf.jres.rolerelate.create
258 This Resource Role Relation Create Event will be raised for all the newly created role relations */
259
260 /*#
261 * API to raise the business event while creating a role relation.
262 * Role Relation Create Event will be raised whenever a role is assigned to a resource, group member or team member.
263 * @param p_api_version API version
264 * @param p_init_msg_list Initialization of the message list
265 * @param p_commit Commit
266 * @param p_role_id Role Identifier
267 * @param p_role_relate_id Role Relation Identifier
268 * @param p_role_resource_id Role Resource Identifier. This can be Resource, group, team, group member or team member Identifier.
269 * @param p_role_resource_type Type of the Resource. This can be Resource, group, team, group member or team member.
270 * @param p_start_date_active Date on which the role relation becomes active.
271 * @param p_end_date_active Date on which the role relation is no longer active.
272 * @param x_return_status Output parameter for return status
273 * @param x_msg_count Output parameter for number of user messages from this procedure
274 * @param x_msg_data Output parameter containing last user message from this procedure
275 * @rep:scope private
276 * @rep:displayname Role Relation Create Event API
277 * @rep:businessevent oracle.apps.jtf.jres.rolerelate.create
278 */
279 PROCEDURE create_resource_role_relate
280 (P_API_VERSION IN NUMBER,
281 P_INIT_MSG_LIST IN VARCHAR2,
282 P_COMMIT IN VARCHAR2,
283 P_ROLE_RELATE_ID IN NUMBER,
284 P_ROLE_RESOURCE_TYPE IN VARCHAR2,
285 P_ROLE_RESOURCE_ID IN NUMBER,
286 P_ROLE_ID IN NUMBER,
287 P_START_DATE_ACTIVE IN DATE,
288 P_END_DATE_ACTIVE IN DATE,
289 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
290 X_MSG_COUNT OUT NOCOPY NUMBER,
291 X_MSG_DATA OUT NOCOPY VARCHAR2
292 );
293
294 /* This procedure raises the business event oracle.apps.jtf.jres.rolerelate.update
295 This Resource Role Relation Update Event will be raised for all upadted role relations */
296 /*#
297 * API to raise the business event while updating a role relation.
298 * Role Relation Update Event will be raised whenever a an existing role relation is updated.
299 * @param p_api_version API version
300 * @param p_init_msg_list Initialization of the message list
301 * @param p_commit Commit
302 * @param p_role_id Role Identifier
303 * @param p_role_relate_id Role Relation Identifier
304 * @param p_role_resource_id Role Resource Identifier. This can be Resource, group, team, group member or team member Identifier.
305 * @param p_role_resource_type Type of the Resource. This can be Resource, group, team, group member or team member.
306 * @param p_start_date_active Date on which the role relation becomes active.
307 * @param p_end_date_active Date on which the role relation is no longer active.
308 * @param x_return_status Output parameter for return status
309 * @param x_msg_count Output parameter for number of user messages from this procedure
310 * @param x_msg_data Output parameter containing last user message from this procedure
311 * @rep:scope private
312 * @rep:displayname Role Relation Update Event API
313 * @rep:businessevent oracle.apps.jtf.jres.rolerelate.update
314 */
315 PROCEDURE update_resource_role_relate
316 (P_API_VERSION IN NUMBER,
317 P_INIT_MSG_LIST IN VARCHAR2,
318 P_COMMIT IN VARCHAR2,
319 P_ROLE_RELATE_ID IN NUMBER,
320 P_ROLE_RESOURCE_TYPE IN VARCHAR2,
321 P_ROLE_RESOURCE_ID IN NUMBER,
322 P_ROLE_ID IN NUMBER,
323 P_START_DATE_ACTIVE IN DATE,
324 P_END_DATE_ACTIVE IN DATE,
325 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
326 X_MSG_COUNT OUT NOCOPY NUMBER,
327 X_MSG_DATA OUT NOCOPY VARCHAR2
328 );
329
330 /* This procedure raises the business event oracle.apps.jtf.jres.rolerelate.delete
331 This Resource Role Relations Delete Event will be raised for all deleted role realtions */
332 /*#
333 * API to raise the business event while deleting a role relation.
334 * Role Relation Delete Event will be raised whenever a an existing role relation is deleted.
335 * @param p_api_version API version
336 * @param p_init_msg_list Initialization of the message list
337 * @param p_commit Commit
338 * @param p_role_relate_id Role Relation Identifier
339 * @param x_return_status Output parameter for return status
340 * @param x_msg_count Output parameter for number of user messages from this procedure
341 * @param x_msg_data Output parameter containing last user message from this procedure
342 * @rep:scope private
343 * @rep:displayname Role Relation Delete Event API
344 * @rep:businessevent oracle.apps.jtf.jres.rolerelate.delete
345 */
346 PROCEDURE delete_resource_role_relate
347 (P_API_VERSION IN NUMBER,
348 P_INIT_MSG_LIST IN VARCHAR2,
349 P_COMMIT IN VARCHAR2,
350 P_ROLE_RELATE_ID IN NUMBER,
351 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
352 X_MSG_COUNT OUT NOCOPY NUMBER,
353 X_MSG_DATA OUT NOCOPY VARCHAR2
354 );
355
356
357 END jtf_rs_wf_events_pub;
[Home] [Help]