[Home] [Help]
PACKAGE: APPS.HZ_GEOGRAPHY_STRUCTURE_PUB
Source
1 PACKAGE HZ_GEOGRAPHY_STRUCTURE_PUB AS
2 /*$Header: ARHGSTSS.pls 120.6 2005/08/26 15:22:12 dmmehta noship $ */
3
4 --------------------------------------
5 -- declaration of record type
6 --------------------------------------
7
8 TYPE incl_geo_type_tbl_type IS TABLE OF VARCHAR2(30)
9 INDEX BY BINARY_INTEGER;
10
11 TYPE geography_type_rec_type IS RECORD(
12 geography_type VARCHAR2(30),
13 geography_type_name VARCHAR2(80),
14 created_by_module VARCHAR2(150),
15 application_id NUMBER
16 );
17
18 TYPE geo_structure_rec_type IS RECORD(
19 geography_id NUMBER,
20 geography_type VARCHAR2(30),
21 parent_geography_type VARCHAR2(30),
22 created_by_module VARCHAR2(150),
23 application_id NUMBER,
24 addr_val_level VARCHAR2(30)
25 );
26
27 TYPE geo_rel_type_rec_type IS RECORD(
28 geography_type VARCHAR2(30),
29 parent_geography_type VARCHAR2(30),
30 status VARCHAR2(1),
31 created_by_module VARCHAR2(150),
32 application_id NUMBER
33 );
34
35 TYPE zone_type_rec_type IS RECORD(
36 geography_type VARCHAR2(30),
37 geography_type_name VARCHAR2(80),
38 geography_use VARCHAR2(30),
39 limited_by_geography_id NUMBER,
40 postal_code_range_flag VARCHAR2(1) DEFAULT 'N',
41 included_geography_type incl_geo_type_tbl_type,
42 created_by_module VARCHAR2(150),
43 application_id NUMBER
44 );
45
46
47 --G_MISS_GEO_TYPE_REC GEOGRAPHY_TYPE_REC_TYPE;
48
49 -------------------------------------------------
50 -- declaration of public procedures and functions
51 -------------------------------------------------
52
53 /**
54 * PROCEDURE create_geography_type
55 *
56 * DESCRIPTION
57 * Creates Geography type.
58 *
59 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
60 *
61 * ARGUMENTS
62 * IN:
63 * p_init_msg_list Initialize message stack if it is set to
64 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
65 * p_geography_type_rec Geography type record.
66 * IN/OUT:
67 * OUT:
68 * x_return_status Return status after the call. The status can
69 * be FND_API.G_RET_STS_SUCCESS (success),
70 * FND_API.G_RET_STS_ERROR (error),
71 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
72 * x_msg_count Number of messages in message stack.
73 * x_msg_data Message text if x_msg_count is 1.
74 *
75 * NOTES
76 *
77 * MODIFICATION HISTORY
78 *
79 * 11-04-2002 Rekha Nalluri o Created.
80 *
81 */
82
83 PROCEDURE create_geography_type (
84 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
85 p_geography_type_rec IN GEOGRAPHY_TYPE_REC_TYPE,
86 x_return_status OUT NOCOPY VARCHAR2,
87 x_msg_count OUT NOCOPY NUMBER,
88 x_msg_data OUT NOCOPY VARCHAR2
89 );
90
91 /**
92 * PROCEDURE create_geo_structure
93 *
94 * DESCRIPTION
95 * Creates Geography Structure.
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_geo_structure_rec Geography structure type record.
104
105 * IN/OUT:
106 * OUT:
107 * x_return_status Return status after the call. The status can
108 * be FND_API.G_RET_STS_SUCCESS (success),
109 * FND_API.G_RET_STS_ERROR (error),
110 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
111 * x_msg_count Number of messages in message stack.
112 * x_msg_data Message text if x_msg_count is 1.
113 *
114 * NOTES
115 *
116 * MODIFICATION HISTORY
117 *
118 * 11-15-2002 Rekha Nalluri o Created.
119 *
120 */
121
122
123 PROCEDURE create_geo_structure(
124 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
125 p_geo_structure_rec IN GEO_STRUCTURE_REC_TYPE,
126 x_return_status OUT NOCOPY VARCHAR2,
127 x_msg_count OUT NOCOPY NUMBER,
128 x_msg_data OUT NOCOPY VARCHAR2
129 );
130
131 /**
132 * PROCEDURE update_geo_structure
133 *
134 * DESCRIPTION
135 * Updates geography_element_column in a Geography Structure - geography_element_column can be updated for
136 * a geography_id and relationship_type_id only when there exists no geographies that have used this
137 * structure.
138 *
139 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
140 *
141 * ARGUMENTS
142 * IN:
143 * p_init_msg_list Initialize message stack if it is set to
144 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
145 * p_geo_structure_rec Geography structure type record.
146
147 * IN/OUT:
148 * p_object_version_number object version number of the row being updated
149 * OUT:
150 * x_return_status Return status after the call. The status can
151 * be FND_API.G_RET_STS_SUCCESS (success),
152 * FND_API.G_RET_STS_ERROR (error),
153 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
154 * x_msg_count Number of messages in message stack.
155 * x_msg_data Message text if x_msg_count is 1.
156 *
157 * NOTES
158 *
159 * MODIFICATION HISTORY
160 *
161 * 12-18-2002 Rekha Nalluri o Created.
162 *
163 */
164
165 /*PROCEDURE update_geo_structure(
166 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
167 p_geography_id IN NUMBER,
168 p_geography_type IN VARCHAR2,
169 p_parent_geography_type IN VARCHAR2,
170 p_geography_element_column IN VARCHAR2,
171 p_object_version_number IN OUT NOCOPY NUMBER,
172 x_return_status OUT NOCOPY VARCHAR2,
173 x_msg_count OUT NOCOPY NUMBER,
174 x_msg_data OUT NOCOPY VARCHAR2
175 );*/
176
177
178 /**
179 * PROCEDURE delete_geo_structure
180 *
181 * DESCRIPTION
182 * Deletes the row in the structure. Disables the relationship_type if it is not used by any other structure.
183 *
184 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
185 *
186 * ARGUMENTS
187 * IN:
188 * p_init_msg_list Initialize message stack if it is set to
189 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
190 * p_geo_structure_rec Geography structure type record.
191
192 * IN/OUT:
193 *
194 * OUT:
195 * x_return_status Return status after the call. The status can
196 * be FND_API.G_RET_STS_SUCCESS (success),
197 * FND_API.G_RET_STS_ERROR (error),
198 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
199 * x_msg_count Number of messages in message stack.
200 * x_msg_data Message text if x_msg_count is 1.
201 *
202 * NOTES
203 *
204 * MODIFICATION HISTORY
205 *
206 * 12-19-2002 Rekha Nalluri o Created.
207 *
208 */
209
210 PROCEDURE delete_geo_structure(
211 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
212 p_geography_id IN NUMBER,
213 p_geography_type IN VARCHAR2,
214 p_parent_geography_type IN VARCHAR2,
215 x_return_status OUT NOCOPY VARCHAR2,
216 x_msg_count OUT NOCOPY NUMBER,
217 x_msg_data OUT NOCOPY VARCHAR2
218 );
219
220
221
222 /**
223 * PROCEDURE create_geography_rel_type
224 *
225 * DESCRIPTION
226 * Creates Geography Relationship type.
227 *
228 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
229 *
230 * ARGUMENTS
231 * IN:
232 * p_init_msg_list Initialize message stack if it is set to
233 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
234 * p_geography_rel_type_rec Geography Relationship type record.
235 * IN/OUT:
236 * OUT:
237 * x_return_status Return status after the call. The status can
238 * be FND_API.G_RET_STS_SUCCESS (success),
239 * FND_API.G_RET_STS_ERROR (error),
240 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
241 * x_msg_count Number of messages in message stack.
242 * x_msg_data Message text if x_msg_count is 1.
243 *
244 * NOTES
245 *
246 * MODIFICATION HISTORY
247 *
248 * 11-11-2002 Rekha Nalluri o Created.
249 *
250 */
251
252 PROCEDURE create_geo_rel_type(
253 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
254 p_geo_rel_type_rec IN GEO_REL_TYPE_REC_TYPE,
255 x_relationship_type_id OUT NOCOPY NUMBER,
256 x_return_status OUT NOCOPY VARCHAR2,
257 x_msg_count OUT NOCOPY NUMBER,
258 x_msg_data OUT NOCOPY VARCHAR2
259 );
260
261
262 /**
263 * PROCEDURE update_geography_rel_type
264 *
265 * DESCRIPTION
266 * Updates only Status of geography relationship type.
267 *
268 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
269 *
270 * ARGUMENTS
271 * IN:
272 * p_init_msg_list Initialize message stack if it is set to
273 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
274 * p_geography_rel_type_rec Geography Relationship type record.
275 * IN/OUT:
276 * p_object_version_number object version number of the row being updated
277 * OUT:
278 * x_return_status Return status after the call. The status can
279 * be FND_API.G_RET_STS_SUCCESS (success),
280 * FND_API.G_RET_STS_ERROR (error),
281 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
282 * x_msg_count Number of messages in message stack.
283 * x_msg_data Message text if x_msg_count is 1.
284 *
285 * NOTES
286 *
287 * MODIFICATION HISTORY
288 *
289 * 11-13-2002 Rekha Nalluri o Created.
290 *
291 */
292
293 /* Made it as private procedure as there is no need to call this explicitly
294 * Make this public as it is required from Create/Update Zone API
295 */
296 PROCEDURE update_geo_rel_type(
297 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
298 p_relationship_type_id IN NUMBER,
299 p_status IN VARCHAR2,
300 p_object_version_number IN OUT NOCOPY NUMBER,
301 x_return_status OUT NOCOPY VARCHAR2,
302 x_msg_count OUT NOCOPY NUMBER,
303 x_msg_data OUT NOCOPY VARCHAR2
304 );
305
306 /**
307 * PROCEDURE create_zone_type
308 *
309 * DESCRIPTION
310 * Creates Zone Type.
311 *
312 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
313 *
314 * ARGUMENTS
315 * IN:
316 * p_init_msg_list Initialize message stack if it is set to
317 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
318 * p_zone_type_rec Zone_type type record.
319 * IN/OUT:
320 * OUT:
321 *
322 * x_return_status Return status after the call. The status can
323 * be FND_API.G_RET_STS_SUCCESS (success),
324 * FND_API.G_RET_STS_ERROR (error),
325 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
326 * x_msg_count Number of messages in message stack.
327 * x_msg_data Message text if x_msg_count is 1.
328 *
329 * NOTES
330 *
331 * MODIFICATION HISTORY
332 * 01-09-2003 Rekha Nalluri o Created.
333 *
334 */
335
336 PROCEDURE create_zone_type(
337 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
338 p_zone_type_rec IN ZONE_TYPE_REC_TYPE,
339 x_return_status OUT NOCOPY VARCHAR2,
340 x_msg_count OUT NOCOPY NUMBER,
341 x_msg_data OUT NOCOPY VARCHAR2
342 );
343
344
345
346 /**
347 * PROCEDURE update_zone_type
348 *
349 * DESCRIPTION
350 * Updates zone type.
351 *
352 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
353 *
354 * ARGUMENTS
355 * IN:
356 * p_init_msg_list Initialize message stack if it is set to
357 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
358 * p_geographytype Geography type.
359 * p_limited_by_geography_id
360 * p_postal_code_range_flag
361 * IN/OUT:
362 * p_object_version_number object version number of the row being updated
363 * OUT:
364 * x_return_status Return status after the call. The status can
365 * be FND_API.G_RET_STS_SUCCESS (success),
366 * FND_API.G_RET_STS_ERROR (error),
367 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
368 * x_msg_count Number of messages in message stack.
369 * x_msg_data Message text if x_msg_count is 1.
370 *
371 * NOTES
372 *
373 * MODIFICATION HISTORY
374 *
375 * 01-13-2003 Rekha Nalluri o Created.
376 *
377 */
378
379 PROCEDURE update_zone_type(
380 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
381 p_zone_type_rec IN ZONE_TYPE_REC_TYPE,
382 p_object_version_number IN OUT NOCOPY NUMBER,
383 x_return_status OUT NOCOPY VARCHAR2,
384 x_msg_count OUT NOCOPY NUMBER,
385 x_msg_data OUT NOCOPY VARCHAR2
386 );
387
388 END HZ_GEOGRAPHY_STRUCTURE_PUB;