1 PACKAGE HZ_ORIG_SYSTEM_REF_BO_PUB AS
2 /*$Header: ARHBOSBS.pls 120.7 2006/09/22 00:42:08 acng noship $ */
3 /*#
4 * Business Object Source System Management API
5 * Public API that allows users to manage source system references for business objects in the
6 * Trading Community Architecture. Several operations are supported, including the creation, update,
7 * and remap of source system information for a business object.
8 *
9 * @rep:scope public
10 * @rep:product HZ
11 * @rep:lifecycle active
12 * @rep:category BUSINESS_ENTITY HZ_EXTERNAL_REFERENCE
13 * @rep:displayname Business Object Source System Management API
14 * @rep:doccd 120hztig.pdf Business Object APIs Overview, Oracle Trading Community Architecture Technical Implementation Guide
15 */
16
17 TYPE object_type_tbl IS TABLE OF VARCHAR2(30);
18 TYPE object_id_tbl IS TABLE OF NUMBER;
19 TYPE object_os_tbl IS TABLE OF VARCHAR2(30);
20 TYPE object_osr_tbl IS TABLE OF VARCHAR2(255);
21 TYPE reason_code_tbl IS TABLE OF VARCHAR2(30);
22
23 TYPE REMAP_ORIG_SYS_REC IS RECORD (
24 object_type object_type_tbl,
25 old_object_id object_id_tbl,
26 new_object_id object_id_tbl,
27 object_os object_os_tbl,
28 object_osr object_osr_tbl,
29 reason_code reason_code_tbl
30 );
31
32 -- PROCEDURE create_orig_sys_refs_bo
33 --
34 -- DESCRIPTION
35 -- Create original system references
36 --
37 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
38 --
39 -- ARGUMENTS
40 -- IN:
41 -- p_init_msg_list Initialize message stack if it is set to
42 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
43 -- p_orig_sys_refs List of original system reference objects.
44 -- p_created_by_module Created by module.
45 -- OUT:
46 -- x_return_status Return status after the call. The status can
47 -- be fnd_api.g_ret_sts_success (success),
48 -- fnd_api.g_ret_sts_error (error),
49 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
50 -- x_msg_count Number of messages in message stack.
51 -- x_msg_data Message text if x_msg_count is 1.
52 --
53 -- NOTES
54 --
55 -- MODIFICATION HISTORY
56 --
57 -- 14-DEC-2004 Arnold Ng Created.
58 --
59 PROCEDURE create_orig_sys_refs_bo(
60 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
61 p_orig_sys_refs IN HZ_ORIG_SYS_REF_OBJ_TBL,
62 p_created_by_module IN VARCHAR2,
63 x_return_status OUT NOCOPY VARCHAR2,
64 x_msg_count OUT NOCOPY NUMBER,
65 x_msg_data OUT NOCOPY VARCHAR2
66 );
67
68 /*#
69 * Create Object Source System References (create_orig_sys_refs_bo)
70 * Creates source system references to TCA for business objects. You pass the Source System information,
71 * including Original System Name and Original System Reference, and the procedure creates the source system
72 * reference in TCA. Multiple source system references for multiple objects can be created in one API call.
73 *
74 * @param p_orig_sys_refs The business object source system references to be created
75 * @param p_created_by_module The module creating this business object. Must be a valid created_by_module value
76 * @param x_return_status Return status after the call
77 * @param x_msg_count Number of messages in message stack.
78 * @param x_msg_data Messages returned from the operation
79 * @rep:scope public
80 * @rep:lifecycle active
81 * @rep:displayname Create Object Source System References
82 * @rep:doccd 120hztig.pdf Business Object APIs Overview, Oracle Trading Community Architecture Technical Implementation Guide
83 */
84 PROCEDURE create_orig_sys_refs_bo(
85 p_orig_sys_refs IN HZ_ORIG_SYS_REF_OBJ_TBL,
86 p_created_by_module IN VARCHAR2,
87 x_return_status OUT NOCOPY VARCHAR2,
88 x_msg_count OUT NOCOPY NUMBER,
89 x_msg_data OUT NOCOPY HZ_MESSAGE_OBJ_TBL
90 );
91
92 -- PROCEDURE update_orig_sys_refs_bo
93 --
94 -- DESCRIPTION
95 -- Update original system references
96 --
97 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
98 --
99 -- ARGUMENTS
100 -- IN:
101 -- p_init_msg_list Initialize message stack if it is set to
102 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
103 -- p_orig_sys_refs List of original system reference objects.
104 -- OUT:
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 -- 14-DEC-2004 Arnold Ng Created.
117 --
118
119 PROCEDURE update_orig_sys_refs_bo(
120 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
121 p_orig_sys_refs IN HZ_ORIG_SYS_REF_OBJ_TBL,
122 x_return_status OUT NOCOPY VARCHAR2,
123 x_msg_count OUT NOCOPY NUMBER,
124 x_msg_data OUT NOCOPY VARCHAR2
125 );
126
127 /*#
131 * and the procedure updates the source system reference in TCA. Multiple source system references for multiple
128 * Update Object Source System References (update_orig_sys_refs_bo)
129 * Updates source system references to TCA for business objects. You pass the Source System information including
130 * Original System Name, the old Original System Reference value, and the new Original System Reference value,
132 * objects can be updated in one API call.
133 *
134 * @param p_orig_sys_refs The business object source system references to be updated.
135 * @param x_return_status Return status after the call
136 * @param x_msg_count Number of messages in message stack.
137 * @param x_msg_data Messages returned from the operation
138 * @rep:scope public
139 * @rep:lifecycle active
140 * @rep:displayname Update Object Source System References
141 * @rep:doccd 120hztig.pdf Business Object APIs Overview, Oracle Trading Community Architecture Technical Implementation Guide
142 */
143 PROCEDURE update_orig_sys_refs_bo(
144 p_orig_sys_refs IN HZ_ORIG_SYS_REF_OBJ_TBL,
145 x_return_status OUT NOCOPY VARCHAR2,
146 x_msg_count OUT NOCOPY NUMBER,
147 x_msg_data OUT NOCOPY HZ_MESSAGE_OBJ_TBL
148 );
149
150 -- PROCEDURE remap_internal_identifiers_bo
151 --
152 -- DESCRIPTION
153 -- Remap original system references
154 --
155 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
156 --
157 -- ARGUMENTS
158 -- IN:
159 -- p_init_msg_list Initialize message stack if it is set to
160 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
161 -- p_orig_sys_refs List of original system reference objects.
162 -- OUT:
163 -- x_return_status Return status after the call. The status can
164 -- be fnd_api.g_ret_sts_success (success),
165 -- fnd_api.g_ret_sts_error (error),
166 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
167 -- x_msg_count Number of messages in message stack.
168 -- x_msg_data Message text if x_msg_count is 1.
169 --
170 -- NOTES
171 --
172 -- MODIFICATION HISTORY
173 --
174 -- 14-DEC-2004 Arnold Ng Created.
175
176 PROCEDURE remap_internal_identifiers_bo(
180 x_msg_count OUT NOCOPY NUMBER,
177 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
178 p_orig_sys_refs IN REMAP_ORIG_SYS_REC,
179 x_return_status OUT NOCOPY VARCHAR2,
181 x_msg_data OUT NOCOPY VARCHAR2
182 );
183
184 /*#
185 * Remap Internal Object Identifiers (remap_orig_sys_refs_bo)
186 * Remaps TCA internal object identifiers to an Original System and Original System Reference combination.
187 * You pass the OS and OSR combination, the TCA object identifier for the internal updates source system
188 * references to TCA for business objects. You pass the Source System information, including Original System
189 * Name, the old Original System Reference value, the new Original System Reference value, and the procedure
190 * updates the source system reference in TCA. Multiple source system references, for multiple objects, can
191 * be updated in one API call.
192 *
193 * @param p_orig_sys_refs The business object source system references to be update.
194 * @param x_return_status Return status after the call
195 * @param x_msg_count Number of messages in message stack.
196 * @param x_msg_data Messages returned from the operation
197 * @rep:scope public
198 * @rep:lifecycle active
199 * @rep:displayname Update Object Source System References
200 * @rep:doccd 120hztig.pdf Business Object APIs Overview, Oracle Trading Community Architecture Technical Implementation Guide
201 */
202 PROCEDURE remap_internal_identifiers_bo(
203 p_orig_sys_refs IN REMAP_ORIG_SYS_REC,
204 x_return_status OUT NOCOPY VARCHAR2,
205 x_msg_count OUT NOCOPY NUMBER,
206 x_msg_data OUT NOCOPY HZ_MESSAGE_OBJ_TBL
207 );
208
209 END HZ_ORIG_SYSTEM_REF_BO_PUB;
[Home] [Help]