[Home] [Help]
PACKAGE: APPS.JTF_TERR_ASSIGN_PUB
Source
1 Package JTF_TERR_ASSIGN_PUB AUTHID CURRENT_USER AS
2 /* $Header: jtfptrws.pls 120.6 2006/05/25 22:25:51 solin ship $ */
3 /*#
4 * This package provides a public API to find the winning territory-resources
5 * based on the transaction attribute values for the following transactions:
6 * offer, claim, contract renewal and partner.
7 * @rep:scope public
8 * @rep:product JTY
9 * @rep:lifecycle active
10 * @rep:displayname Get Winning Territory-Resources
11 * @rep:compatibility S
12 * @rep:category BUSINESS_ENTITY JTY_TERRITORY
13 */
14
15 ---------------------------------------------------------------------
16 -- Start of Comments
17 -- ---------------------------------------------------
18 -- PACKAGE NAME: JTF_TERR_ASSIGN_PUB
19 -- ---------------------------------------------------
20 -- PURPOSE
21 -- Joint task force applications territory manager public api's.
22 -- This package is a public API for getting winning territories
23 -- or territory resources.
24 --
25 -- Procedures:
26 -- (see below for specification)
27 --
28 -- NOTES
29 -- This package is publicly available for use
30 --
31 -- HISTORY
32 -- 06/21/2001 EIHSU CREATED
33 -- 07/12/01 jdochert creating additional parameters
34 -- 07/23/01 eihsu creating additional parameters
35 -- 09/27/01 arpatel added property 4-15 parameters to bulk_winners_rec_type
36 --
37 --
38 -- End of Comments
39
40 -- ***************************************************
41 -- GLOBAL VARIABLES and RECORD TYPE DEFINITIONS
42 -- ***************************************************
43
44 /* ---------------------------------------------------
45 -- RECORD TYPE: bulk_trans_rec_type
46 --
47 -- Description:
48 -- Territories generic assignment request type.
49 -- All requests for territory assignments inputted with
50 -- this type.
51 -- Notes:
52 -- GENERIC BULK record format copied from JTF_TERRITORY_PUB
53 -- On 6/25/2001
54 --
55 -- ----------------------------------------------------*/
56
57 --TYPE jtf_terr_number_list IS TABLE OF NUMBER;
58
59 --TYPE jtf_terr_char_360list IS TABLE OF VARCHAR2 ( 360 );
60
61 TYPE bulk_trans_rec_type IS RECORD (
62
63 -- logic control properties
64 use_type VARCHAR2(30), -- refer to body for valid values of this parameter
65 source_id NUMBER,
66 transaction_id NUMBER,
67 trans_object_id jtf_terr_number_list := jtf_terr_number_list() ,
68 trans_detail_object_id jtf_terr_number_list := jtf_terr_number_list() ,
69
70 -- transaction qualifier values
71 SQUAL_CHAR01 jtf_terr_char_360list := jtf_terr_char_360list() ,
72 SQUAL_CHAR02 jtf_terr_char_360list := jtf_terr_char_360list() ,
73 SQUAL_CHAR03 jtf_terr_char_360list := jtf_terr_char_360list() ,
74 SQUAL_CHAR04 jtf_terr_char_360list := jtf_terr_char_360list() ,
75 SQUAL_CHAR05 jtf_terr_char_360list := jtf_terr_char_360list() ,
76 SQUAL_CHAR06 jtf_terr_char_360list := jtf_terr_char_360list() ,
77 SQUAL_CHAR07 jtf_terr_char_360list := jtf_terr_char_360list() ,
78 SQUAL_CHAR08 jtf_terr_char_360list := jtf_terr_char_360list() ,
79 SQUAL_CHAR09 jtf_terr_char_360list := jtf_terr_char_360list() ,
80 SQUAL_CHAR10 jtf_terr_char_360list := jtf_terr_char_360list() ,
81 SQUAL_CHAR11 jtf_terr_char_360list := jtf_terr_char_360list() ,
82 SQUAL_CHAR12 jtf_terr_char_360list := jtf_terr_char_360list() ,
83 SQUAL_CHAR13 jtf_terr_char_360list := jtf_terr_char_360list() ,
84 SQUAL_CHAR14 jtf_terr_char_360list := jtf_terr_char_360list() ,
85 SQUAL_CHAR15 jtf_terr_char_360list := jtf_terr_char_360list() ,
86 SQUAL_CHAR16 jtf_terr_char_360list := jtf_terr_char_360list() ,
87 SQUAL_CHAR17 jtf_terr_char_360list := jtf_terr_char_360list() ,
88 SQUAL_CHAR18 jtf_terr_char_360list := jtf_terr_char_360list() ,
89 SQUAL_CHAR19 jtf_terr_char_360list := jtf_terr_char_360list() ,
90 SQUAL_CHAR20 jtf_terr_char_360list := jtf_terr_char_360list() ,
91 SQUAL_CHAR21 jtf_terr_char_360list := jtf_terr_char_360list() ,
92 SQUAL_CHAR22 jtf_terr_char_360list := jtf_terr_char_360list() ,
93 SQUAL_CHAR23 jtf_terr_char_360list := jtf_terr_char_360list() ,
94 SQUAL_CHAR24 jtf_terr_char_360list := jtf_terr_char_360list() ,
95 SQUAL_CHAR25 jtf_terr_char_360list := jtf_terr_char_360list() ,
96 SQUAL_CHAR26 jtf_terr_char_360list := jtf_terr_char_360list() ,
97 SQUAL_CHAR27 jtf_terr_char_360list := jtf_terr_char_360list() ,
98 SQUAL_CHAR28 jtf_terr_char_360list := jtf_terr_char_360list() ,
99 SQUAL_CHAR29 jtf_terr_char_360list := jtf_terr_char_360list() ,
100 SQUAL_CHAR30 jtf_terr_char_360list := jtf_terr_char_360list() ,
101 SQUAL_CHAR31 jtf_terr_char_360list := jtf_terr_char_360list() ,
102 SQUAL_CHAR32 jtf_terr_char_360list := jtf_terr_char_360list() ,
103 SQUAL_CHAR33 jtf_terr_char_360list := jtf_terr_char_360list() ,
104 SQUAL_CHAR34 jtf_terr_char_360list := jtf_terr_char_360list() ,
105 SQUAL_CHAR35 jtf_terr_char_360list := jtf_terr_char_360list() ,
106 SQUAL_CHAR36 jtf_terr_char_360list := jtf_terr_char_360list() ,
107 SQUAL_CHAR37 jtf_terr_char_360list := jtf_terr_char_360list() ,
108 SQUAL_CHAR38 jtf_terr_char_360list := jtf_terr_char_360list() ,
109 SQUAL_CHAR39 jtf_terr_char_360list := jtf_terr_char_360list() ,
110 SQUAL_CHAR40 jtf_terr_char_360list := jtf_terr_char_360list() ,
111 SQUAL_CHAR41 jtf_terr_char_360list := jtf_terr_char_360list() ,
112 SQUAL_CHAR42 jtf_terr_char_360list := jtf_terr_char_360list() ,
113 SQUAL_CHAR43 jtf_terr_char_360list := jtf_terr_char_360list() ,
114 SQUAL_CHAR44 jtf_terr_char_360list := jtf_terr_char_360list() ,
115 SQUAL_CHAR45 jtf_terr_char_360list := jtf_terr_char_360list() ,
116 SQUAL_CHAR46 jtf_terr_char_360list := jtf_terr_char_360list() ,
117 SQUAL_CHAR47 jtf_terr_char_360list := jtf_terr_char_360list() ,
118 SQUAL_CHAR48 jtf_terr_char_360list := jtf_terr_char_360list() ,
119 SQUAL_CHAR49 jtf_terr_char_360list := jtf_terr_char_360list() ,
120 SQUAL_CHAR50 jtf_terr_char_360list := jtf_terr_char_360list() ,
121
122 SQUAL_NUM01 jtf_terr_number_list := jtf_terr_number_list() ,
123 SQUAL_NUM02 jtf_terr_number_list := jtf_terr_number_list() ,
124 SQUAL_NUM03 jtf_terr_number_list := jtf_terr_number_list() ,
125 SQUAL_NUM04 jtf_terr_number_list := jtf_terr_number_list() ,
126 SQUAL_NUM05 jtf_terr_number_list := jtf_terr_number_list() ,
127 SQUAL_NUM06 jtf_terr_number_list := jtf_terr_number_list() ,
128 SQUAL_NUM07 jtf_terr_number_list := jtf_terr_number_list() ,
129 SQUAL_NUM08 jtf_terr_number_list := jtf_terr_number_list() ,
130 SQUAL_NUM09 jtf_terr_number_list := jtf_terr_number_list() ,
131 SQUAL_NUM10 jtf_terr_number_list := jtf_terr_number_list() ,
132 SQUAL_NUM11 jtf_terr_number_list := jtf_terr_number_list() ,
133 SQUAL_NUM12 jtf_terr_number_list := jtf_terr_number_list() ,
134 SQUAL_NUM13 jtf_terr_number_list := jtf_terr_number_list() ,
135 SQUAL_NUM14 jtf_terr_number_list := jtf_terr_number_list() ,
136 SQUAL_NUM15 jtf_terr_number_list := jtf_terr_number_list() ,
137 SQUAL_NUM16 jtf_terr_number_list := jtf_terr_number_list() ,
138 SQUAL_NUM17 jtf_terr_number_list := jtf_terr_number_list() ,
139 SQUAL_NUM18 jtf_terr_number_list := jtf_terr_number_list() ,
140 SQUAL_NUM19 jtf_terr_number_list := jtf_terr_number_list() ,
141 SQUAL_NUM20 jtf_terr_number_list := jtf_terr_number_list() ,
142 SQUAL_NUM21 jtf_terr_number_list := jtf_terr_number_list() ,
143 SQUAL_NUM22 jtf_terr_number_list := jtf_terr_number_list() ,
144 SQUAL_NUM23 jtf_terr_number_list := jtf_terr_number_list() ,
145 SQUAL_NUM24 jtf_terr_number_list := jtf_terr_number_list() ,
146 SQUAL_NUM25 jtf_terr_number_list := jtf_terr_number_list() ,
147 SQUAL_NUM26 jtf_terr_number_list := jtf_terr_number_list() ,
148 SQUAL_NUM27 jtf_terr_number_list := jtf_terr_number_list() ,
149 SQUAL_NUM28 jtf_terr_number_list := jtf_terr_number_list() ,
150 SQUAL_NUM29 jtf_terr_number_list := jtf_terr_number_list() ,
151 SQUAL_NUM30 jtf_terr_number_list := jtf_terr_number_list() ,
152 SQUAL_NUM31 jtf_terr_number_list := jtf_terr_number_list() ,
153 SQUAL_NUM32 jtf_terr_number_list := jtf_terr_number_list() ,
154 SQUAL_NUM33 jtf_terr_number_list := jtf_terr_number_list() ,
155 SQUAL_NUM34 jtf_terr_number_list := jtf_terr_number_list() ,
156 SQUAL_NUM35 jtf_terr_number_list := jtf_terr_number_list() ,
157 SQUAL_NUM36 jtf_terr_number_list := jtf_terr_number_list() ,
158 SQUAL_NUM37 jtf_terr_number_list := jtf_terr_number_list() ,
159 SQUAL_NUM38 jtf_terr_number_list := jtf_terr_number_list() ,
160 SQUAL_NUM39 jtf_terr_number_list := jtf_terr_number_list() ,
161 SQUAL_NUM40 jtf_terr_number_list := jtf_terr_number_list() ,
162 SQUAL_NUM41 jtf_terr_number_list := jtf_terr_number_list() ,
163 SQUAL_NUM42 jtf_terr_number_list := jtf_terr_number_list() ,
164 SQUAL_NUM43 jtf_terr_number_list := jtf_terr_number_list() ,
165 SQUAL_NUM44 jtf_terr_number_list := jtf_terr_number_list() ,
166 SQUAL_NUM45 jtf_terr_number_list := jtf_terr_number_list() ,
167 SQUAL_NUM46 jtf_terr_number_list := jtf_terr_number_list() ,
168 SQUAL_NUM47 jtf_terr_number_list := jtf_terr_number_list() ,
169 SQUAL_NUM48 jtf_terr_number_list := jtf_terr_number_list() ,
170 SQUAL_NUM49 jtf_terr_number_list := jtf_terr_number_list() ,
171 SQUAL_NUM50 jtf_terr_number_list := jtf_terr_number_list() ,
172
173 SQUAL_CURC01 jtf_terr_char_360list := jtf_terr_char_360list() ,
174 SQUAL_CURC02 jtf_terr_char_360list := jtf_terr_char_360list() ,
175 SQUAL_CURC03 jtf_terr_char_360list := jtf_terr_char_360list() ,
176 SQUAL_CURC04 jtf_terr_char_360list := jtf_terr_char_360list() ,
177 SQUAL_CURC05 jtf_terr_char_360list := jtf_terr_char_360list()
178
179 );
180
181 G_MISS_BULK_TRANS_REC bulk_trans_rec_type;
182
183
184 /* ---------------------------------------------------
185 -- RECORD TYPE: bulk_terr_winners_rec_type
186 --
187 -- Description:
188 -- Territories generic assignment return type.
189 -- All results from territory assignments outputted to
190 -- this type.
191 -- Notes:
192 -- use_flag - with values TERR, LOOKUP, MEMBERS
193 -- determines what fields in the record type will be
194 -- instantiated.
195 --
196 -- ---------------------------------------------------*/
197
198 TYPE bulk_winners_rec_type IS RECORD (
199
200 -- logic control properties
201
202 use_type VARCHAR2(30), -- refer to body for valid values of this parameter
203 source_id NUMBER,
204 transaction_id NUMBER,
205 trans_object_id jtf_terr_number_list := jtf_terr_number_list() ,
206 trans_detail_object_id jtf_terr_number_list := jtf_terr_number_list() ,
207
208 -- territory definition properties
209 terr_id jtf_terr_number_list := jtf_terr_number_list() ,
210 terr_rsc_id jtf_terr_number_list := jtf_terr_number_list() ,
211 terr_name jtf_terr_char_360list := jtf_terr_char_360list() ,
212 top_level_terr_id jtf_terr_number_list := jtf_terr_number_list() ,
213 absolute_rank jtf_terr_number_list := jtf_terr_number_list() ,
214
215 -- resource definition properties
216 resource_id jtf_terr_number_list := jtf_terr_number_list() ,
217 resource_type jtf_terr_char_360list := jtf_terr_char_360list() ,
218 group_id jtf_terr_number_list := jtf_terr_number_list() ,
219 role jtf_terr_char_360list := jtf_terr_char_360list() ,
220 full_access_flag jtf_terr_char_360list := jtf_terr_char_360list() ,
221 primary_contact_flag jtf_terr_char_360list := jtf_terr_char_360list() ,
222 resource_name jtf_terr_char_360list := jtf_terr_char_360list() ,
223 resource_job_title jtf_terr_char_360list := jtf_terr_char_360list() ,
224 resource_phone jtf_terr_char_360list := jtf_terr_char_360list() ,
225 resource_email jtf_terr_char_360list := jtf_terr_char_360list() ,
226 resource_mgr_name jtf_terr_char_360list := jtf_terr_char_360list() ,
227 resource_mgr_phone jtf_terr_char_360list := jtf_terr_char_360list() ,
228 resource_mgr_email jtf_terr_char_360list := jtf_terr_char_360list() ,
229 property1 jtf_terr_char_360list := jtf_terr_char_360list() ,
230 property2 jtf_terr_char_360list := jtf_terr_char_360list() ,
231 property3 jtf_terr_char_360list := jtf_terr_char_360list() ,
232 property4 jtf_terr_char_360list := jtf_terr_char_360list() ,
233 property5 jtf_terr_char_360list := jtf_terr_char_360list() ,
234 property6 jtf_terr_char_360list := jtf_terr_char_360list() ,
235 property7 jtf_terr_char_360list := jtf_terr_char_360list() ,
236 property8 jtf_terr_char_360list := jtf_terr_char_360list() ,
237 property9 jtf_terr_char_360list := jtf_terr_char_360list() ,
238 property10 jtf_terr_char_360list := jtf_terr_char_360list() ,
239 property11 jtf_terr_char_360list := jtf_terr_char_360list() ,
240 property12 jtf_terr_char_360list := jtf_terr_char_360list() ,
241 property13 jtf_terr_char_360list := jtf_terr_char_360list() ,
242 property14 jtf_terr_char_360list := jtf_terr_char_360list() ,
243 property15 jtf_terr_char_360list := jtf_terr_char_360list()
244
245
246 ); -- end bulk_terr_winners_rec_type
247
248 G_MISS_BULK_WINNERS_REC bulk_winners_rec_type;
249
250
251 -- ***************************************************
252 -- API Specifications
253 -- ***************************************************
254 -- api name : Get_Winners
255 -- type : public.
256 -- function : For all Territory Assignment request purposes.
257 -- pre-reqs : Territories needs to be setup first
258 -- notes: Generic public API for retreving any of the following
259 -- * Winning Resource Id's
260 -- * Winning Resource Names + Details
261 -- * Winning terr_id's
262 --
263 /*#
264 * Use this API to find the winning territory-resources based on the
265 * transaction attribute values for the following transactions: offer,
266 * claim, contract renewal and partner.
267 * @param p_api_version_number API version number
271 * -1003 for Oracle Trade Management,
268 * @param p_init_msg_list Initialize message array
269 * @param p_use_type Determines that resources of the winning territories are returned.
270 * @param p_source_id Usage identifier:
272 * -1500 for Oracle Service Contracts,
273 * -1600 for Oracle Collections,
274 * and -1700 for Oracle Partner Management
275 * @param p_trans_id Transaction type identifier:
276 * -1007 for Offer,
277 * -1302 for Claim,
278 * -1501 for Contract Renewal,
279 * and -1701 for Partner
280 * @param p_trans_rec Transaction type attributes (for example, customer name, city, country for account)
281 * @param p_resource_type Obsolete
282 * @param p_role Obsolete
283 * @param p_top_level_terr_id Obsolete
284 * @param p_num_winners Obsolete
285 * @param x_return_status API return status stating success, failure or unexpected error
286 * @param x_msg_count Number of error messages recorded during processing
287 * @param x_msg_data Contains message text if msg_count = 1
288 * @param x_winners_rec Attributes of the winning territory-resources
289 * @rep:scope public
290 * @rep:lifecycle active
291 * @rep:displayname Get Winning Territory-Resources
292 */
293 PROCEDURE get_winners
294 ( p_api_version_number IN NUMBER,
295 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
296 p_use_type IN VARCHAR2 := 'RESOURCE',
297 p_source_id IN NUMBER,
298 p_trans_id IN NUMBER,
299 p_trans_rec IN bulk_trans_rec_type,
300 p_resource_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
301 p_role IN VARCHAR2 := FND_API.G_MISS_CHAR,
302 p_top_level_terr_id IN NUMBER := FND_API.G_MISS_NUM,
303 p_num_winners IN NUMBER := FND_API.G_MISS_NUM,
304 x_return_status OUT NOCOPY VARCHAR2,
305 x_msg_count OUT NOCOPY NUMBER,
306 x_msg_data OUT NOCOPY VARCHAR2,
307 x_winners_rec OUT NOCOPY bulk_winners_rec_type
308 );
309
310 END JTF_TERR_ASSIGN_PUB;