[Home] [Help]
PACKAGE: APPS.HZ_CUST_ACCOUNT_ROLE_V2PUB
Source
1 PACKAGE HZ_CUST_ACCOUNT_ROLE_V2PUB AUTHID CURRENT_USER AS
2 /*$Header: ARH2CRSS.pls 120.9 2006/08/17 10:17:41 idali ship $ */
3 /*#
4 * This package contains the public APIs for customer account roles and role
5 * responsibilities.
6 * @rep:scope public
7 * @rep:product HZ
8 * @rep:displayname Customer Account Role
9 * @rep:category BUSINESS_ENTITY HZ_ACCOUNT_CONTACT
10 * @rep:lifecycle active
11 * @rep:doccd 120hztig.pdf Customer Account Role APIs, Oracle Trading Community Architecture Technical Implementation Guide
12 */
13
14 --------------------------------------
15 -- declaration of record type
16 --------------------------------------
17
18 TYPE cust_account_role_rec_type IS RECORD (
19 cust_account_role_id NUMBER,
20 party_id NUMBER,
21 cust_account_id NUMBER,
22 cust_acct_site_id NUMBER,
23 primary_flag VARCHAR2(1),
24 role_type VARCHAR2(30),
25 source_code VARCHAR2(150),
26 attribute_category VARCHAR2(30),
27 attribute1 VARCHAR2(150),
28 attribute2 VARCHAR2(150),
29 attribute3 VARCHAR2(150),
30 attribute4 VARCHAR2(150),
31 attribute5 VARCHAR2(150),
32 attribute6 VARCHAR2(150),
33 attribute7 VARCHAR2(150),
34 attribute8 VARCHAR2(150),
35 attribute9 VARCHAR2(150),
36 attribute10 VARCHAR2(150),
37 attribute11 VARCHAR2(150),
38 attribute12 VARCHAR2(150),
39 attribute13 VARCHAR2(150),
40 attribute14 VARCHAR2(150),
41 attribute15 VARCHAR2(150),
42 attribute16 VARCHAR2(150),
43 attribute17 VARCHAR2(150),
44 attribute18 VARCHAR2(150),
45 attribute19 VARCHAR2(150),
46 attribute20 VARCHAR2(150),
47 attribute21 VARCHAR2(150),
48 attribute22 VARCHAR2(150),
49 attribute23 VARCHAR2(150),
50 attribute24 VARCHAR2(150),
51 orig_system_reference VARCHAR2(240),
52 orig_system VARCHAR2(30),
53 attribute25 VARCHAR2(150),
54 status VARCHAR2(1),
55 created_by_module VARCHAR2(150),
56 application_id NUMBER
57 );
58
59 TYPE role_responsibility_rec_type IS RECORD (
60 responsibility_id NUMBER,
61 cust_account_role_id NUMBER,
62 responsibility_type VARCHAR2(30),
63 primary_flag VARCHAR2(1),
64 attribute_category VARCHAR2(30),
65 attribute1 VARCHAR2(150),
66 attribute2 VARCHAR2(150),
67 attribute3 VARCHAR2(150),
68 attribute4 VARCHAR2(150),
69 attribute5 VARCHAR2(150),
70 attribute6 VARCHAR2(150),
71 attribute7 VARCHAR2(150),
72 attribute8 VARCHAR2(150),
73 attribute9 VARCHAR2(150),
74 attribute10 VARCHAR2(150),
75 attribute11 VARCHAR2(150),
76 attribute12 VARCHAR2(150),
77 attribute13 VARCHAR2(150),
78 attribute14 VARCHAR2(150),
79 attribute15 VARCHAR2(150),
80 orig_system_reference VARCHAR2(240),
81 created_by_module VARCHAR2(150),
82 application_id NUMBER
83 );
84
85 --------------------------------------
86 -- declaration of public procedures and functions
87 --------------------------------------
88
89 /**
90 * PROCEDURE create_cust_account_role
91 *
92 * DESCRIPTION
93 * Creates customer account role.
94 *
95 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
96 *
97 * ARGUMENTS
98 * IN:
99 * p_init_msg_list Initialize message stack if it is set to
100 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
101 * p_cust_account_role_rec Customer account role record.
102 * IN/OUT:
103 * OUT:
104 * x_cust_account_role_id Customer account role ID.
105 * x_return_status Return status after the call. The status can
106 * be FND_API.G_RET_STS_SUCCESS (success),
107 * FND_API.G_RET_STS_ERROR (error),
108 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
109 * x_msg_count Number of messages in message stack.
110 * x_msg_data Message text if x_msg_count is 1.
111 *
112 * NOTES
113 *
114 * MODIFICATION HISTORY
115 *
116 * 07-23-2001 Jianying Huang o Created.
117 *
118 */
119
120 /*#
121 * Use this routine to create an account role. The API creates records in
122 * the HZ_CUST_ACCOUNT_ROLES table. You must create a customer account and an organization contact
123 * for the party that owns the customer account before you can create a customer account
124 * role. If an orig_system_reference is passed in, then the API creates a record in the
125 * HZ_ORIG_SYS_REFERENCES table to store the mapping between the source system reference
126 * and the TCA primary key. If orig_system_reference is not passed in, then the default is
127 * UNKNOWN.
128 * @rep:scope public
129 * @rep:lifecycle active
130 * @rep:displayname Create Customer Account Role
131 * @rep:businessevent oracle.apps.ar.hz.CustAccountRole.create
132 * @rep:doccd 120hztig.pdf Customer Account Role APIs, Oracle Trading Community Architecture Technical Implementation Guide
133 */
134 PROCEDURE create_cust_account_role (
135 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
136 p_cust_account_role_rec IN CUST_ACCOUNT_ROLE_REC_TYPE,
137 x_cust_account_role_id OUT NOCOPY NUMBER,
138 x_return_status OUT NOCOPY VARCHAR2,
139 x_msg_count OUT NOCOPY NUMBER,
140 x_msg_data OUT NOCOPY VARCHAR2
141 );
142
143 /**
144 * PROCEDURE update_cust_account_role
145 *
146 * DESCRIPTION
147 * Updates customer account role.
148 *
149 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
150 *
151 * ARGUMENTS
152 * IN:
153 * p_init_msg_list Initialize message stack if it is set to
154 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
155 * p_cust_account_role_rec Customer account role record.
156 * IN/OUT:
157 * p_object_version_number Used for locking the being updated record.
158 * OUT:
159 * x_return_status Return status after the call. The status can
160 * be FND_API.G_RET_STS_SUCCESS (success),
161 * FND_API.G_RET_STS_ERROR (error),
162 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
163 * x_msg_count Number of messages in message stack.
164 * x_msg_data Message text if x_msg_count is 1.
165 *
166 * NOTES
167 *
168 * MODIFICATION HISTORY
169 *
170 * 07-23-2001 Jianying Huang o Created.
171 *
172 */
173
174 /*#
175 * Use this routine to update an account role. This API updates records in
176 * the HZ_CUST_ACCOUNT_ROLES table. If the primary key is not passed in, then get the
177 * primary key from the HZ_ORIG_SYS_REFERENCES table using orig_system and
178 * orig_system_reference. Note: orig_system and orig_system_reference must be unique and
179 * not null and unique.
180 * @rep:scope public
181 * @rep:lifecycle active
182 * @rep:displayname Update Customer Account Role
183 * @rep:businessevent oracle.apps.ar.hz.CustAccountRole.update
184 * @rep:doccd 120hztig.pdf Customer Account Role APIs, Oracle Trading Community Architecture Technical Implementation Guide
185 */
186 PROCEDURE update_cust_account_role (
187 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
188 p_cust_account_role_rec IN CUST_ACCOUNT_ROLE_REC_TYPE,
189 p_object_version_number IN OUT NOCOPY NUMBER,
190 x_return_status OUT NOCOPY VARCHAR2,
191 x_msg_count OUT NOCOPY NUMBER,
192 x_msg_data OUT NOCOPY VARCHAR2
193 );
194
195 /**
196 * PROCEDURE get_cust_account_role_rec
197 *
198 * DESCRIPTION
199 * Gets customer account role record
200 *
201 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
202 *
203 * ARGUMENTS
204 * IN:
205 * p_init_msg_list Initialize message stack if it is set to
206 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
207 * p_cust_account_role_id Customer account role id.
208 * IN/OUT:
209 * OUT:
210 * x_cust_account_role_rec Returned customer account role record.
211 * x_return_status Return status after the call. The status can
212 * be FND_API.G_RET_STS_SUCCESS (success),
213 * FND_API.G_RET_STS_ERROR (error),
214 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
215 * x_msg_count Number of messages in message stack.
216 * x_msg_data Message text if x_msg_count is 1.
217 *
218 * NOTES
219 *
220 * MODIFICATION HISTORY
221 *
222 * 07-23-2001 Jianying Huang o Created.
223 *
224 */
225
226 PROCEDURE get_cust_account_role_rec (
227 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
228 p_cust_account_role_id IN NUMBER,
229 x_cust_account_role_rec OUT NOCOPY CUST_ACCOUNT_ROLE_REC_TYPE,
230 x_return_status OUT NOCOPY VARCHAR2,
231 x_msg_count OUT NOCOPY NUMBER,
232 x_msg_data OUT NOCOPY VARCHAR2
233 );
234
235 /**
236 * PROCEDURE create_role_responsibility
237 *
238 * DESCRIPTION
239 * Creates customer account role responsibility.
240 *
241 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
242 *
243 * ARGUMENTS
244 * IN:
245 * p_init_msg_list Initialize message stack if it is set to
246 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
247 * p_role_responsibility_rec Customer account role responsibility record.
248 * IN/OUT:
249 * OUT:
250 * x_responsibility_id Role responsibility ID.
251 * x_return_status Return status after the call. The status can
252 * be FND_API.G_RET_STS_SUCCESS (success),
253 * FND_API.G_RET_STS_ERROR (error),
254 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
255 * x_msg_count Number of messages in message stack.
256 * x_msg_data Message text if x_msg_count is 1.
257 *
258 * NOTES
259 *
260 * MODIFICATION HISTORY
261 *
262 * 07-23-2001 Jianying Huang o Created.
263 *
264 */
265
266 /*#
267 * Use this routine to create a role responsibility. This API creates records in the
268 * HZ_ROLE_RESPONSIBILITY table.
269 * @rep:scope public
270 * @rep:lifecycle active
271 * @rep:displayname Create Role Responsibility
272 * @rep:businessevent oracle.apps.ar.hz.RoleResponsibility.create
273 * @rep:doccd 120hztig.pdf Customer Account Role APIs, Oracle Trading Community Architecture Technical Implementation Guide
274 */
275 PROCEDURE create_role_responsibility (
276 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
277 p_role_responsibility_rec IN ROLE_RESPONSIBILITY_REC_TYPE,
278 x_responsibility_id OUT NOCOPY NUMBER,
279 x_return_status OUT NOCOPY VARCHAR2,
280 x_msg_count OUT NOCOPY NUMBER,
281 x_msg_data OUT NOCOPY VARCHAR2
282 );
283
284 /**
285 * PROCEDURE update_role_responsibility
286 *
287 * DESCRIPTION
288 * Updates customer account role responsibility.
289 *
290 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
291 *
292 * ARGUMENTS
293 * IN:
294 * p_init_msg_list Initialize message stack if it is set to
295 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
296 * p_role_responsibility_rec Customer account role responsibility record.
297 * IN/OUT:
298 * p_object_version_number Used for locking the being updated record.
299 * OUT:
300 * x_return_status Return status after the call. The status can
301 * be FND_API.G_RET_STS_SUCCESS (success),
302 * FND_API.G_RET_STS_ERROR (error),
303 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
304 * x_msg_count Number of messages in message stack.
305 * x_msg_data Message text if x_msg_count is 1.
306 *
307 * NOTES
308 *
309 * MODIFICATION HISTORY
310 *
311 * 07-23-2001 Jianying Huang o Created.
312 *
313 */
314
315 /*#
316 * Use this routine to update a role responsibility. The API updates a record in the
317 * HZ_ROLE_RESPONSIBILITY table.
318 * @rep:scope public
319 * @rep:lifecycle active
320 * @rep:displayname Update Role Responsibility
321 * @rep:businessevent oracle.apps.ar.hz.RoleResponsibility.update
322 * @rep:doccd 120hztig.pdf Customer Account Role APIs, Oracle Trading Community Architecture Technical Implementation Guide
323 */
324 PROCEDURE update_role_responsibility (
325 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
326 p_role_responsibility_rec IN ROLE_RESPONSIBILITY_REC_TYPE,
327 p_object_version_number IN OUT NOCOPY NUMBER,
328 x_return_status OUT NOCOPY VARCHAR2,
329 x_msg_count OUT NOCOPY NUMBER,
330 x_msg_data OUT NOCOPY VARCHAR2
331 );
332
333 /**
334 * PROCEDURE get_role_responsibility_rec
335 *
336 * DESCRIPTION
337 * Gets customer account role responsibility record
338 *
339 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
340 *
341 * ARGUMENTS
342 * IN:
343 * p_init_msg_list Initialize message stack if it is set to
344 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
345 * p_responsibility_id Role responsibility ID.
346 * IN/OUT:
347 * OUT:
348 * x_role_responsibility_rec Returned customer account role responsibility record.
349 * x_return_status Return status after the call. The status can
350 * be FND_API.G_RET_STS_SUCCESS (success),
351 * FND_API.G_RET_STS_ERROR (error),
352 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
353 * x_msg_count Number of messages in message stack.
354 * x_msg_data Message text if x_msg_count is 1.
355 *
356 * NOTES
357 *
358 * MODIFICATION HISTORY
359 *
360 * 07-23-2001 Jianying Huang o Created.
361 *
362 */
363
364 PROCEDURE get_role_responsibility_rec (
365 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
366 p_responsibility_id IN NUMBER,
367 x_role_responsibility_rec OUT NOCOPY ROLE_RESPONSIBILITY_REC_TYPE,
368 x_return_status OUT NOCOPY VARCHAR2,
369 x_msg_count OUT NOCOPY NUMBER,
370 x_msg_data OUT NOCOPY VARCHAR2
371 );
372
373 END HZ_CUST_ACCOUNT_ROLE_V2PUB;