DBA Data[Home] [Help]

PACKAGE: APPS.MSC_WS_SCENARIO_MANAGEMENT

Source


1 PACKAGE MSC_WS_SCENARIO_MANAGEMENT AUTHID CURRENT_USER AS
2 /* $Header: MSCWSMAS.pls 120.7 2008/03/12 12:00:08 bnaghi noship $ */
3 
4 -- =============================================================
5 -- Desc: Qurery msc_planning_process table and returns.
6 --       ProcessName
7 --       ProcessFlowId
8 --       CurrRunSequence
9 --
10 -- Input:
11 --        UserId             User ID.
12 --        ResponsibilityId   Responsibility Id.
13 --        ProcessId          Process Id.
14 --
15 -- Output: The possible return statuses are:
16 --          SUCCESS if everything is ok
17 --          NO_DATA_FOUND
18 --          INVALID_FND_USERID
19 --          INVALID_FND_RESPONSIBILITYID
20 -- =============================================================
21 PROCEDURE GET_PROCESS_INFO(
22         Status             OUT NOCOPY VARCHAR2,
23         ProcessName        OUT NOCOPY VARCHAR2,
24         ProcessFlowId      OUT NOCOPY NUMBER,
25         CurrRunSequence    OUT NOCOPY NUMBER,
26         UserId             IN         NUMBER,
27         ResponsibilityId   IN         NUMBER,
28         ProcessId          IN         NUMBER
29         );
30 
31  -- =============================================================
32 -- Desc: Qurery msc_planning_process table and returns.
33 --       ProcessName
34 --       ProcessFlowId
35 --       CurrRunSequence
36 --
37 -- Input:
38 --        UserName              User Name.
39 --        RespName   		Responsibility name.
40 --        RespApplName          Resp application name
41 --        SecurityGroupName     Security group name
42 --        Language
43 --        ProcessId          Process Id.
44 --
45 -- Output: The possible return statuses are:
46 --          SUCCESS if everything is ok
47 --          NO_DATA_FOUND
48 --          INVALID_USER_NAME, INVALID_RESP_NAME
49 --          INVALID_LANGUAGE, INVALID_SECUTITY_GROUP_NAME, INVALID_FUNC_NAME
50 -- =============================================================
51 
52  PROCEDURE GET_PROCESS_INFO_PUBLIC(
53         Status             OUT NOCOPY VARCHAR2,
54         ProcessName        OUT NOCOPY VARCHAR2,
55         ProcessFlowId      OUT NOCOPY NUMBER,
56         CurrRunSequence    OUT NOCOPY NUMBER,
57         UserName               IN VARCHAR2,
58 	RespName     IN VARCHAR2,
59 	RespApplName IN VARCHAR2,
60 	SecurityGroupName      IN VARCHAR2,
61 	Language            IN VARCHAR2,
62         ProcessId          IN         NUMBER
63         );
64 
65 -- =============================================================
66 -- Desc: Qurery msc_planning_proc_activities table and returns.
67 --       PlanId
68 --       Skip
69 --       Owner (Name)
70 --       Time_Out
71 --       Alternate_Owner (Name)
72 --       ActivityStatus
73 --       ActivityType.
74 --
75 -- Input:
76 --        UserId             User ID.
77 --        ResponsibilityId   Responsibility Id.
78 --        ProcessId          Process Id.
79 --        RunSequence        Run sequence.
80 --        ProcessScope       Activity name.
81 --
82 -- Output: The possible return statuses are:
83 --          SUCCESS if everything is ok
84 --          NO_DATA_FOUND
85 --          INVALID_FND_USERID
86 --          INVALID_FND_RESPONSIBILITYID
87 --          INVALID_MISSING_OWNER_ID
88 --          INVALID_UNKWON_OWNER_ID
89 --          INVALID_UNKWON_ALTERNATE_OWNER_ID
90 -- =============================================================
91 PROCEDURE GET_ACTIVITY_INST_INFO(
92         Status             OUT NOCOPY VARCHAR2,
93         PlanId             OUT NOCOPY NUMBER,
94         Skip               OUT NOCOPY VARCHAR2,
95         OwnerName          OUT NOCOPY VARCHAR2,
96         TimeOut            OUT NOCOPY NUMBER,
97         AlternateOwnerName OUT NOCOPY VARCHAR2,
98         ActivityStatus     OUT NOCOPY VARCHAR2,
99         ActivityType       OUT NOCOPY NUMBER,
100         UserId             IN         NUMBER,
101         ResponsibilityId   IN         NUMBER,
102         ProcessId          IN         NUMBER,
103         RunSequence        IN         NUMBER,
104         ProcessScope       IN         VARCHAR2
105         );
106 
107 -- =============================================================
108 -- Desc: Qurery msc_planning_proc_activities table and returns.
109 --       PlanId
110 --       Skip
111 --       Owner (Name)
112 --       Time_Out
113 --       Alternate_Owner (Name)
114 --       ActivityStatus
115 --       ActivityType.
116 --
117 -- Input:
118 --        UserName              User Name.
119 --        RespName   		Responsibility name.
120 --        RespApplName          Resp application name
121 --        SecurityGroupName     Security group name
122 --        Language
123 --        ProcessId          Process Id.
124 --        RunSequence        Run sequence.
125 --        ProcessScope       Activity name.
126 --
127 -- Output: The possible return statuses are:
128 --          SUCCESS if everything is ok
129 --          NO_DATA_FOUND
130 --          INVALID_USER_NAME, INVALID_RESP_NAME
131 --          INVALID_LANGUAGE, INVALID_SECUTITY_GROUP_NAME, INVALID_FUNC_NAME
132 --          INVALID_MISSING_OWNER_ID
133 --          INVALID_UNKWON_OWNER_ID
134 --          INVALID_UNKWON_ALTERNATE_OWNER_ID
135 -- =============================================================
136 
137 PROCEDURE GET_ACTIVITY_INST_INFO_PUBLIC(
138         Status             OUT NOCOPY VARCHAR2,
139         PlanId             OUT NOCOPY NUMBER,
140         Skip               OUT NOCOPY VARCHAR2,
141         OwnerName          OUT NOCOPY VARCHAR2,
142         TimeOut            OUT NOCOPY NUMBER,
143         AlternateOwnerName OUT NOCOPY VARCHAR2,
144         ActivityStatus     OUT NOCOPY VARCHAR2,
145         ActivityType       OUT NOCOPY NUMBER,
146         UserName               IN VARCHAR2,
147 	RespName     IN VARCHAR2,
148 	RespApplName IN VARCHAR2,
149 	SecurityGroupName      IN VARCHAR2,
150 	Language            IN VARCHAR2,
151         ProcessId          IN         NUMBER,
152         RunSequence        IN         NUMBER,
153         ProcessScope       IN         VARCHAR2
154         );
155 
156 -- =============================================================
157 -- Desc: Update activity_status in msc_planning_proc_activities table.
158 -- Input:
159 --        UserId             User ID.
160 --        ResponsibilityId   Responsibility Id.
161 --        ProcessInstanceId  Process instance Id.
162 --        ProcessId          Process Id.
163 --        RunSequence        Run sequence.
164 --        ProcessScope       Activity name.
165 --        NewStatus          New activity status
166 --
167 -- Output: The possible return statuses are:
168 --          SUCCESS if everything is ok
169 --          NO_DATA_FOUND
170 --          INVALID_FND_USERID
171 --          INVALID_FND_RESPONSIBILITYID
172 --          INVALID_STATUS
173 -- =============================================================
174 PROCEDURE SET_ACTIVITY_INST_STATUS(
175         Status             OUT NOCOPY VARCHAR2,
176         UserId             IN         NUMBER,
177         ResponsibilityId   IN         NUMBER,
178         ProcessId          IN         NUMBER,
179         RunSequence        IN         NUMBER,
180         ProcessScope       IN         VARCHAR2,
181         NewStatus          IN         VARCHAR2
182         );
183 
184 
185 -- =============================================================
186 -- Desc: Update activity_status in msc_planning_proc_activities table.
187 -- Input:
188 --        UserName              User Name.
189 --        RespName   		Responsibility name.
190 --        RespApplName          Resp application name
191 --        SecurityGroupName     Security group name
192 --        Language
193 --        ProcessInstanceId  Process instance Id.
194 --        ProcessId          Process Id.
195 --        RunSequence        Run sequence.
196 --        ProcessScope       Activity name.
197 --        NewStatus          New activity status
198 --
199 -- Output: The possible return statuses are:
200 --          SUCCESS if everything is ok
201 --          NO_DATA_FOUND
202 --          INVALID_USER_NAME, INVALID_RESP_NAME
203 --          INVALID_LANGUAGE, INVALID_SECUTITY_GROUP_NAME, INVALID_FUNC_NAME
204 --          INVALID_STATUS
205 -- =============================================================
206 PROCEDURE SET_ACTIVITY_INST_ST_PUBLIC(
207         Status             	OUT NOCOPY VARCHAR2,
208         UserName               	IN VARCHAR2,
209 	RespName     		IN VARCHAR2,
210 	RespApplName 		IN VARCHAR2,
211 	SecurityGroupName       IN VARCHAR2,
212 	Language            	IN VARCHAR2,
213         ProcessId          	IN         NUMBER,
214         RunSequence        	IN         NUMBER,
215         ProcessScope       	IN         VARCHAR2,
216         NewStatus          	IN         VARCHAR2
217         );
218 
219 
220 -- =============================================================
221 -- Desc: Update msc_planning_process.curr_run_sequence and
222 --       msc_process_instances.actual_start_date.
223 -- Input:
224 --        UserId             User ID.
225 --        ResponsibilityId   Responsibility Id.
226 --        ProcessInstanceId  Process instance Id.
227 --        ProcessId          Process Id.
228 --        RunSequence        Run sequence.
229 --
230 -- Output: The possible return statuses are:
231 --          SUCCESS if everything is ok
232 --          NO_DATA_FOUND
233 --          INVALID_FND_USERID
234 --          INVALID_FND_RESPONSIBILITYID
235 -- =============================================================
236 PROCEDURE UPDATE_PROCESS(
237         Status             OUT NOCOPY VARCHAR2,
238         UserId             IN         NUMBER,
239         ResponsibilityId   IN         NUMBER,
240         ProcessId          IN         NUMBER,
241         RunSequence        IN         NUMBER
242         );
243 
244 -- =============================================================
245 -- Desc: Update msc_planning_process.curr_run_sequence and
246 --       msc_process_instances.actual_start_date.
247 -- Input:
248 --        UserName              User Name.
249 --        RespName   		Responsibility name.
250 --        RespApplName          Resp application name
251 --        SecurityGroupName     Security group name
252 --        Language
253 --        ProcessInstanceId  Process instance Id.
254 --        ProcessId          Process Id.
255 --        RunSequence        Run sequence.
256 --
257 -- Output: The possible return statuses are:
258 --          SUCCESS if everything is ok
259 --          NO_DATA_FOUND
260 --          INVALID_USER_NAME, INVALID_RESP_NAME
261 --          INVALID_LANGUAGE, INVALID_SECUTITY_GROUP_NAME, INVALID_FUNC_NAME
262 -- =============================================================
263 
264 PROCEDURE UPDATE_PROCESS_PUBLIC(
265         Status             OUT NOCOPY VARCHAR2,
266         UserName               IN VARCHAR2,
267 		   RespName     IN VARCHAR2,
268 		   RespApplName IN VARCHAR2,
269 		   SecurityGroupName      IN VARCHAR2,
270 		   Language            IN VARCHAR2,
271         ProcessId          IN         NUMBER,
272         RunSequence        IN         NUMBER
273         );
274 
275 
276 -- =============================================================
277 -- Desc: Get value for all parameters.
278 -- Input:
279 --        UserId             User ID.
280 --        ResponsibilityId   Responsibility Id.
281 --        ProcessId          Process Id.
282 --        RunSequence        Run sequence.
283 --        ProcessScope       Activity Name.
284 --
285 -- Output: The possible return statuses are:
286 --          SUCCESS if everything is ok
287 --          NO_DATA_FOUND
288 --          INVALID_FND_USERID
289 --          INVALID_FND_RESPONSIBILITYID
290 -- =============================================================
291 PROCEDURE GET_PARAMETER_VALUE(
292         Status             OUT NOCOPY VARCHAR2,
293         ParameterValues    OUT NOCOPY MscActivityParaTbl,
294         UserId             IN         NUMBER,
295         ResponsibilityId   IN         NUMBER,
296         ProcessId          IN         NUMBER,
297         RunSequence        IN         NUMBER,
298         ProcessScope       IN         VARCHAR2
299         );
300 
301  -- =============================================================
302 -- Desc: Get value for all parameters.
303 -- Input:
304 --        UserName              User Name.
305 --        RespName   		Responsibility name.
306 --        RespApplName          Resp application name
307 --        SecurityGroupName     Security group name
308 --        Language
309 --        ProcessId             Process Id.
310 --        RunSequence           Run sequence.
311 --        ProcessScope          Activity Name.
312 --
313 -- Output: The possible return statuses are:
314 --          SUCCESS if everything is ok
315 --          NO_DATA_FOUND
316 --          INVALID_USER_NAME, INVALID_RESP_NAME
317 --       INVALID_LANGUAGE, INVALID_SECUTITY_GROUP_NAME, INVALID_FUNC_NAME
318 -- =============================================================
319 PROCEDURE GET_PARAMETER_VALUE_PUBLIC(
320         Status             OUT NOCOPY VARCHAR2,
321         ParameterValues    OUT NOCOPY MscActivityParaTbl,
322         UserName               IN VARCHAR2,
323         RespName     IN VARCHAR2,
324 	RespApplName IN VARCHAR2,
325 	SecurityGroupName      IN VARCHAR2,
326 	Language            IN VARCHAR2,
327         ProcessId          IN         NUMBER,
328         RunSequence        IN         NUMBER,
329         ProcessScope       IN         VARCHAR2
330         );
331 
332 -- =============================================================
333 -- Desc: This procedure is invoked from web service to launch
334 --       the Archive Scenario concurrent program.  The input
335 --       parameters mirror the parameters for the concurrent program.
336 -- Input:
337 --        UserName          User name.
338 --        RespName          Responsibility name.
339 --        RespAppName       Responsibility application name.
340 --        SecurityGroupName Security group name.
341 --        Language          Language.
342 --        ScenarioId        Scenario Id.
343 --
344 -- Output: Procedure returns a status and conc program req id.
345 --       The possible return statuses are:
346 --          SUCCESS if everything is ok
347 --          ERROR_SUBMIT          failed to submit the concurrent program
348 --          ERROR_UNEXPECTED_#    unexpected error
349 --          INVALID_USER_NAME
350 --          INVALID_LANGUAGE
351 --          INVALID_RESP_NAME
352 --          INVALID_SECUTITY_GROUP_NAME
353 --          INVALID_FND_USERID
354 --          INVALID_FND_RESPONSIBILITYID
355 --          INVALID_SCENARIO_ID   invalid scenario id
356 -- =============================================================
357 PROCEDURE ARCHIVE_SCENARIO_PUBLIC(
358         ProcessId          OUT NOCOPY NUMBER,
359         Status             OUT NOCOPY VARCHAR2,
360         UserName           IN         VARCHAR2,
361         RespName           IN         VARCHAR2,
362         RespAppName        IN         VARCHAR2,
363         SecurityGroupName  IN         VARCHAR2,
364         Language           IN         VARCHAR2,
365         ScenarioId         IN         NUMBER
366         );
367 
368 END MSC_WS_SCENARIO_MANAGEMENT;
369