[Home] [Help]
PACKAGE: APPS.AHL_VWP_VISITS_PVT
Source
1 PACKAGE AHL_VWP_VISITS_PVT AS
2 /* $Header: AHLVVSTS.pls 120.1 2007/12/18 09:55:47 sowsubra ship $ */
3 -----------------------------------------------------------
4 -- PACKAGE
5 -- Ahl_VWP_Visit_Pvt
6 --
7 -- PURPOSE
8 -- This package specification is a Private API for managing
9 -- Planning --> Visit Work Package --> VISITS
10 -- related procedures in Complex Maintainance, Repair and Overhauling(CMRO).
11 --
12 -- It defines used pl/sql records and tables datatypes
13 --
14 -- Process_Visit (see below for specification)
15 -- Get_Visit_Details (see below for specification)
16 -- Create_Visit (see below for specification)
17 -- Update_Visit (see below for specification)
18 -- Delete_Visit (see below for specification)
19 -- Close_Visit (see below for specification)
20 --
21 -- NOTES
22 --
23 --
24 -- HISTORY
25 -- 29-APR-2002 SHBHANDA 11.5.9 Created.
26 -- 06-AUG-2003 SHBHANDA 11.5.10 Changes.
27 -----------------------------------------------------------
28
29 ---------------------------------------------------------------------
30 -- Define Record Types for record structures needed by the APIs --
31 ---------------------------------------------------------------------
32
33 -- Record type for visits
34 TYPE Visit_Rec_Type IS RECORD (
35 VISIT_ID NUMBER := NULL,
36 VISIT_NAME VARCHAR2(80) := NULL,
37 VISIT_NUMBER NUMBER := NULL,
38
39 OBJECT_VERSION_NUMBER NUMBER := NULL,
40 LAST_UPDATE_DATE DATE := NULL,
41 LAST_UPDATED_BY NUMBER := NULL,
42 CREATION_DATE DATE := NULL,
43 CREATED_BY NUMBER := NULL,
44 LAST_UPDATE_LOGIN NUMBER := NULL,
45
46 ORGANIZATION_ID NUMBER := NULL,
47 ORG_NAME VARCHAR2(240) := NULL,
48
49 DEPARTMENT_ID NUMBER := NULL,
50 DEPT_NAME VARCHAR2(240) := NULL,
51
52 SERVICE_REQUEST_ID NUMBER := NULL,
53 SERVICE_REQUEST_NUMBER VARCHAR2(80) := NULL,
54
55 SPACE_CATEGORY_CODE VARCHAR2(30) := NULL,
56 SPACE_CATEGORY_NAME VARCHAR2(80) := NULL,
57
58 START_DATE DATE := NULL,
59 START_HOUR NUMBER := NULL,
60 START_MIN NUMBER := NULL,
61
62 PLAN_END_DATE DATE := NULL,
63 PLAN_END_HOUR NUMBER := NULL,
64 PLAN_END_MIN NUMBER := NULL,
65
66 END_DATE DATE := NULL,
67 DUE_BY_DATE DATE := NULL,
68
69 VISIT_TYPE_CODE VARCHAR2(30) := NULL,
70 VISIT_TYPE_NAME VARCHAR2(80) := NULL,
71
72 STATUS_CODE VARCHAR2(30) := NULL,
73 STATUS_NAME VARCHAR2(80) := NULL,
74
75 SIMULATION_PLAN_ID NUMBER := NULL,
76 SIMULATION_PLAN_NAME VARCHAR2(80) := NULL,
77
78 ASSO_PRIMARY_VISIT_ID NUMBER := NULL,
79
80 UNIT_NAME VARCHAR2(80) := NULL,
81 ITEM_INSTANCE_ID NUMBER := NULL,
82 SERIAL_NUMBER VARCHAR2(30) := NULL,
83
84 INVENTORY_ITEM_ID NUMBER := NULL,
85 ITEM_ORGANIZATION_ID NUMBER := NULL,
86 ITEM_NAME VARCHAR2(40) := NULL,
87
88 SIMULATION_DELETE_FLAG VARCHAR2(1) := NULL,
89 TEMPLATE_FLAG VARCHAR2(1) := NULL,
90 OUT_OF_SYNC_FLAG VARCHAR2(1) := NULL,
91
92 PROJECT_FLAG VARCHAR2(30) := NULL,
93 PROJECT_FLAG_CODE VARCHAR2(30) := NULL,
94
95 PROJECT_ID NUMBER := NULL,
96 PROJECT_NUMBER NUMBER := NULL,
97
98 DESCRIPTION VARCHAR2(4000) := NULL,
99 DURATION NUMBER := NULL,
100
101 ATTRIBUTE_CATEGORY VARCHAR2(30) := NULL,
102 ATTRIBUTE1 VARCHAR2(150) := NULL,
103 ATTRIBUTE2 VARCHAR2(150) := NULL,
104 ATTRIBUTE3 VARCHAR2(150) := NULL,
105 ATTRIBUTE4 VARCHAR2(150) := NULL,
106 ATTRIBUTE5 VARCHAR2(150) := NULL,
107 ATTRIBUTE6 VARCHAR2(150) := NULL,
108 ATTRIBUTE7 VARCHAR2(150) := NULL,
109 ATTRIBUTE8 VARCHAR2(150) := NULL,
110 ATTRIBUTE9 VARCHAR2(150) := NULL,
111 ATTRIBUTE10 VARCHAR2(150) := NULL,
112 ATTRIBUTE11 VARCHAR2(150) := NULL,
113 ATTRIBUTE12 VARCHAR2(150) := NULL,
114 ATTRIBUTE13 VARCHAR2(150) := NULL,
115 ATTRIBUTE14 VARCHAR2(150) := NULL,
116 ATTRIBUTE15 VARCHAR2(150) := NULL,
117 OPERATION_FLAG VARCHAR2(1) := NULL,
118 OUTSIDE_PARTY_FLAG VARCHAR2(1) := NULL,
119 JOB_NUMBER VARCHAR2(255) := NULL,
120
121 -- Post 11.5.10 Enhancements
122 -- Added Priority and Project Template
123 PROJ_TEMPLATE_NAME VARCHAR2(30) := NULL,
124 PROJ_TEMPLATE_ID NUMBER := NULL,
125 PRIORITY_VALUE VARCHAR2(80) := NULL,
126 PRIORITY_CODE VARCHAR2(30) := NULL,
127 -- For Transit Check
128 UNIT_SCHEDULE_ID NUMBER := NULL,
129 VISIT_CREATE_TYPE VARCHAR2(30) := NULL,
130 VISIT_CREATE_MEANING VARCHAR2(80) := NULL,
131 UNIT_HEADER_ID NUMBER := NULL,
132
133 --Arvind Rupakula - Flight Number changes
134 FLIGHT_NUMBER VARCHAR2(30) := NULL,
135 --End
136
137 /*Added by sowsubra */
138 SUBINVENTORY VARCHAR2(10) := NULL,
139 LOCATOR_SEGMENT VARCHAR2(240) := NULL,
140 INV_LOCATOR_ID NUMBER := NULL
141 );
142
143 -- Record for UMP Requirement
144 TYPE Srch_UMP_Rec_Type IS RECORD (
145 ASSIGN_STATUS_MEANING VARCHAR2(80) := NULL,
146 ASSIGN_STATUS_CODE VARCHAR2(30) := NULL,
147 VISIT_NUMBER_MEANING VARCHAR2(80) := NULL,
148 VISIT_NUMBER_CODE VARCHAR2(30) := NULL,
149 VISIT_STATUS_MEANING VARCHAR2(80) := NULL,
150 VISIT_STATUS_CODE VARCHAR2(30) := NULL,
151 VISIT_START_DATE DATE := NULL,
152 VISIT_END_DATE DATE := NULL
153 );
154
155 -- Record for Error while Validating before cancelling the Visit.
156 -- Post 11.5.10
157 -- Reema Start
158 TYPE Error_Rec_Type IS RECORD (
159 JOB_ID NUMBER := NULL,
160 JOB_NUMBER VARCHAR2(40) := NULL,
161 SERVICE_REQUEST VARCHAR2(64) := NULL,
162 TASK_NUMBER VARCHAR2(80) := NULL,
163 PRIORITY VARCHAR2(80) := NULL,
164 SCHEDULED_START_DATE DATE := NULL,
165 SCHEDULED_END_DATE DATE := NULL,
166 JOB_STATUS VARCHAR2(80) := NULL
167 );
168 -- Reema End
169
170 ---------------------------------------------
171 -- Define Table Type for Records Structures --
172 ----------------------------------------------
173
174 -- Declare Visit table type for record
175 TYPE Visit_Tbl_Type IS TABLE OF Visit_Rec_Type
176 INDEX BY BINARY_INTEGER;
177
178 -- Declare Error table type for record
179 TYPE Error_Tbl_Type IS TABLE OF Error_Rec_Type
180 INDEX BY BINARY_INTEGER;
181
182 -------------------------------------------------------------------
183 -- Declare Procedures --
184 -------------------------------------------------------------------
185
186 /*
187
188 Commented out Jul-28-04 by yazhou
189 using AHL_UTIL_UC_PKG API instead
190
191 -- To find unit configuration name for a given item instance.
192 FUNCTION get_unitName (p_csi_item_instance_id IN NUMBER)
193 RETURN VARCHAR2;
194
195 */
196 --------------------------------------------------------------------
197 -- Procedure Name : Process_Visit
198 -- Type : Private
199 -- Function : To process a visit related attributes to create/update/delete the visit
200 -- Parameters :
201 --
202 -- Standard IN Parameters :
203 -- p_api_version IN NUMBER Required
204 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE
205 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
206 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
207 -- p_default IN VARCHAR2 Default FND_API.G_TRUE
208 -- p_module_type IN VARCHAR2 Default NULL.
209 --
210 -- Standard OUT Parameters :
211 -- x_return_status OUT VARCHAR2 Required
212 -- x_msg_count OUT NUMBER Required
213 -- x_msg_data OUT VARCHAR2 Required
214 --
215 -- Process_Visit Parameters:
216 -- p_x_Visit_tbl IN OUT AHL_VWP_VISITS_PVT.Visit_Tbl_Type Required
217 -- The table of visit records type for which DML operation is to be performed.
218 --
219 -- Version :
220 -- Initial Version 1.0
221 --------------------------------------------------------------------
222 PROCEDURE Process_Visit (
223 p_api_version IN NUMBER,
224 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
225 p_commit IN VARCHAR2 := FND_API.g_false,
226 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
227 p_module_type IN VARCHAR2 := 'JSP',
228 p_x_Visit_tbl IN OUT NOCOPY Visit_Tbl_Type,
229 x_return_status OUT NOCOPY VARCHAR2,
230 x_msg_count OUT NOCOPY NUMBER,
231 x_msg_data OUT NOCOPY VARCHAR2
232 );
233
234 ---------------------------------------------------------------------
235 -- Procedure name : Get_Visit_Details
236 -- Type : Private
237 -- Function : To get a visit details
238 -- Parameters :
239 --
240 -- Standard IN Parameters :
241 -- p_api_version IN NUMBER Required
242 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE
243 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
244 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
245 -- p_default IN VARCHAR2 Default FND_API.G_TRUE
246 -- p_module_type IN VARCHAR2 Default NULL.
247 --
248 -- Standard OUT Parameters :
249 -- x_return_status OUT VARCHAR2 Required
250 -- x_msg_count OUT NUMBER Required
251 -- x_msg_data OUT VARCHAR2 Required
252 --
253 -- Get_Visit_Details Parameters:
254 -- p_visit_id IN NUMBER Required
255 -- The visit id whose details are to be displayed
256 -- x_Visit_rec OUT AHL_VWP_VISITS_PVT.Visit_Rec_Type Required
257 -- The record of visit attributes whose details are to be displayed
258 --
259 -- Version :
260 -- Initial Version 1.0
261 -------------------------------------------------------------------
262 PROCEDURE Get_Visit_Details (
263 p_api_version IN NUMBER,
264 p_init_msg_list IN VARCHAR2 := Fnd_Api.g_false,
265 p_commit IN VARCHAR2 := Fnd_Api.g_false,
266 p_validation_level IN NUMBER := Fnd_Api.g_valid_level_full,
267 p_module_type IN VARCHAR2 := 'JSP',
268 p_visit_id IN NUMBER,
269 x_Visit_rec OUT NOCOPY Visit_Rec_Type,
270 x_return_status OUT NOCOPY VARCHAR2,
271 x_msg_count OUT NOCOPY NUMBER,
272 x_msg_data OUT NOCOPY VARCHAR2
273 );
274
275 /*
276 -------------------------------------------------------------------
277 -- Procedure name : UMP_Visit_Info (OBSOLETED)
278 -- Type : Private
279 -- Function : To derive UMP Visit Information
280 -- Parameters :
281 --
282 -- Standard IN Parameters :
283 -- p_api_version IN NUMBER Required
284 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE
285 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
286 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
287 -- p_default IN VARCHAR2 Default FND_API.G_TRUE
288 -- p_module_type IN VARCHAR2 Default NULL.
289 --
290 -- Standard OUT Parameters :
291 -- x_return_status OUT VARCHAR2 Required
292 -- x_msg_count OUT NUMBER Required
293 -- x_msg_data OUT VARCHAR2 Required
294 --
295 -- UMP_Visit_Info Parameters:
296 -- p_unit_effectivity IN NUMBER Required
297 -- The unit effectivity for which all visits and task displayed.
298 --
299 -- Version :
300 -- Initial Version 1.0
301 -------------------------------------------------------------------
302 PROCEDURE UMP_Visit_Info (
303 p_api_version IN NUMBER,
307 p_module_type IN VARCHAR2 := Null,
304 p_init_msg_list IN VARCHAR2 := Fnd_Api.g_false,
305 p_commit IN VARCHAR2 := Fnd_Api.g_false,
306 p_validation_level IN NUMBER := Fnd_Api.g_valid_level_full,
308 p_unit_effectivity_id IN NUMBER,
309
310 x_ump_visit_rec OUT NOCOPY Srch_UMP_Rec_Type,
311 x_return_status OUT NOCOPY VARCHAR2,
312 x_msg_count OUT NOCOPY NUMBER,
313 x_msg_data OUT NOCOPY VARCHAR2
314 );
315 */
316 -------------------------------------------------------------------
317 -- Procedure name : Close_Visit
318 -- Type : Private
319 -- Function : To close a particular visit
320 -- Parameters :
321 --
322 -- Standard IN Parameters :
323 -- p_api_version IN NUMBER Required
324 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE
325 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
326 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
327 -- p_default IN VARCHAR2 Default FND_API.G_TRUE
328 -- p_module_type IN VARCHAR2 Default NULL.
329 --
330 -- Standard OUT Parameters :
331 -- x_return_status OUT VARCHAR2 Required
332 -- x_msg_count OUT NUMBER Required
333 -- x_msg_data OUT VARCHAR2 Required
334 --
335 -- Close_Visit Parameters:
336 -- p_visit_id IN NUMBER Required
337 -- The visit id which is going to be Closed.
338 --
339 -- Version :
340 -- Initial Version 1.0
341 -- Added by Srini p_x_cost_session, p_x_mr_session to support costing functionality
342 -------------------------------------------------------------------
343 PROCEDURE Close_Visit(
344 p_api_version IN NUMBER,
345 p_init_msg_list IN VARCHAR2 := Fnd_Api.g_false,
346 p_commit IN VARCHAR2 := Fnd_Api.g_false,
347 p_validation_level IN NUMBER := Fnd_Api.g_valid_level_full,
348 p_module_type IN VARCHAR2 := Null,
349 p_visit_id IN NUMBER,
350 p_x_cost_session_id IN OUT NOCOPY NUMBER,
351 p_x_mr_session_id IN OUT NOCOPY NUMBER,
352 x_return_status OUT NOCOPY VARCHAR2,
353 x_msg_count OUT NOCOPY NUMBER,
354 x_msg_data OUT NOCOPY VARCHAR2
355 );
356
357 -- Post 11.5.10
358 -- Reema Start
359 -------------------------------------------------------------------
360 -- Procedure name : Cancel_Visit
361 -- Type : Private
362 -- Function : To cancel a particular visit
363 -- Parameters :
364 --
365 -- Standard IN Parameters :
366 -- p_api_version IN NUMBER Required
367 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE
368 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
369 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
370 -- p_default IN VARCHAR2 Default FND_API.G_TRUE
371 -- p_module_type IN VARCHAR2 Default NULL.
372 --
373 -- Standard OUT Parameters :
374 -- x_return_status OUT VARCHAR2 Required
375 -- x_msg_count OUT NUMBER Required
376 -- x_msg_data OUT VARCHAR2 Required
377 --
378 -- Cancel_Visit Parameters:
379 -- p_visit_id IN NUMBER Required
380 -- The visit id which is going to be cancelled.
381 -- x_error_flag OUT VARCHAR2 Required
382 -- The boolean flag keeps track of Unreleased jobs.
383 --
384 -- Version :
385 -- Initial Version 1.0
386 -------------------------------------------------------------------
387 PROCEDURE Cancel_Visit(
388 p_api_version IN NUMBER := 1.0,
389 p_init_msg_list IN VARCHAR2 := Fnd_Api.g_false,
390 p_commit IN VARCHAR2 := Fnd_Api.g_false,
391 p_validation_level IN NUMBER := Fnd_Api.g_valid_level_full,
392 p_module_type IN VARCHAR2 := Null,
393 p_visit_id IN NUMBER,
394 p_obj_ver_num IN NUMBER,
395 x_return_status OUT NOCOPY VARCHAR2,
396 x_msg_count OUT NOCOPY NUMBER,
397 x_msg_data OUT NOCOPY VARCHAR2
398 );
399 -- Reema End
400
401 -- pbarman begin
402 -------------------------------------------------------------------
403 -- Procedure name : DELETE_FLIGHT_ASSOC
404 -- Type : Private
405 -- Function : to delete the Unit Schedule Id from Visits records
406 -- when the Flight schedule is deleted.
407 -- Parameters :
408 --
409 -- Standard IN Parameters :
410 --
411 -- Standard OUT Parameters :
412 -- x_return_status OUT VARCHAR2 Required
413 --
414 -- UMP_Visit_Info Parameters:
415 -- p_unit_effectivity IN NUMBER Required
416 -- The unit effectivity for which all visits and task displayed.
417 --
418 -- Version :
419 -- Initial Version 1.0
420 -------------------------------------------------------------------
421 -- procedure to delete the Unit Schedule Id from Visits records
422 --when the Flight schedule is deleted.
423
424 PROCEDURE DELETE_FLIGHT_ASSOC(
425 p_unit_schedule_id IN NUMBER,
426 x_return_status OUT NOCOPY VARCHAR2
427 );
428 -- pbarman end
429
430 END AHL_VWP_VISITS_PVT;
431