1 package wf_event_ojmstext_qh AUTHID CURRENT_USER as
2 /* $Header: wfjmstxs.pls 120.4.12020000.4 2013/03/21 13:07:20 skandepu ship $ */
3 /*#
4 * Handles business event messages on queues that use the
5 * SYS.AQ$_JMS_TEXT_MESSAGE datatype as their payload type.
6 * @rep:scope public
7 * @rep:product WF
8 * @rep:displayname Workflow JMS Text Queue Handler
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY WF_EVENT
12 */
13
14 JMS_TYPE constant varchar2(8) := 'JMS_TYPE';
15 JMS_USERID constant varchar2(10) := 'JMS_USERID';
16 JMS_APPID constant varchar2(9) := 'JMS_APPID';
17 JMS_GROUPID constant varchar2(11) := 'JMS_GROUPID';
18 JMS_GROUPSEQ constant varchar2(12) := 'JMS_GROUPSEQ';
19 JMS_REPLYTO constant varchar2(11) := 'JMS_REPLYTO';
20
21 --------------------------------------------------------------------------------
22 -- Enqueues a business event into a JMS queue.
23 --
24 -- p_event - the business event to enqueue
25 -- p_out_agent_override - the out agent override
26 --------------------------------------------------------------------------------
27 /*#
28 * Enqueues an event message onto the JMS queue associated with the outbound agent.
29 * You can optionally specify an override agent where you want to enqueue the event message.
30 * Otherwise, the event message is enqueued on the From Agent specified within the message.
31 * @param p_event The event message.
32 * @param p_out_agent_override The address of the override outbound agent.
33 * @rep:scope public
34 * @rep:lifecycle active
35 * @rep:displayname Enqueue Business Event
36 * @rep:compatibility S
37 */
38 procedure enqueue(p_event in wf_event_t,
39 p_out_agent_override in wf_agent_t default null);
40
41 --------------------------------------------------------------------------------
42 -- Dequeues a business event from a JMS queue.
43 --
44 -- p_agent_guid - the agent GUID
45 -- p_event - the business event
46 -- p_wait - the number of seconds to wait to dequeue the event
47 --------------------------------------------------------------------------------
48 /*#
49 * Dequeues an event message from the JMS queue associated with the specified
50 * inbound agent.
51 * @param p_agent_guid The globally unique identifier of the inbound agent.
52 * @param p_event The deqeueued event message.
53 * @param p_wait The number of seconds to wait before dequeuing the event.
54 * @rep:scope public
55 * @rep:lifecycle active
56 * @rep:displayname Dequeue Business Event
57 * @rep:compatibility S
58 */
59 procedure dequeue(p_agent_guid in raw,
60 p_event out nocopy wf_event_t,
61 p_wait in binary_integer default dbms_aq.no_wait);
62
63 --------------------------------------------------------------------------------
64 -- Tranforms a business event into a JMS Text Message.
65 --
66 -- p_event - the business event to transform
67 -- p_jms_text_message - the JMS Text Message
68 --------------------------------------------------------------------------------
69 /*#
70 * Transforms the specified event message into a JMS Text message.
71 * @param p_event The event message to transform.
72 * @param p_jms_text_message The resulting JMS Text message.
73 * @rep:scope public
74 * @rep:lifecycle active
75 * @rep:displayname Serialize Business Event
76 * @rep:compatibility S
77 */
78 procedure serialize(p_event in wf_event_t,
79 p_jms_text_message out nocopy sys.aq$_jms_text_message);
80
81 --------------------------------------------------------------------------------
82 -- Tranforms a JMS Text Message into a business event.
83 --
84 -- p_jms_text_message - the JMS Text Message
85 -- p_event - the business event
86 --------------------------------------------------------------------------------
87 /*#
88 * Transforms the specified JMS Text message into an event message.
89 * @param p_jms_text_message The JMS Text message to transform.
90 * @param p_event The resulting event message.
91 * @rep:scope public
92 * @rep:lifecycle active
93 * @rep:displayname Deserialize JMS Text Message
94 * @rep:compatibility S
95 */
96 procedure deserialize(p_jms_text_message in out nocopy sys.aq$_jms_text_message,
97 p_event out nocopy wf_event_t);
98
99 end wf_event_ojmstext_qh;
[Home] [Help]