1 package WF_EVENT_HTML as
2 /* $Header: wfehtms.pls 120.2 2005/09/01 09:54:18 aiqbal ship $ */
3
4 --
5 -- Types
6 --
7
8 -- hex representation of guid identifiers from web page
9 type hguid_array is table of varchar2(32) index by binary_integer;
10
11 --
12 -- isDeletable
13 -- Find out if a particular entity is deletable or not
14 -- IN
15 -- x_guid - global unique id for that entity
16 -- x_type - type of such entity 'EVENT|GROUP|SYSTEM|AGENT|SUBSCRIP'
17 -- RET
18 -- True if it is ok to delete.
19 -- False otherwise.
20 --
21 function isDeletable (
22 x_guid in raw,
23 x_type in varchar2
24 ) return boolean;
25
26 -- isAccessible
27 -- Determines if a screen is accessible depending on data
28 -- IN
29 -- x_type - SYSTEM, AGENTS, EVENTS, SUBSCRIPTIONS
30 --
31 procedure isAccessible (
32 x_type in varchar2
33 );
34
35 --
36 -- ListEvents
37 -- List events
38 -- NOTE
39 --
40 procedure ListEvents (
41 h_display_name in varchar2 default null,
42 h_name in varchar2 default null,
43 h_status in varchar2 default '*',
44 h_type in varchar2 default '*',
45 resetcookie in varchar2 default 'F'
46 );
47
48 --
49 -- ListSystems
50 -- List systems
51 -- NOTE
52 --
53 procedure ListSystems (
54 h_display_name in varchar2 default null,
55 h_name in varchar2 default null,
56 display_master in varchar2 default null,
57 h_master_guid in varchar2 default null,
58 resetcookie in varchar2 default 'F'
59 );
60
61 --
62 -- ListAgents
63 -- List agents
64 -- NOTE
65 --
66 procedure ListAgents (
67 h_name in varchar2 default null,
68 h_protocol in varchar2 default null,
69 h_address in varchar2 default null,
70 display_system in varchar2 default null,
71 h_system_guid in varchar2 default null,
72 h_direction in varchar2 default '*',
73 h_status in varchar2 default '*',
74 use_guid_only in varchar2 default 'F',
75 resetcookie in varchar2 default 'F'
76 );
77
78 --
79 -- ListSubscriptions
80 -- List subscriptions
81 -- NOTE
82 --
83 procedure ListSubscriptions (
84 display_event in varchar2 default null,
85 h_event_guid in varchar2 default null,
86 h_source_type in varchar2 default '*',
87 display_system in varchar2 default null,
88 h_system_guid in varchar2 default null,
89 h_status in varchar2 default '*',
90 use_guid_only in varchar2 default 'F',
91 resetcookie in varchar2 default 'F'
92 );
93
94 --
95 -- EditEvent
96 -- Create/Update an event
97 -- IN
98 -- h_guid - Global unique id for an event
99 -- NOTE
100 --
101 procedure EditEvent(
102 h_guid in raw default null,
103 h_type in varchar2 default 'EVENT'
104 );
105
106 --
107 -- EditGroup
108 -- Delete/Add events from/to group
109 -- IN
110 -- h_guid - Global unique id for an event
111 -- h_func - DELETE|ADD
112 -- NOTE
113 --
114 procedure EditGroup(
115 h_guid in raw,
116 h_func in varchar2 default 'DELETE',
117 h_display_name in varchar2 default null,
118 h_name in varchar2 default null,
119 h_status in varchar2 default '*',
120 h_type in varchar2 default '*'
121 );
122
123 --
124 -- EditSystem
125 -- Create/Update an event
126 -- IN
127 -- h_guid - Global unique id for a system
128 -- NOTE
129 --
130 procedure EditSystem(
131 h_guid in raw default null);
132
133 --
134 -- EditAgent
135 -- Create/Update an agent
136 -- IN
137 -- h_guid - Global unique id for an agent
138 -- NOTE
139 --
140 procedure EditAgent(
141 h_guid in raw default null);
142
143 --
144 -- EditSubscription
145 -- Create/Update a subscription
146 -- IN
147 -- h_guid - Global unique id for a subscription
148 -- NOTE
149 --
150 procedure EditSubscription(
151 h_guid in raw default null,
152 h_sguid in raw default null,
153 h_eguid in raw default null);
154
155 --
156 -- SubmitEvent
157 -- Submit an event to database
158 -- IN
159 -- h_guids - Global unique id for an event (2nd element)
160 -- h_name - Event name
161 -- h_type - Event type: EVENT|GROUP
162 -- h_status - Event status: ENABLED|DISABLED
163 -- h_generate_function - Event function
164 -- h_owner_name
165 -- h_owner_tag
166 -- h_display_name
167 -- h_description
168 -- h_custom_level
169 -- NOTE
170 --
171 procedure SubmitEvent(
172 h_guid in varchar2,
173 h_name in varchar2,
174 h_display_name in varchar2,
175 h_description in varchar2,
176 h_type in varchar2,
177 h_status in varchar2,
178 h_generate_function in varchar2,
179 h_owner_name in varchar2,
180 h_owner_tag in varchar2,
181 h_custom_level in varchar2,
182 url in varchar2);
183
184 --
185 -- SubmitSelectedGEvents
186 -- Process selected events from group for deletion or addition
187 -- IN
188 -- h_gguid - Global unique id for the group event
189 -- h_guids - Array of global unique id of events
190 -- action - DELETE|ADD|FIND
191 -- NOTE
192 --
193 procedure SubmitSelectedGEvents(
194 h_gguid in raw,
195 h_guids in hguid_array,
196 action in varchar2,
197 url in varchar2);
198
199 --
200 -- SubmitSystem
201 -- Submit an system to database
202 -- IN
203 -- h_guid - Global unique id for system
204 -- h_name - System name
205 -- h_display_name
206 -- h_description
207 -- NOTE
208 --
209 procedure SubmitSystem(
210 h_guid in varchar2,
211 h_name in varchar2,
212 h_display_name in varchar2,
213 h_description in varchar2,
214 display_master in varchar2,
215 h_master_guid in varchar2,
216 url in varchar2);
217
218 --
219 -- SubmitAgent
220 -- Submit an agent to database
221 -- IN
222 -- h_guid - Global unique id for an agent
223 -- h_name
224 -- h_display_name
225 -- h_description
226 -- h_protocol
227 -- h_address
228 -- display_system
229 -- h_qhandler
230 -- h_qname
231 -- h_system_guid
232 -- h_direction
233 -- h_status - Agent status: ENABLED|DISABLED
234 -- NOTE
235 --
236 procedure SubmitAgent(
237 h_guid in varchar2,
238 h_name in varchar2,
239 h_display_name in varchar2,
240 h_description in varchar2,
241 h_protocol in varchar2,
242 h_address in varchar2,
243 display_system in varchar2,
244 h_system_guid in varchar2,
245 h_qhandler in varchar2,
246 h_qname in varchar2,
247 h_direction in varchar2,
248 h_status in varchar2,
249 url in varchar2);
250
251 --
252 -- SubmitSubscription
253 -- Submit a subscription to database
254 -- IN
255 -- h_guid - Global unique id for an agent
256 -- h_display_name
257 -- h_description
258 -- h_protocol
259 -- h_address
260 -- h_system_guid
261 -- h_direction
262 -- h_status - Agent status: ENABLED|DISABLED
263 -- NOTE
264 --
265 procedure SubmitSubscription(
266 h_guid in varchar2,
267 h_description in varchar2,
268 display_system in varchar2,
269 h_system_guid in varchar2,
270 h_source_type in varchar2,
271 display_source_agent in varchar2,
272 h_source_agent_guid in varchar2,
273 display_event in varchar2,
274 h_event_guid in varchar2,
275 h_phase in varchar2,
276 h_status in varchar2,
277 h_owner_name in varchar2,
278 h_owner_tag in varchar2,
279 h_rule_data in varchar2,
280 h_rule_function in varchar2,
281 display_out_agent in varchar2,
282 h_out_agent_guid in varchar2,
283 display_to_agent in varchar2,
284 h_to_agent_guid in varchar2,
285 h_priority in varchar2,
286 h_wfptype in varchar2,
287 h_wfptype_dname in varchar2,
288 h_wfpname in varchar2,
289 h_wfptn in varchar2,
290 h_parameters in varchar2,
291 h_custom_level in varchar2,
292 url in varchar2);
293
294
295 --
296 -- FindEvent
297 -- Filter page to find events
298 --
299 procedure FindEvent (
300 x_gguid in raw default null,
301 h_guid in raw default null,
302 h_display_name in varchar2 default null,
303 h_name in varchar2 default null,
304 h_status in varchar2 default '*'
305 );
306
307 --
308 -- FindSystem
309 -- Filter page to find systems
310 --
311 procedure FindSystem;
312
313 --
314 -- FindAgent
315 -- Filter page to find agents
316 --
317 procedure FindAgent;
318
319 --
320 -- FindSubscription
321 -- Filter page to find subscriptions
322 --
323 procedure FindSubscription;
324
325 --
326 -- DeleteEvent
327 -- Delete an event
328 -- IN
329 -- h_guid - Global unique id for an event
330 -- NOTE
331 --
332 procedure DeleteEvent(
333 h_guid in raw default null);
334
335 --
336 -- DeleteSystem
337 -- Delete a system
338 -- IN
339 -- h_guid - Global unique id for a system
340 -- NOTE
341 --
342 procedure DeleteSystem(
343 h_guid in raw default null);
344
345 --
346 -- DeleteAgent
347 -- Delete an agent
348 -- IN
349 -- h_guid - Global unique id for an agent
350 -- NOTE
351 --
352 procedure DeleteAgent(
353 h_guid in raw default null);
354
355 --
356 -- DeleteSubscription
357 -- Delete a subscription
358 -- IN
359 -- h_guid - Global unique id for a subscription
360 -- NOTE
361 --
362 procedure DeleteSubscription(
363 h_guid in raw default null);
364
365 --
366 -- wf_event_val
367 -- Create the lov content for our event lov. This function
368 -- is called by the generic lov function
369 -- IN
370 -- RETURNS
371 --
372 procedure wf_event_val (
373 p_mode in varchar2,
374 p_lov_name in varchar2,
375 p_start_row in number,
376 p_max_rows in number,
377 p_hidden_value in out nocopy varchar2,
378 p_display_value in out nocopy varchar2,
379 p_result out nocopy number);
380
381 --
382 -- wf_system_val
383 -- Create the lov content for our system lov. This function
384 -- is called by the generic lov function
385 -- IN
386 -- RETURNS
387 --
388 procedure wf_system_val (
389 p_mode in varchar2,
390 p_lov_name in varchar2,
391 p_start_row in number,
392 p_max_rows in number,
393 p_hidden_value in out nocopy varchar2,
394 p_display_value in out nocopy varchar2,
395 p_result out nocopy number);
396
397 --
398 -- wf_agent_val
399 -- Create the lov content for our agent lov. This function
400 -- is called by the generic lov function
401 -- IN
402 -- RETURNS
403 --
404 procedure wf_agent_val (
405 p_mode in varchar2,
406 p_lov_name in varchar2,
407 p_start_row in number,
408 p_max_rows in number,
409 p_hidden_value in out nocopy varchar2,
410 p_display_value in out nocopy varchar2,
411 p_result out nocopy number,
412 p_param1 in varchar2 default null,
413 p_param2 in varchar2 default null);
414
415 --
416 -- wf_itemtype_val
417 -- Create the lov content for wf item type lov. This function
418 -- is called by the generic lov function
419 -- IN
420 -- RETURNS
421 --
422 procedure wf_itemtype_val (
423 p_mode in varchar2,
424 p_lov_name in varchar2,
425 p_start_row in number,
426 p_max_rows in number,
427 p_hidden_value in out nocopy varchar2,
428 p_display_value in out nocopy varchar2,
429 p_result out nocopy number);
430
431 --
432 -- wf_processname_val
433 -- Create the lov content for wf process name lov. This function
434 -- is called by the generic lov function
435 -- IN
436 -- RETURNS
437 --
438 procedure wf_processname_val (
439 p_mode in varchar2,
440 p_lov_name in varchar2,
441 p_start_row in number,
442 p_max_rows in number,
443 p_hidden_value in out nocopy varchar2,
444 p_display_value in out nocopy varchar2,
445 p_result out nocopy number,
446 p_param1 in varchar2 default null);
447
448 --
449 -- Validate_Event_Name
450 -- Find out if there is an unique match. Return if all fine, otherwise
451 -- raise an error.
452 -- NOTE
453 -- p_name has precedence over p_guid in matching.
454 --
455 procedure validate_event_name (
456 p_name in varchar2,
457 p_guid in out nocopy raw);
458
459 --
460 -- Validate_System_Name
461 -- Find out if there is an unique match. Return if all fine, otherwise
462 -- raise an error.
463 -- NOTE
464 -- p_name has precedence over p_guid in matching.
465 --
466 procedure validate_system_name (
467 p_name in varchar2,
468 p_guid in out nocopy raw);
469
470 --
471 -- Validate_Agent_Name
472 -- Find out if there is an unique match. Return if all fine, otherwise
473 -- raise an error.
474 -- NOTE
475 -- p_name has precedence over p_guid in matching.
476 --
477 procedure validate_agent_name (
478 p_name in varchar2,
482 -- AddSelectedGEvents
479 p_guid in out nocopy raw);
480
481 --
483 -- Add selected events to group
484 -- IN
485 -- h_gguid - Global unique id for the group event
486 -- h_guids - Array of global unique id of events
487 -- NOTE
488 --
489 procedure AddSelectedGEvents(
490 h_gguid in raw,
491 h_guids in hguid_array);
492
493 --
494 -- DeleteSelectedGEvents
495 -- Delete selected events from group
496 -- IN
497 -- h_gguid - Global unique id for the group event
498 -- h_guids - Array of global unique id of events
499 -- NOTE
500 --
501 procedure DeleteSelectedGEvents(
502 h_gguid in raw,
503 h_guids in hguid_array);
504
505 -- EnterEventDetails
506 -- Enter Event Name, Event Key, Event Data to raise business event
507 -- IN
508 -- p_event_name - event name or part thereof
509 procedure EnterEventDetails(
510 P_EVENT_NAME in varchar2 default '%'
511 );
512
513 -- RaiseEvent
514 -- Called from EnterEventDetails, calls wf_event.raise
515 -- IN
516 -- p_event_name - event name
517 -- p_event_key - event key
518 -- p_event_data - event data
519 procedure RaiseEvent(
520 P_EVENT_NAME in varchar2 default null,
521 P_EVENT_KEY in varchar2 default null,
522 P_EVENT_DATA in varchar2 default null
523 );
524
525 -- RaiseEventSuccess
526 -- Called from RaiseEvent to confirm submission
527 procedure RaiseEventConfirm(
528 P_EVENT_NAME in varchar2 default null,
529 P_EVENT_KEY in varchar2 default null
530 );
531
532 -- GetSystemIdentifier
533 -- Returns xml document which contains Local System and In Agent details
534 procedure GetSystemIdentifier;
535
536 -- Event Queue Display
537 -- Shows all event queues and message count that use WF_EVENT_QH queue
538 -- handler
539 procedure EventQueueDisplay;
540
541 -- FindQueueMessage
542 -- Filter Screen over Queue Messages
543 -- IN
544 -- Queue Name - used if called from EventQueueDisplay
545 procedure FindQueueMessage (
546 P_QUEUE_NAME in varchar2 default null,
547 P_TYPE in varchar2 default null
548 );
549 -- FindECXMSGQueueMessage
550 -- Filter Screen over Queue Messages
551 -- IN
552 -- Queue Name - used if called from EventQueueDisplay
553 procedure FindECXMSGQueueMessage (
554 P_QUEUE_NAME in varchar2 default null,
555 P_TYPE in varchar2 default null
556 );
557 -- FindECX_INENGOBJQueueMessage
558 -- Filter Screen over Queue Messages
559 -- IN
560 -- Queue Name - used if called from EventQueueDisplay
561 procedure FindECX_INENGOBJQueueMessage (
562 P_QUEUE_NAME in varchar2 default null,
563 P_TYPE in varchar2 default null
564 );
565
566
567 -- ListQueueMessages
568 -- Queue Messages after Filter applied
569 -- IN
570 -- Queue Name
571 -- Event Name
572 -- Event Key
573 -- Message Status
574 procedure ListQueueMessages (
575 P_QUEUE_NAME in varchar2 default null,
576 P_EVENT_NAME in varchar2 default null,
577 P_EVENT_KEY in varchar2 default null,
578 P_MESSAGE_STATUS in varchar2 default 'ANY',
579 P_MESSAGE_ID in varchar2 default null
580 );
581 -- EventDataContents
582 -- Shows clob contents in XML format
583 -- IN
584 -- Message ID
585 -- Queue Table
586 procedure EventDataContents (
587 P_MESSAGE_ID in varchar2 default null,
588 P_QUEUE_TABLE in varchar2 default null,
589 P_MIMETYPE in varchar2 default 'text/xml'
590 );
591 -- EventData
592 -- Called by the Error Process, outputs EventData XML Clob
593 -- IN
594 -- EventAttribute - Event Item Attribute
595 -- itemtype - item type
596 -- itemkey - item key
597 -- mimetype - mime type
598 procedure EventDataContents (
599 P_EVENTATTRIBUTE in varchar2,
600 P_ITEMTYPE in varchar2,
601 P_ITEMKEY in varchar2,
602 P_MIME_TYPE in varchar2 default 'text/xml');
603
604
605 -- getFWKEvtSubscriptionUrl
606 -- This procudere takes the Event Subscription GUID as input and returns
607 -- the URL to the FWK Edit Subscritpion Page in the RF.jsp format.
608
609 PROCEDURE getFWKEvtSubscriptionUrl(guid in varchar2 default null,
610 l_lurl out nocopy varchar2);
611
612
613 -- updateToFWKEvtSubscriptionUrl
614 -- This procudere takes an old Event Subscription URL of the form
615 -- host:port/pls/<sid>/Wf_Event_Html.EditSubscription?<params> as
616 -- input and returns the URL to the FWK Edit Subscritpion Page in
617 -- the RF.jsp format.
618 -- Returns following error codes
619 -- 0 - Success
620 -- 1 - failure
621
622 PROCEDURE updateToFWKEvtSubscriptionUrl(oldUrl in varchar2,
623 newUrl out nocopy varchar2,
624 errorCode out nocopy pls_integer);
625
626
627 -- updateToFWKEvtDataUrl
628 -- This procudere takes an old Event Data URL of the form
629 -- host:port/pls/<sid>/Wf_Event_Html.EventDataContents?<params> as
630 -- input and returns the URL to the FWK Event Data Page in
631 -- the RF.jsp format.
632 -- Returns following error codes
633 -- 0 - Success
634 -- 1 - failure
635
636 PROCEDURE updateToFWKEvtDataUrl(oldUrl in varchar2,
637 newUrl out nocopy varchar2,
638 errorCode out nocopy pls_integer);
639
640
641 end WF_EVENT_HTML;
[Home] [Help]