[Home] [Help]
PACKAGE: APPS.HZ_GEO_STRUCTURE_PUB_UIW
Source
1 PACKAGE HZ_GEO_STRUCTURE_PUB_UIW AUTHID CURRENT_USER AS
2 /*$Header: ARHGSTWS.pls 120.1 2005/08/26 15:22:23 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 );
25
26 TYPE geo_rel_type_rec_type IS RECORD(
27 geography_type VARCHAR2(30),
28 parent_geography_type VARCHAR2(30),
29 status VARCHAR2(1),
30 created_by_module VARCHAR2(150),
31 application_id NUMBER
32 );
33
34 TYPE zone_type_rec_type IS RECORD(
35 geography_type VARCHAR2(30),
36 geography_type_name VARCHAR2(80),
37 geography_use VARCHAR2(30),
38 limited_by_geography_id NUMBER,
39 postal_code_range_flag VARCHAR2(1) DEFAULT 'N',
40 -- included_geography_type incl_geo_type_tbl_type,
41 created_by_module VARCHAR2(150),
42 application_id NUMBER
43 );
44
45
46 --G_MISS_GEO_TYPE_REC GEOGRAPHY_TYPE_REC_TYPE;
47
48 -------------------------------------------------
49 -- declaration of public procedures and functions
50 -------------------------------------------------
51
52 /**
53 * PROCEDURE create_geography_type
54 *
55 * DESCRIPTION
56 * Creates Geography type.
57 *
58 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
59 *
60 * ARGUMENTS
61 * IN:
62 * p_init_msg_list Initialize message stack if it is set to
63 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
64 * p_geography_type_rec Geography type record.
65 * IN/OUT:
66 * OUT:
67 * x_return_status Return status after the call. The status can
68 * be FND_API.G_RET_STS_SUCCESS (success),
69 * FND_API.G_RET_STS_ERROR (error),
70 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
71 * x_msg_count Number of messages in message stack.
72 * x_msg_data Message text if x_msg_count is 1.
73 *
74 * NOTES
75 *
76 * MODIFICATION HISTORY
77 *
78 * 06-28-2005 Kate Shan o Created.
79 *
80 */
81
82 PROCEDURE create_geography_type (
83 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
84 p_geography_type_rec IN GEOGRAPHY_TYPE_REC_TYPE,
85 x_return_status OUT NOCOPY VARCHAR2,
86 x_msg_count OUT NOCOPY NUMBER,
87 x_msg_data OUT NOCOPY VARCHAR2
88 );
89
90 /**
91 * PROCEDURE create_geo_structure
92 *
93 * DESCRIPTION
94 * Creates Geography Structure.
95 *
96 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
97 *
98 * ARGUMENTS
99 * IN:
100 * p_init_msg_list Initialize message stack if it is set to
101 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
102 * p_geo_structure_rec Geography structure type record.
103
104 * IN/OUT:
105 * OUT:
106 * x_return_status Return status after the call. The status can
107 * be FND_API.G_RET_STS_SUCCESS (success),
108 * FND_API.G_RET_STS_ERROR (error),
109 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
110 * x_msg_count Number of messages in message stack.
111 * x_msg_data Message text if x_msg_count is 1.
112 *
113 * NOTES
114 *
115 * MODIFICATION HISTORY
116 *
117 * 06-28-2005 Kate Shan o Created.
118 *
119 */
120
121
122 PROCEDURE create_geo_structure(
123 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
124 p_geo_structure_rec IN GEO_STRUCTURE_REC_TYPE,
125 x_return_status OUT NOCOPY VARCHAR2,
126 x_msg_count OUT NOCOPY NUMBER,
127 x_msg_data OUT NOCOPY VARCHAR2
128 );
129
130
131 /**
132 * PROCEDURE delete_geo_structure
133 *
134 * DESCRIPTION
135 * Deletes the row in the structure. Disables the relationship_type if it is not used by any other structure.
136 *
137 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
138 *
139 * ARGUMENTS
140 * IN:
141 * p_init_msg_list Initialize message stack if it is set to
142 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
143 * p_geo_structure_rec Geography structure type record.
144
145 * IN/OUT:
146 *
147 * OUT:
148 * x_return_status Return status after the call. The status can
149 * be FND_API.G_RET_STS_SUCCESS (success),
150 * FND_API.G_RET_STS_ERROR (error),
151 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
152 * x_msg_count Number of messages in message stack.
153 * x_msg_data Message text if x_msg_count is 1.
154 *
155 * NOTES
156 *
157 * MODIFICATION HISTORY
158 *
159 * 06-28-2005 Kate Shan o Created.
160 *
161 */
162
163 PROCEDURE delete_geo_structure(
164 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
165 p_geography_id IN NUMBER,
166 p_geography_type IN VARCHAR2,
167 p_parent_geography_type IN VARCHAR2,
168 x_return_status OUT NOCOPY VARCHAR2,
169 x_msg_count OUT NOCOPY NUMBER,
170 x_msg_data OUT NOCOPY VARCHAR2
171 );
172
173 /**
174 * PROCEDURE create_geography_rel_type
175 *
176 * DESCRIPTION
177 * Creates Geography Relationship type.
178 *
179 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
180 *
181 * ARGUMENTS
182 * IN:
183 * p_init_msg_list Initialize message stack if it is set to
184 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
185 * p_geography_rel_type_rec Geography Relationship type record.
186 * IN/OUT:
187 * OUT:
188 * x_return_status Return status after the call. The status can
189 * be FND_API.G_RET_STS_SUCCESS (success),
190 * FND_API.G_RET_STS_ERROR (error),
191 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
192 * x_msg_count Number of messages in message stack.
193 * x_msg_data Message text if x_msg_count is 1.
194 *
195 * NOTES
196 *
197 * MODIFICATION HISTORY
198 *
199 * 06-28-2005 Kate Shan o Created.
200 *
201 */
202
203 PROCEDURE create_geo_rel_type(
204 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
205 p_geo_rel_type_rec IN GEO_REL_TYPE_REC_TYPE,
206 x_relationship_type_id OUT NOCOPY NUMBER,
207 x_return_status OUT NOCOPY VARCHAR2,
208 x_msg_count OUT NOCOPY NUMBER,
209 x_msg_data OUT NOCOPY VARCHAR2
210 );
211
212
213 /**
214 * PROCEDURE create_zone_type
215 *
216 * DESCRIPTION
217 * Creates Zone Type.
218 *
219 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
220 *
221 * ARGUMENTS
222 * IN:
223 * p_init_msg_list Initialize message stack if it is set to
224 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
225 * p_zone_type_rec Zone_type type record.
226 * included_geography_type incl_geo_type_tbl_type,
227 * IN/OUT:
228 * OUT:
229 *
230 * x_return_status Return status after the call. The status can
231 * be FND_API.G_RET_STS_SUCCESS (success),
232 * FND_API.G_RET_STS_ERROR (error),
233 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
234 * x_msg_count Number of messages in message stack.
235 * x_msg_data Message text if x_msg_count is 1.
236 *
237 * NOTES
238 *
239 * MODIFICATION HISTORY
240 * 06-28-2005 Kate Shan o Created.
241 *
242 */
243
244 PROCEDURE create_zone_type(
245 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
246 p_zone_type_rec IN ZONE_TYPE_REC_TYPE,
247 p_included_geography_type IN INCL_GEO_TYPE_TBL_TYPE,
248 x_return_status OUT NOCOPY VARCHAR2,
249 x_msg_count OUT NOCOPY NUMBER,
250 x_msg_data OUT NOCOPY VARCHAR2
251 );
252
253
254
255 /**
256 * PROCEDURE update_zone_type
257 *
258 * DESCRIPTION
259 * Updates zone type.
260 *
261 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
262 *
263 * ARGUMENTS
264 * IN:
265 * p_init_msg_list Initialize message stack if it is set to
266 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
267 * p_geographytype Geography type.
268 * p_limited_by_geography_id
269 * p_postal_code_range_flag
270 * IN/OUT:
271 * p_object_version_number object version number of the row being updated
272 * OUT:
273 * x_return_status Return status after the call. The status can
274 * be FND_API.G_RET_STS_SUCCESS (success),
275 * FND_API.G_RET_STS_ERROR (error),
276 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
277 * x_msg_count Number of messages in message stack.
278 * x_msg_data Message text if x_msg_count is 1.
279 *
280 * NOTES
281 *
282 * MODIFICATION HISTORY
283 *
284 * 06-28-2005 Kate Shan o Created.
285 *
286 */
287
288 PROCEDURE update_zone_type(
289 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
290 p_zone_type_rec IN ZONE_TYPE_REC_TYPE,
291 p_included_geography_type IN INCL_GEO_TYPE_TBL_TYPE,
292 p_object_version_number IN OUT NOCOPY NUMBER,
293 x_return_status OUT NOCOPY VARCHAR2,
294 x_msg_count OUT NOCOPY NUMBER,
295 x_msg_data OUT NOCOPY VARCHAR2
296 );
297
298 END HZ_GEO_STRUCTURE_PUB_UIW;