[Home] [Help]
PACKAGE: APPS.JTY_ASSIGN_REALTIME_PUB
Source
1 Package JTY_ASSIGN_REALTIME_PUB AS
2 /* $Header: jtftraes.pls 120.2.12010000.2 2008/12/11 07:13:02 vpalle ship $ */
3 ---------------------------------------------------------------------
4 -- Start of Comments
5 -- ---------------------------------------------------
6 -- PACKAGE NAME: JTY_ASSIGN_REALTIME_PUB
7 -- ---------------------------------------------------
8 -- PURPOSE
9 -- This package is a public API for getting winning territories
10 -- or territory resources in real time.
11 --
12 -- Procedures:
13 -- (see below for specification)
14 --
15 -- NOTES
16 -- This package is publicly available for use
17 --
18 -- HISTORY
19 -- 05/04/05 achanda CREATED
20 --
21 --
22 -- End of Comments
23
24 -- ***************************************************
25 -- GLOBAL VARIABLES and RECORD TYPE DEFINITIONS
26 -- ***************************************************
27
28 /* ---------------------------------------------------
29 -- RECORD TYPE: bulk_trans_id_type
30 --
31 -- Description:
32 -- Product teams using "pass by reference" as parameter passing mechanism
33 -- should use this type to pass the PK of the transaction objects to the
34 -- territory assignment API for real time and date effective assignment.
35 --
36 -- Notes:
37 --
38 -- ----------------------------------------------------*/
39
40 TYPE bulk_trans_id_type IS RECORD (
41
42 -- PK of the transaction objects
43 trans_object_id1 jtf_terr_number_list := jtf_terr_number_list() ,
44 trans_object_id2 jtf_terr_number_list := jtf_terr_number_list() ,
45 trans_object_id3 jtf_terr_number_list := jtf_terr_number_list() ,
46 trans_object_id4 jtf_terr_number_list := jtf_terr_number_list() ,
47 trans_object_id5 jtf_terr_number_list := jtf_terr_number_list() ,
48
49 -- transaction date, applicable only for date effective assignment
50 txn_date jtf_terr_date_list := jtf_terr_date_list()
51 );
52
53 G_MISS_BULK_TRANS_ID bulk_trans_id_type;
54
55 /* ---------------------------------------------------
56 -- RECORD TYPE: bulk_name_value_pair_type
57 --
58 -- Description:
59 -- Product teams using "pass by value" as parameter passing mechanism
60 -- should use this type to pass the attribute name and its value of the
61 -- transaction objects to the territory assignment API for real time assignment.
62 --
63 -- Notes:
64 -- attribute_name : Name of the attribute
65 -- num_value : value of the attribute if the datatype is NUMBER
66 -- date_value : value of the attribute if the datatype is DATE
67 -- char_value : value of the attribute if the datatype is CHAR
68 -- ----------------------------------------------------*/
69
70 TYPE bulk_name_value_pair_type IS RECORD (
71
72 -- Attribute Name and its value
73 attribute_name jtf_terr_char_360list := jtf_terr_char_360list() ,
74 num_value jtf_terr_number_list := jtf_terr_number_list() ,
75 date_value jtf_terr_date_list := jtf_terr_date_list() ,
76 char_value jtf_terr_char_360list := jtf_terr_char_360list()
77 );
78
79 G_MISS_BULK_NAME_VALUE_PAIR bulk_name_value_pair_type;
80
81
82 /* ---------------------------------------------------
83 -- RECORD TYPE: bulk_terr_winners_rec_type
84 --
85 -- Description:
86 -- Territories generic assignment return type.
87 -- All results from territory assignments outputted to
88 -- this type.
89 -- Notes:
90 --
91 -- ---------------------------------------------------*/
92
93 TYPE bulk_winners_rec_type IS RECORD (
94
95 -- logic control properties
96 use_type VARCHAR2(30),
97 source_id NUMBER,
98 trans_id NUMBER,
99 trans_object_id jtf_terr_number_list := jtf_terr_number_list() ,
100 trans_detail_object_id jtf_terr_number_list := jtf_terr_number_list() ,
101 txn_date jtf_terr_date_list := jtf_terr_date_list(),
102
103 -- territory definition properties
104 terr_id jtf_terr_number_list := jtf_terr_number_list() ,
105 org_id jtf_terr_number_list := jtf_terr_number_list() ,
106 terr_start_date jtf_terr_date_list := jtf_terr_date_list(),
107 terr_end_date jtf_terr_date_list := jtf_terr_date_list(),
108 terr_rsc_id jtf_terr_number_list := jtf_terr_number_list() ,
109 terr_name jtf_terr_char_360list := jtf_terr_char_360list() ,
110 top_level_terr_id jtf_terr_number_list := jtf_terr_number_list() ,
111 absolute_rank jtf_terr_number_list := jtf_terr_number_list() ,
112
113 -- resource definition properties
114 resource_id jtf_terr_number_list := jtf_terr_number_list() ,
115 rsc_start_date jtf_terr_date_list := jtf_terr_date_list(),
116 rsc_end_date jtf_terr_date_list := jtf_terr_date_list(),
117 resource_type jtf_terr_char_360list := jtf_terr_char_360list() ,
118 group_id jtf_terr_number_list := jtf_terr_number_list() ,
119 role_id jtf_terr_number_list := jtf_terr_number_list() ,
120 role jtf_terr_char_360list := jtf_terr_char_360list() ,
121 full_access_flag jtf_terr_char_360list := jtf_terr_char_360list() ,
122 primary_contact_flag jtf_terr_char_360list := jtf_terr_char_360list() ,
123 resource_name jtf_terr_char_360list := jtf_terr_char_360list() ,
124 resource_job_title jtf_terr_char_360list := jtf_terr_char_360list() ,
125 resource_phone jtf_terr_char_360list := jtf_terr_char_360list() ,
126 resource_email jtf_terr_char_360list := jtf_terr_char_360list() ,
127 resource_mgr_name jtf_terr_char_360list := jtf_terr_char_360list() ,
128 resource_mgr_phone jtf_terr_char_360list := jtf_terr_char_360list() ,
129 resource_mgr_email jtf_terr_char_360list := jtf_terr_char_360list() ,
130 person_id jtf_terr_number_list := jtf_terr_number_list() ,
131 property1 jtf_terr_char_360list := jtf_terr_char_360list() ,
132 property2 jtf_terr_char_360list := jtf_terr_char_360list() ,
133 property3 jtf_terr_char_360list := jtf_terr_char_360list() ,
134 property4 jtf_terr_char_360list := jtf_terr_char_360list() ,
135 property5 jtf_terr_char_360list := jtf_terr_char_360list() ,
136 property6 jtf_terr_char_360list := jtf_terr_char_360list() ,
137 property7 jtf_terr_char_360list := jtf_terr_char_360list() ,
138 property8 jtf_terr_char_360list := jtf_terr_char_360list() ,
139 property9 jtf_terr_char_360list := jtf_terr_char_360list() ,
140 property10 jtf_terr_char_360list := jtf_terr_char_360list() ,
141 property11 jtf_terr_char_360list := jtf_terr_char_360list() ,
142 property12 jtf_terr_char_360list := jtf_terr_char_360list() ,
143 property13 jtf_terr_char_360list := jtf_terr_char_360list() ,
144 property14 jtf_terr_char_360list := jtf_terr_char_360list() ,
145 property15 jtf_terr_char_360list := jtf_terr_char_360list() ,
146
147 -- decsriptive flexfields for territory
148 terr_attr_category jtf_terr_char_360list := jtf_terr_char_360list() ,
149 terr_attribute1 jtf_terr_char_360list := jtf_terr_char_360list() ,
150 terr_attribute2 jtf_terr_char_360list := jtf_terr_char_360list() ,
151 terr_attribute3 jtf_terr_char_360list := jtf_terr_char_360list() ,
152 terr_attribute4 jtf_terr_char_360list := jtf_terr_char_360list() ,
153 terr_attribute5 jtf_terr_char_360list := jtf_terr_char_360list() ,
154 terr_attribute6 jtf_terr_char_360list := jtf_terr_char_360list() ,
155 terr_attribute7 jtf_terr_char_360list := jtf_terr_char_360list() ,
156 terr_attribute8 jtf_terr_char_360list := jtf_terr_char_360list() ,
157 terr_attribute9 jtf_terr_char_360list := jtf_terr_char_360list() ,
158 terr_attribute10 jtf_terr_char_360list := jtf_terr_char_360list() ,
159 terr_attribute11 jtf_terr_char_360list := jtf_terr_char_360list() ,
160 terr_attribute12 jtf_terr_char_360list := jtf_terr_char_360list() ,
161 terr_attribute13 jtf_terr_char_360list := jtf_terr_char_360list() ,
162 terr_attribute14 jtf_terr_char_360list := jtf_terr_char_360list() ,
163 terr_attribute15 jtf_terr_char_360list := jtf_terr_char_360list() ,
164
165 -- decsriptive flexfields for resource
166 rsc_attr_category jtf_terr_char_360list := jtf_terr_char_360list() ,
167 rsc_attribute1 jtf_terr_char_360list := jtf_terr_char_360list() ,
168 rsc_attribute2 jtf_terr_char_360list := jtf_terr_char_360list() ,
169 rsc_attribute3 jtf_terr_char_360list := jtf_terr_char_360list() ,
170 rsc_attribute4 jtf_terr_char_360list := jtf_terr_char_360list() ,
171 rsc_attribute5 jtf_terr_char_360list := jtf_terr_char_360list() ,
172 rsc_attribute6 jtf_terr_char_360list := jtf_terr_char_360list() ,
173 rsc_attribute7 jtf_terr_char_360list := jtf_terr_char_360list() ,
174 rsc_attribute8 jtf_terr_char_360list := jtf_terr_char_360list() ,
175 rsc_attribute9 jtf_terr_char_360list := jtf_terr_char_360list() ,
176 rsc_attribute10 jtf_terr_char_360list := jtf_terr_char_360list() ,
177 rsc_attribute11 jtf_terr_char_360list := jtf_terr_char_360list() ,
178 rsc_attribute12 jtf_terr_char_360list := jtf_terr_char_360list() ,
179 rsc_attribute13 jtf_terr_char_360list := jtf_terr_char_360list() ,
180 rsc_attribute14 jtf_terr_char_360list := jtf_terr_char_360list() ,
181 rsc_attribute15 jtf_terr_char_360list := jtf_terr_char_360list()
182
183 ); -- end bulk_winners_rec_type
184
185 G_MISS_BULK_WINNERS_REC bulk_winners_rec_type;
186
187 -- ***************************************************
188 -- API Specifications
189 -- ***************************************************
190 -- api name : Get_Winners
191 -- type : public.
192 -- function : For all Real Time Territory Assignment request purposes.
193 -- pre-reqs : Territories needs to be setup first
194 -- notes : Generic public API for retreving any of the following
195 -- * Winning Resource Id's
196 -- * Winning Resource Names + Details
197 -- * Winning terr_id's
198 --
199 PROCEDURE get_winners
200 ( p_api_version_number IN NUMBER := 1,
201 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
202 p_source_id IN NUMBER,
203 p_trans_id IN NUMBER,
204 p_mode IN VARCHAR2,
205 p_param_passing_mechanism IN VARCHAR2,
206 p_program_name IN VARCHAR2,
207 p_trans_rec IN bulk_trans_id_type := G_MISS_BULK_TRANS_ID,
208 p_name_value_pair IN bulk_name_value_pair_type := G_MISS_BULK_NAME_VALUE_PAIR,
209 p_role IN VARCHAR2 := NULL,
210 p_resource_type IN VARCHAR2 := NULL,
214 x_winners_rec OUT NOCOPY bulk_winners_rec_type
211 x_return_status OUT NOCOPY VARCHAR2,
212 x_msg_count OUT NOCOPY NUMBER,
213 x_msg_data OUT NOCOPY VARCHAR2,
215 );
216
217 -- ***************************************************
218 -- API Specifications
219 -- ***************************************************
220 -- api name : Process_match
221 -- type : public.
222 -- function : Called from 11.5.10 real time APIs
223 -- pre-reqs : Territories needs to be setup first
224 -- notes : Not to be called by product team
225 --
226 PROCEDURE process_match
227 ( p_source_id IN NUMBER,
228 p_trans_id IN NUMBER,
229 p_mode IN VARCHAR2,
230 p_program_name IN VARCHAR2,
231 x_return_status OUT NOCOPY VARCHAR2,
235
232 x_msg_count OUT NOCOPY NUMBER,
233 x_msg_data OUT NOCOPY VARCHAR2
234 );
236 -- ***************************************************
237 -- API Specifications
238 -- ***************************************************
239 -- api name : Process_Winners
240 -- type : public.
241 -- function : Called from 11.5.10 real time APIs
242 -- pre-reqs : Territories needs to be setup first
243 -- notes : Not to be called by product team
244 --
245 PROCEDURE process_winners
246 ( p_source_id IN NUMBER,
247 p_trans_id IN NUMBER,
248 p_program_name IN VARCHAR2,
252 p_plan_start_date IN DATE DEFAULT NULL,
249 p_mode IN VARCHAR2,
250 p_role IN VARCHAR2,
251 p_resource_type IN VARCHAR2,
253 p_plan_end_date IN DATE DEFAULT NULL,
254 x_return_status OUT NOCOPY VARCHAR2,
258 );
255 x_msg_count OUT NOCOPY NUMBER,
256 x_msg_data OUT NOCOPY VARCHAR2,
257 x_winners_rec OUT NOCOPY bulk_winners_rec_type
259
260 END JTY_ASSIGN_REALTIME_PUB;