1 PACKAGE AHL_VWP_VISITS_STAGES_PVT AS
2 /* $Header: AHLVSTGS.pls 120.0 2005/05/26 00:01:23 appldev noship $ */
3 -----------------------------------------------------------
4 -- PACKAGE
5 -- AHL_VWP_VISITS_STAGES_PVT
6 --
7 -- PURPOSE
8 -- This package specification is a Private API for managing
9 -- Planning --> Visit Work Package --> VISITS --> STAGES
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 -- Copy_Visit (see below for specification)
18 -- Update_Visit (see below for specification)
19 -- Delete_Visit (see below for specification)
20 -- UMP_Visit_Info (see below for specification)
21 -- Close_Visit (see below for specification)
22 --
23 -- NOTES
24 --
25 --
26 -- HISTORY
27 -- 04-FEB-2004 ADHARIA POST 11.5.10 Created.
28 -----------------------------------------------------------
29
30 ---------------------------------------------------------------------
31 -- Define Record Types for record structures needed by the APIs --
32 ---------------------------------------------------------------------
33
34 -- Record type for visit stages
35 TYPE Visit_Stages_Rec_Type IS RECORD (
36 Stage_Id NUMBER,
37 Stage_Num NUMBER,
38 Stage_Name VARCHAR2(80):= NULL,
39 Duration NUMBER:= NULL,
40 Stage_Planned_Start_Time DATE:= NULL,
41 Stage_Planned_End_Time DATE:= NULL,
42 Stage_Actual_End_Time DATE:= NULL,
43 OBJECT_VERSION_NUMBER NUMBER := NULL,
44
45 ATTRIBUTE_CATEGORY VARCHAR2(30) := NULL,
46 ATTRIBUTE1 VARCHAR2(150) := NULL,
47 ATTRIBUTE2 VARCHAR2(150) := NULL,
48 ATTRIBUTE3 VARCHAR2(150) := NULL,
49 ATTRIBUTE4 VARCHAR2(150) := NULL,
50 ATTRIBUTE5 VARCHAR2(150) := NULL,
51 ATTRIBUTE6 VARCHAR2(150) := NULL,
52 ATTRIBUTE7 VARCHAR2(150) := NULL,
53 ATTRIBUTE8 VARCHAR2(150) := NULL,
54 ATTRIBUTE9 VARCHAR2(150) := NULL,
55 ATTRIBUTE10 VARCHAR2(150) := NULL,
56 ATTRIBUTE11 VARCHAR2(150) := NULL,
57 ATTRIBUTE12 VARCHAR2(150) := NULL,
58 ATTRIBUTE13 VARCHAR2(150) := NULL,
59 ATTRIBUTE14 VARCHAR2(150) := NULL,
60 ATTRIBUTE15 VARCHAR2(150) := NULL
61 );
62
63 TYPE Visit_Stages_Times_Rec_Type IS RECORD (
64 STAGE_ID NUMBER := NULL, -- Id of the visit's task stage
65 Stage_Num NUMBER,
66 Stage_Name VARCHAR2(80):= NULL,
67 Duration NUMBER:= NULL,
68
69 stage_START_HOUR NUMBER := NULL, -- Normalized start hour for this stage (w.r.t visit)
70 stage_END_HOUR NUMBER := NULL, -- Normalized end hour for this stage
71 PLANNED_START_TIME DATE:= NULL,
72 Planned_End_Time DATE:= NULL,
73 Actual_End_Time DATE:= NULL
74 );
75
76
77 ---------------------------------------------
78 -- Define Table Type for Rwecords Structures --
79 ----------------------------------------------
80
81 -- Declare Visit table type for record
82 TYPE Visit_Stages_Tbl_Type IS TABLE OF Visit_Stages_Rec_Type
83 INDEX BY BINARY_INTEGER;
84
85
86 TYPE Visit_Stages_Times_Tbl_Type IS TABLE OF Visit_Stages_Times_Rec_Type
87 INDEX BY BINARY_INTEGER;
88
89 -------------------------------------------------------------------
90 -- Declare Procedures --
91 -------------------------------------------------------------------
92
93 --------------------------------------------------------------------
94 -- Procedure Name : Update_Stages
95 -- Type : Public
96 -- Function : To update a visit stages related attributes to update the visit
97 -- Parameters :
98 --
99 -- Standard IN Parameters :
100 -- p_api_version IN NUMBER Required
101 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE
102 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
103 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
104 -- p_default IN VARCHAR2 Default FND_API.G_TRUE
105 -- p_module_type IN VARCHAR2 Default NULL.
106 --
107 -- Standard OUT Parameters :
108 -- x_return_status OUT VARCHAR2 Required
109 -- x_msg_count OUT NUMBER Required
110 -- x_msg_data OUT VARCHAR2 Required
111 --
112 -- Process_Visit Parameters:
113 -- p_visit_id IN NUMBER Required
114 -- p_x_Visit_Stages_tbl IN OUT AHL_VWP_VISITS_STAGES_PVT.Visit_Tbl_Type Required
115 -- The table of visit records type for which Update operation is to be performed.
116 --
117 -- Version :
118 -- Initial Version 1.0
119 --------------------------------------------------------------------
120 PROCEDURE Update_Stages (
121 p_api_version IN NUMBER :=1.0,
122 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
123 p_commit IN VARCHAR2 := FND_API.g_false,
124 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
125 p_module_type IN VARCHAR2 := 'JSP',
126 p_visit_id IN NUMBER,
127 p_x_stages_tbl IN OUT NOCOPY Visit_Stages_Tbl_Type,
128 x_return_status OUT NOCOPY VARCHAR2,
129 x_msg_count OUT NOCOPY NUMBER,
130 x_msg_data OUT NOCOPY VARCHAR2
131 );
132
133 ---------------------------------------------------------------------
134 -- Procedure name : Get_Stages_Details
135 -- Type : Public
136 -- Function : To get a visit stage details
137 -- Parameters :
138 --
139 -- Standard IN Parameters :
140 -- p_api_version IN NUMBER Required
141 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE
142 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
143 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
144 -- p_default IN VARCHAR2 Default FND_API.G_TRUE
145 -- p_module_type IN VARCHAR2 Default NULL.
146 --
147 -- Standard OUT Parameters :
148 -- x_return_status OUT VARCHAR2 Required
149 -- x_msg_count OUT NUMBER Required
150 -- x_msg_data OUT VARCHAR2 Required
151 --
152 -- Get_Visit_Details Parameters:
153 -- p_visit_id IN NUMBER Required
154 -- The visit id whose details are to be displayed
155 -- x_Visit_rec OUT AHL_VWP_VISITS_PVT.Visit_Rec_Type Required
156 -- The record of visit attributes whose details are to be displayed
157 --
158 -- Version :
159 -- Initial Version 1.0
160 -------------------------------------------------------------------
161 PROCEDURE Get_Stages_Details (
162 p_api_version IN NUMBER,
163 p_init_msg_list IN VARCHAR2 := Fnd_Api.g_false,
164 p_commit IN VARCHAR2 := Fnd_Api.g_false,
165 p_validation_level IN NUMBER := Fnd_Api.g_valid_level_full,
166 p_module_type IN VARCHAR2 := 'JSP',
167 p_visit_id IN NUMBER,
168 p_start_row IN NUMBER,
169 p_rows_per_page IN NUMBER,
170
171 x_Stages_Tbl OUT NOCOPY Visit_Stages_Tbl_Type,
172 x_row_count OUT NOCOPY NUMBER,
173
174 x_return_status OUT NOCOPY VARCHAR2,
175 x_msg_count OUT NOCOPY NUMBER,
176 x_msg_data OUT NOCOPY VARCHAR2
177 );
178
179 --------------------------------------------------------------------
180 -- Procedure Name : Create_Stages
181 -- Type : Public
182 -- Function : To create a visit stages related attributes to update the visit
183 -- Parameters :
184 --
185 -- Standard IN Parameters :
186 -- p_api_version IN NUMBER Required
187 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE
188 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
189 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
190 -- p_default IN VARCHAR2 Default FND_API.G_TRUE
191 -- p_module_type IN VARCHAR2 Default NULL.
192 --
193 -- Standard OUT Parameters :
194 -- x_return_status OUT VARCHAR2 Required
195 -- x_msg_count OUT NUMBER Required
196 -- x_msg_data OUT VARCHAR2 Required
197 --
198 -- Process_Visit Parameters:
199 -- p_visit_id IN NUMBER Required
200 -- The visit id for which to create the stages
201 --
202 -- Version :
203 -- Initial Version 1.0
204 --------------------------------------------------------------------
205 PROCEDURE Create_Stages (
206 p_api_version IN NUMBER :=1.0,
207 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
208 p_commit IN VARCHAR2 := FND_API.g_false,
209 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
210 p_module_type IN VARCHAR2 := 'JSP',
211 p_visit_id IN NUMBER,
212 x_return_status OUT NOCOPY VARCHAR2,
213 x_msg_count OUT NOCOPY NUMBER,
214 x_msg_data OUT NOCOPY VARCHAR2
215 );
216
217
218 --------------------------------------------------------------------
219 -- PROCEDURE
220 -- Delete_Stages
221 --
222 -- PURPOSE
223 -- To delete a Stage for visit.
224 -- will be called from delete visit and requires only visit_id
225 --------------------------------------------------------------------
226 PROCEDURE Delete_Stages (
227 p_api_version IN NUMBER,
228 p_init_msg_list IN VARCHAR2 := Fnd_Api.g_false,
229 p_commit IN VARCHAR2 := Fnd_Api.g_false,
230 p_validation_level IN NUMBER := Fnd_Api.g_valid_level_full,
231 p_module_type IN VARCHAR2 := 'JSP',
232
233 p_visit_id IN NUMBER,
234
235 x_return_status OUT NOCOPY VARCHAR2,
236 x_msg_count OUT NOCOPY NUMBER,
237 x_msg_data OUT NOCOPY VARCHAR2
238 );
239
240 --------------------------------------------------------------------
241 -- Procedure Name : Validate_stage_update
242 -- Type : Public
243 -- Function : To validate the update of task stages.
244 -- Parameters :
245 --
246 -- Standard IN Parameters :
247 -- p_api_version IN NUMBER Required
248 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE
249 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
250 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
251 -- p_default IN VARCHAR2 Default FND_API.G_TRUE
252 -- p_module_type IN VARCHAR2 Default NULL.
253 --
254 -- Standard OUT Parameters :
255 -- x_return_status OUT VARCHAR2 Required
256 -- x_msg_count OUT NUMBER Required
257 -- x_msg_data OUT VARCHAR2 Required
258 --
259 -- Process_Visit Parameters:
260 -- p_visit_id IN NUMBER Required
261 -- The visit id for which to create the stages
262 --
263 -- Version :
264 -- Initial Version 1.0
265 --------------------------------------------------------------------
266 PROCEDURE VALIDATE_STAGE_UPDATES(
267 p_api_version IN NUMBER,
268 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
269 p_commit IN VARCHAR2 := Fnd_Api.G_FALSE,
270 p_validation_level IN NUMBER := Fnd_Api.G_VALID_LEVEL_FULL,
271 p_default IN VARCHAR2 := Fnd_Api.G_TRUE,
272 p_module_type IN VARCHAR2 := NULL,
273
274 p_visit_id IN NUMBER,
275 p_visit_task_id IN NUMBER,
276 p_stage_name IN VARCHAR2 := NULL, -- defaulted as u may pass id or num
277
278 x_stage_id OUT NOCOPY NUMBER ,
279 x_return_status OUT NOCOPY VARCHAR2,
280 x_msg_count OUT NOCOPY NUMBER,
281 x_msg_data OUT NOCOPY VARCHAR2
282 );
283
284 --------------------------------------------------------------------
285 -- Procedure name : Check_Stage_Name_Or_Id
286 -- Type : Private
287 -- Function : Stage Number to ID conversion
288 -- Parameters :
289 --
290 -- IN Parameters :
291 -- p_visit_id IN NUMBER
292 -- p_Stage_Num IN NUMBER
293
294
295 -- OUT Parameters :
296 -- x_Stage_id OUT NOCOPY NUMBER
297 -- x_return_status OUT NOCOPY VARCHAR2
298 -- x_error_msg_code OUT NOCOPY VARCHAR2
299
300 -- Version :
301 -- Initial Version 1.0
302 --------------------------------------------------------------------
303 PROCEDURE Check_Stage_Name_Or_Id
304 (p_visit_id IN NUMBER,
305 p_Stage_Name IN VARCHAR2,
306 x_Stage_id OUT NOCOPY NUMBER,
307 x_return_status OUT NOCOPY VARCHAR2,
308 x_error_msg_code OUT NOCOPY VARCHAR2
309 );
310
311
312 END AHL_VWP_VISITS_STAGES_PVT;
313
[Home] [Help]