[Home] [Help]
PACKAGE: APPS.JTF_TERRITORY_TYPE_PUB
Source
1 Package JTF_TERRITORY_TYPE_PUB AS
2 /* $Header: jtfpttys.pls 120.0 2005/06/02 18:21:04 appldev ship $ */
3 -- ***************************************************
4 -- Start of Comments
5 -- ---------------------------------------------------
6 -- PACKAGE NAME: JTF_TERRITORY_TYPE_PUB
7 -- ---------------------------------------------------
8 -- PURPOSE
9 -- Joint task force core territory manager public api's.
10 -- This package is a public API for inserting territory type
11 -- related information in to information into JTF tables.
12 -- It contains specification for pl/sql records and tables
13 -- and the Public territory related API's.
14 --
15 -- Procedures:
16 -- Create_Opportunity (see below for specification)
17 --
18 -- NOTES
19 -- This package is publicly available for use
20 --
21 -- HISTORY
22 -- 06/09/99 VNEDUNGA Created
23 -- 02/17/00 VNEDUNGA Adding ORG_ID to Record Defnitions
24 --
25 -- End of Comments
26
27 --*******************************************************
28 -- Start of Comments
29 ---------------------------------------------------------
30 -- Territory Header Record: TerrType_rec_type
31 -- ---------------------------------------------------
32 -- Parameters:
33 -- Required:
34 -- NAME -- Territory Type Name
35 -- LAST_UPDATE_DATE -- Part of std who columns
36 -- LAST_UPDATED_BY -- Part of std who columns
37 -- CREATION_DATE -- Part of std who columns
38 -- CREATED_BY -- Part of std who columns
39 -- LAST_UPDATE_LOGIN -- Part of std who columns
40 -- ENABLED_FLAG -- Status fo territory type
41 -- NUM_QUALIFIERS -- Number of qualifiers used
42 --
43 -- Defaults:
44 -- Note:
45 --
46 -- End of Comments
47
48 TYPE TerrType_rec_type IS RECORD
49 (
50 TERR_TYPE_ID NUMBER := FND_API.G_MISS_NUM,
51 LAST_UPDATE_DATE DATE := FND_API.G_MISS_DATE,
52 LAST_UPDATED_BY NUMBER := FND_API.G_MISS_NUM,
53 CREATION_DATE DATE := FND_API.G_MISS_DATE,
54 CREATED_BY NUMBER := FND_API.G_MISS_NUM,
55 LAST_UPDATE_LOGIN NUMBER := FND_API.G_MISS_NUM,
56 APPLICATION_SHORT_NAME VARCHAR2(50) := FND_API.G_MISS_CHAR,
57 NAME VARCHAR2(60) := FND_API.G_MISS_CHAR,
58 ENABLED_FLAG VARCHAR2(1) := FND_API.G_MISS_CHAR,
59 START_DATE_ACTIVE DATE := FND_API.G_MISS_DATE,
60 END_DATE_ACTIVE DATE := FND_API.G_MISS_DATE,
61 DESCRIPTION VARCHAR2(240) := FND_API.G_MISS_CHAR,
62 ORG_ID NUMBER := FND_API.G_MISS_NUM,
63 ATTRIBUTE_CATEGORY VARCHAR2(30) := FND_API.G_MISS_CHAR,
64 ATTRIBUTE1 VARCHAR2(150) := FND_API.G_MISS_CHAR,
65 ATTRIBUTE2 VARCHAR2(150) := FND_API.G_MISS_CHAR,
66 ATTRIBUTE3 VARCHAR2(150) := FND_API.G_MISS_CHAR,
67 ATTRIBUTE4 VARCHAR2(150) := FND_API.G_MISS_CHAR,
68 ATTRIBUTE5 VARCHAR2(150) := FND_API.G_MISS_CHAR,
69 ATTRIBUTE6 VARCHAR2(150) := FND_API.G_MISS_CHAR,
70 ATTRIBUTE7 VARCHAR2(150) := FND_API.G_MISS_CHAR,
71 ATTRIBUTE8 VARCHAR2(150) := FND_API.G_MISS_CHAR,
72 ATTRIBUTE9 VARCHAR2(150) := FND_API.G_MISS_CHAR,
73 ATTRIBUTE10 VARCHAR2(150) := FND_API.G_MISS_CHAR,
74 ATTRIBUTE11 VARCHAR2(150) := FND_API.G_MISS_CHAR,
75 ATTRIBUTE12 VARCHAR2(150) := FND_API.G_MISS_CHAR,
76 ATTRIBUTE13 VARCHAR2(150) := FND_API.G_MISS_CHAR,
77 ATTRIBUTE14 VARCHAR2(150) := FND_API.G_MISS_CHAR,
78 ATTRIBUTE15 VARCHAR2(150) := FND_API.G_MISS_CHAR
79 );
80
81 G_MISS_TerrType_REC TerrType_rec_type;
82
83 TYPE TerrType_tbl_type IS TABLE OF TerrType_rec_type
84 INDEX BY BINARY_INTEGER;
85
86 G_MISS_TerrType_TBL TerrType_tbl_type;
87
88
89 --*******************************************************
90 -- Start of Comments
91 ---------------------------------------------------------
92 -- Territory Header Out Record: TerrType_Out_rec_type
93 -- ---------------------------------------------------
94 -- Parameters:
95 -- Required:
96 --
97 -- Defaults:
98 -- Note:
99 --
100 -- End of Comments
101
102 TYPE TerrType_Out_rec_type IS RECORD
103 (
104 TERR_TYPE_ID NUMBER := FND_API.G_MISS_NUM,
105 RETURN_STATUS VARCHAR2(01) := FND_API.G_MISS_CHAR
106 );
107
108 G_MISS_TerrType_OUT_REC TerrType_Out_rec_type;
109
110 TYPE TerrType_Out_tbl_type IS TABLE OF TerrType_Out_rec_type
111 INDEX BY BINARY_INTEGER;
112
113 G_MISS_TerrType_OUT_TBL TerrType_Out_tbl_type;
114
115
116 -- ***************************************************
117 -- Start of Comments
118 -- ---------------------------------------------------
119 -- Territory Type source Record: TerrTypeUsgs_rec_type
120 -- ---------------------------------------------------
121 -- Parameters:
122 --
123 -- Required:
124 -- TERR_TYPE_USG_ID -- primary key sequence
125 -- SOURCE_ID -- Source identifier
126 -- TERR_TYPE_ID -- Territory identifier
127 -- LAST_UPDATE_DATE -- Part of std who columns
128 -- LAST_UPDATED_BY -- Part of std who columns
129 -- CREATION_DATE -- Part of std who columns
130 -- CREATED_BY -- Part of std who columns
131 -- LAST_UPDATE_LOGIN -- Part of std who columns
132 --
133 -- Defaults:
134 -- Note:
135 --
136 -- End of Comments
137
138 TYPE TerrTypeUsgs_rec_type IS RECORD
139 (
140 TERR_TYPE_USG_ID NUMBER := FND_API.G_MISS_NUM,
141 SOURCE_ID NUMBER := FND_API.G_MISS_NUM,
142 TERR_TYPE_ID NUMBER := FND_API.G_MISS_NUM,
143 LAST_UPDATE_DATE DATE := FND_API.G_MISS_DATE,
144 LAST_UPDATED_BY NUMBER := FND_API.G_MISS_NUM,
145 CREATION_DATE DATE := FND_API.G_MISS_DATE,
146 CREATED_BY NUMBER := FND_API.G_MISS_NUM,
147 LAST_UPDATE_LOGIN NUMBER := FND_API.G_MISS_NUM,
148 ORG_ID NUMBER := FND_API.G_MISS_NUM
149 );
150
151 G_MISS_TerrTypeUSGS_REC TerrTypeusgs_rec_type;
152
153 TYPE TerrTypeusgs_tbl_type IS TABLE OF TerrTypeusgs_rec_type
154 INDEX BY BINARY_INTEGER;
155
156 G_MISS_TerrTypeUSGS_TBL TerrTypeusgs_tbl_type;
157
158
159 -- ***************************************************
160 -- Start of Comments
161 -- ---------------------------------------------------
162 -- Territory Type source out Record:
163 -- TerrTypeusgs_out_rec_type
164 -- ---------------------------------------------------
165 -- Parameters:
166 --
167 -- Required:
168 --
169 -- Defaults:
170 -- Note:
171 --
172 -- End of Comments
173
174 TYPE TerrTypeusgs_out_rec_type IS RECORD
175 (
176 TERR_TYPE_USG_ID NUMBER := FND_API.G_MISS_NUM,
177 RETURN_STATUS VARCHAR2(01) := FND_API.G_MISS_CHAR
178 );
179
180 G_MISS_TerrTypeUSGS_OUT_REC TerrTypeusgs_out_rec_type;
181
182 TYPE TerrTypeusgs_out_tbl_type IS TABLE OF TerrTypeusgs_out_rec_type
183 INDEX BY BINARY_INTEGER;
184
185 G_MISS_TerrTypeUSGS_OUT_TBL TerrTypeusgs_out_tbl_type;
186
187
188 -- *************************************************************
189 -- Start of Comments
190 -- -------------------------------------------------------------
191 -- Territory Type Qualifier Type Record: TypeQualTypeUsgs_rec_type
192 -- -------------------------------------------------------------
193 -- Parameters:
194 --
195 -- Required:
196 -- TYPE_QUAL_TYPE_USG_ID -- Primary Key sequence
197 -- TERR_TYPE_USG_ID -- Source source id
198 -- QUAL_TYPE_USG_ID -- Type identifier
199 -- LAST_UPDATE_DATE -- Part of std who columns
200 -- LAST_UPDATED_BY -- Part of std who columns
201 -- CREATION_DATE -- Part of std who columns
202 -- CREATED_BY -- Part of std who columns
203 -- LAST_UPDATE_LOGIN -- Part of std who columns
204 --
205 -- Defaults:
206 -- Note:
207 --
208 -- End of Comments
209
210 TYPE typequaltypeusgs_rec_type IS RECORD
211 (
212 TYPE_QUAL_TYPE_USG_ID NUMBER := FND_API.G_MISS_NUM,
213 TERR_TYPE_ID NUMBER := FND_API.G_MISS_NUM,
214 QUAL_TYPE_USG_ID NUMBER := FND_API.G_MISS_NUM,
215 LAST_UPDATE_DATE DATE := FND_API.G_MISS_DATE,
216 LAST_UPDATED_BY NUMBER := FND_API.G_MISS_NUM,
217 CREATION_DATE DATE := FND_API.G_MISS_DATE,
218 CREATED_BY NUMBER := FND_API.G_MISS_NUM,
219 LAST_UPDATE_LOGIN NUMBER := FND_API.G_MISS_NUM,
220 ORG_ID NUMBER := FND_API.G_MISS_NUM
221 );
222
223 G_MISS_TYPEQUALTYPEUSGS_REC typequaltypeusgs_rec_type;
224
225 TYPE typequaltypeusgs_tbl_type IS TABLE OF typequaltypeusgs_rec_type
226 INDEX BY BINARY_INTEGER;
227
228 G_MISS_TYPEQUALTYPEUSGS_TBL TypeQualTypeUsgs_tbl_type;
229
230
231 -- ***********************************************************
232 -- Start of Comments
233 -- -----------------------------------------------------------
234 -- Territory Type Source Type out Record:
235 -- TerrTypesrcType_out_rec_type
236 -- -----------------------------------------------------------
237 -- Parameters:
238 --
239 -- Required:
240 -- Defaults:
241 -- Note:
242 --
243 -- End of Comments
244
245 TYPE typequaltypeusgs_out_rec_type IS RECORD
246 (
247 TYPE_QUAL_TYPE_USG_ID NUMBER := FND_API.G_MISS_NUM,
248 RETURN_STATUS VARCHAR2(01) := FND_API.G_MISS_CHAR
249 );
250
251 G_MISS_TYPEQUALTYPUSGS_OUT_REC typequaltypeusgs_out_rec_type;
252
253
254 TYPE Typequaltypeusgs_out_tbl_type IS TABLE OF typequaltypeusgs_out_rec_type
255 INDEX BY BINARY_INTEGER;
256
257 G_MISS_TYPEQUALTYPUSGS_OUT_TBL Typequaltypeusgs_out_tbl_type;
258
259
260 -- ***************************************************
261 -- Start of Comments
262 -- ---------------------------------------------------
263 -- Territory Qualifier Record: TerrTypequal_rec_type
264 -- ---------------------------------------------------
265 -- Parameters:
266 --
267 -- Required:
268 -- SEEDED_QUAL_ID -- Seeded qualifier id
269 -- TERR_TYPE_ID -- Territory type identifier
270 -- LAST_UPDATE_DATE -- Part of std who columns
271 -- LAST_UPDATED_BY -- Part of std who columns
272 -- CREATION_DATE -- Part of std who columns
273 -- CREATED_BY -- Part of std who columns
274 -- LAST_UPDATE_LOGIN -- Part of std who columns
275 --
276 -- Defaults:
277 -- Note:
278 -- End of Comments
279
280 TYPE TerrTypequal_rec_type IS RECORD
281 (
282 TERR_TYPE_QUAL_ID NUMBER := FND_API.G_MISS_NUM,
283 QUAL_USG_ID NUMBER := FND_API.G_MISS_NUM,
284 TERR_TYPE_ID NUMBER := FND_API.G_MISS_NUM,
285 EXCLUSIVE_USE_FLAG VARCHAR2(1) := FND_API.G_MISS_CHAR,
286 LAST_UPDATE_DATE DATE := FND_API.G_MISS_DATE,
287 LAST_UPDATED_BY NUMBER := FND_API.G_MISS_NUM,
288 CREATION_DATE DATE := FND_API.G_MISS_DATE,
289 CREATED_BY NUMBER := FND_API.G_MISS_NUM,
290 LAST_UPDATE_LOGIN NUMBER := FND_API.G_MISS_NUM,
291 OVERLAP_ALLOWED_FLAG VARCHAR2(1) := FND_API.G_MISS_CHAR,
292 IN_USE_FLAG VARCHAR2(1) := FND_API.G_MISS_CHAR,
293 QUALIFIER_MODE VARCHAR2(30) := FND_API.G_MISS_CHAR,
294 ORG_ID NUMBER := FND_API.G_MISS_NUM
295 );
296
297 G_MISS_TerrTypeQUAL_REC TerrTypequal_rec_type;
298
299 TYPE TerrTypequal_tbl_type IS TABLE OF TerrTypequal_rec_type
300 INDEX BY BINARY_INTEGER;
301
302 G_MISS_TerrTypeQUAL_TBL TerrTypequal_tbl_type;
303
304
305 -- ***************************************************
306 -- Start of Comments
307 -- ---------------------------------------------------
308 -- Territory Type Qualifier Record: TerrTypequal_out_rec_type
309 -- ---------------------------------------------------
310 -- Parameters:
311 --
312 -- Required:
313 --
314 -- Defaults:
315 -- Note:
316 -- End of Comments
317
318 TYPE TerrTypequal_out_rec_type IS RECORD
319 (
320 TERR_TYPE_QUAL_ID NUMBER := FND_API.G_MISS_NUM,
321 return_status VARCHAR2(1) := FND_API.G_MISS_CHAR
322 );
323
324 G_MISS_TerrTypeQUAL_OUT_REC TerrTypequal_out_rec_type;
325
326 TYPE TerrTypequal_out_tbl_type IS TABLE OF TerrTypequal_out_rec_type
330
327 INDEX BY BINARY_INTEGER;
328
329 G_MISS_TerrTypeQUAL_OUT_TBL TerrTypequal_out_tbl_type;
331 -- ***************************************************
332 -- start of comments
333 -- ***************************************************
334 -- api name : create_terrtype
335 -- type : public.
336 -- function : creates territory type defnitions
337 -- pre-reqs : Territory qualifiers has to be enabled.
338 -- parameters :
339
340 -- in:
341 -- p_api_version_number in number required
342 -- p_init_msg_list in varchar2 optional --default = fnd_api.g_false
343 -- p_commit in varchar2 optional --default = fnd_api.g_false
344 -- p_TerrType_rec in TerrType_rec_type required --default = g_miss_TerrType_rec,
345 -- p_TerrTypequal_tbl in TerrTypequal_tbl_type required --default = g_miss_TerrTypequal_rec,
346 -- p_TerrTypeusgs_tbl in TerrTypeusgs_rec_type required --default = g_miss_tersrc_rec
347 -- p_TypequalTypeusgs_tbl in TypeQualTypeUsgs_tbl_type required --default = g_miss_tersrc_tbl,
348 --
349 -- out:
350 -- p_return_status out varchar2(1)
351 -- p_msg_count out number
352 -- p_msg_data out varchar2(2000)
353 -- p_TerrType_id out number
354 -- p_TerrTypequal_out_tbl out TerrTypequal_out_tbl_type
355 -- p_TerrTypeusgs_out_tbl out TerrTypeusgs_out_tbl_type
356 -- p_TypeQualTypeUsgs_out_tbl out TypeQualTypeUsgs_out_tbl_type
357 --
358 -- requirements :
359 -- business rules :
360
361 -- version : current version 1.0
362 -- initial version: initial version 1.0
363 --
364 -- notes: api for creating territory types
365 --
366 -- end of comments
367
368 procedure create_terrtype
369 ( p_api_version_number in number,
370 p_init_msg_list in varchar2 := fnd_api.g_false,
371 p_commit in varchar2 := fnd_api.g_false,
372 p_TerrType_rec in TerrType_rec_type := g_miss_TerrType_rec,
373 p_TerrTypequal_tbl in TerrTypequal_tbl_type := g_miss_TerrTypequal_tbl,
374 p_TerrTypeusgs_tbl in TerrTypeusgs_tbl_type := g_miss_TerrTypeusgs_tbl,
375 p_TypeQualTypeUsgs_tbl in TypeQualTypeUsgs_tbl_type := g_miss_typeQualTypeUsgs_tbl,
376 x_return_status OUT NOCOPY varchar2,
377 x_msg_count OUT NOCOPY number,
378 x_msg_data OUT NOCOPY varchar2,
379 x_TerrType_id OUT NOCOPY number,
380 x_TerrTypequal_out_tbl OUT NOCOPY TerrTypequal_out_tbl_type,
381 x_TerrTypeusgs_out_tbl OUT NOCOPY TerrTypeusgs_out_tbl_type,
382 x_TypeQualTypeUsgs_out_tbl OUT NOCOPY TypeQualTypeUsgs_out_tbl_type
383 );
384
385
386 -- ***************************************************
387 -- start of comments
388 -- ***************************************************
389 -- api name : update_Terrtype
390 -- type : public.
391 -- function : Update territory type defnitions
392 -- pre-reqs : Territory qualifiers has to be enabled.
393 -- parameters :
394
395 -- in:
396 -- p_api_version_number in number required
397 -- p_init_msg_list in varchar2 optional --default = fnd_api.g_false
398 -- p_commit in varchar2 optional --default = fnd_api.g_false
399 -- p_TerrType_rec in TerrType_rec_type required --default = g_miss_TerrType_rec,
400 -- p_TerrTypequal_tbl in TerrTypequal_tbl_type required --default = g_miss_TerrTypequal_rec,
401 -- p_TerrTypesrc_tbl in TerrTypesrc_rec_type required --default = g_miss_tersrc_rec
402 -- p_TerrTypeSrcType_tbl in TerrTypeSrcType_tbl_type required --default = g_miss_tersrc_tbl,
403 -- out:
404 -- p_return_status out varchar2(1)
405 -- p_msg_count out number
406 -- p_msg_data out varchar2(2000)
407 -- p_TerrTypequal_out_tbl out TerrTypequal_out_tbl_type,
408 -- p_TerrTypesrc_out_tbl out TerrTypeSrc_out_tbl_type,
409 -- p_TerrTypeSrcType_out_tbl out TerrTypeSrcType_out_tbl_type
410 --
411 -- requirements :
412 -- business rules :
413
414 -- version : current version 1.0
415 -- initial version: initial version 1.0
416 --
417 -- notes: api for Updating territory types
418 --
419 -- end of comments
420
421 procedure Update_Terrtype
422 ( p_api_version_number in number,
423 p_init_msg_list in varchar2 := fnd_api.g_false,
424 p_commit in varchar2 := fnd_api.g_false,
425 p_TerrType_rec in TerrType_rec_type := g_miss_TerrType_rec,
426 p_TerrTypequal_tbl in TerrTypequal_tbl_type := g_miss_TerrTypequal_tbl,
427 p_TerrTypeUsgs_tbl in TerrTypeusgs_tbl_type := g_miss_TerrTypeusgs_tbl,
431 x_msg_data OUT NOCOPY varchar2,
428 p_TypeQualTypeUsgs_tbl in TypeQualTypeUsgs_tbl_type := g_miss_TypeQualTypeUsgs_tbl,
429 x_return_status OUT NOCOPY varchar2,
430 x_msg_count OUT NOCOPY number,
432 x_TerrType_out_rec OUT NOCOPY TerrType_out_rec_type,
433 x_TerrTypequal_out_tbl OUT NOCOPY TerrTypequal_out_tbl_type,
434 x_TerrTypeUsgs_out_tbl OUT NOCOPY TerrTypeusgs_out_tbl_type,
435 x_TypeQualTypeUsgs_out_tbl OUT NOCOPY TypeQualTypeUsgs_out_tbl_type
436 );
437
438 -- ***************************************************
439 -- start of comments
440 -- ***************************************************
441 -- api name : Delete_TerrType
442 -- type : public.
443 -- function : Delete territory type defnitions
444 -- pre-reqs : Territory qualifiers has to be enabled.
445 -- parameters :
446 --
447 -- in:
448 -- p_api_version_number in number required
449 -- p_init_msg_list in varchar2 optional --default = fnd_api.g_false
450 -- p_commit in varchar2 optional --default = fnd_api.g_false
451 -- p_TerrType_id in number
452 --
453 -- out:
454 -- p_return_status out varchar2(1)
455 -- p_msg_count out number
456 -- p_msg_data out varchar2(2000)
457 --
458 -- requirements :
459 -- business rules :
460
461 -- version : current version 1.0
462 -- initial version: initial version 1.0
463 --
464 -- notes: API for Deleting territory types
465 --
466 -- end of comments
467
468 procedure Delete_TerrType
469 ( p_api_version_number in number,
470 p_init_msg_list in varchar2 := fnd_api.g_false,
471 p_commit in varchar2 := fnd_api.g_false,
472 p_TerrType_id in number,
473 x_return_status OUT NOCOPY varchar2,
474 x_msg_count OUT NOCOPY number,
475 x_msg_data OUT NOCOPY varchar2
476 );
477
478
479
480
481 -- ***************************************************
482 -- start of comments
483 -- ***************************************************
484 -- api name : Deactivate_TerrType
485 -- type : public.
486 -- function : Deactivate territory type defnitions
487 -- pre-reqs : Territory qualifiers has to be enabled.
488 -- parameters :
489 --
490 -- in:
491 -- p_api_version_number in number required
492 -- p_init_msg_list in varchar2 optional --default = fnd_api.g_false
493 -- p_commit in varchar2 optional --default = fnd_api.g_false
494 -- p_TerrType_id in number
495 --
496 -- out:
497 -- p_return_status out varchar2(1)
498 -- p_msg_count out number
499 -- p_msg_data out varchar2(2000)
500 --
501 -- requirements :
502 -- business rules :
503
504 -- version : current version 1.0
505 -- initial version: initial version 1.0
506 --
507 -- notes: API for Deleting territory types
508 --
509 -- end of comments
510
511 procedure Deactivate_TerrType
512 ( p_api_version_number in number,
513 p_init_msg_list in varchar2 := fnd_api.g_false,
514 p_commit in varchar2 := fnd_api.g_false,
515 p_TerrType_id in number,
516 x_return_status OUT NOCOPY varchar2,
517 x_msg_count OUT NOCOPY number,
518 x_msg_data OUT NOCOPY varchar2
519 );
520 --
521 END JTF_TERRITORY_TYPE_PUB; -- Package spec