1 package WF_ERROR_QH AUTHID CURRENT_USER as
2 /* $Header: wferrqhs.pls 120.2.12010000.2 2009/08/16 14:08:24 skandepu ship $ */
3 /*#
4 * Handles business event messages on error queues that use the WF_EVENT_T
5 * datatype as their payload type.
6 * @rep:scope public
7 * @rep:product OWF
8 * @rep:displayname Workflow Error Queue Handler
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY WF_EVENT
12 */
13 -------------------------------------------------------------------------
14 navigation binary_integer := dbms_aq.next_message;
15 -------------------------------------------------------------------------
16 /*#
17 * Dequeues an event message from the queue associated with the specified
18 * inbound error agent.
19 * @param p_agent_guid The globally unique identifier of the inbound agent.
20 * @param p_event The deqeueued event message.
21 * @rep:scope public
22 * @rep:lifecycle active
23 * @rep:displayname Dequeue Business Event
24 * @rep:compatibility S
25 */
26 PROCEDURE dequeue(p_agent_guid in raw,
27 p_event out nocopy wf_event_t);
28 -------------------------------------------------------------------------
29 /*#
30 * Dequeues an event message from the queue associated with the specified
31 * inbound error agent after waiting for the specified time.
32 * @param p_agent_guid The globally unique identifier of the inbound agent.
33 * @param p_event The deqeueued event message.
34 * @param p_wait The number of seconds to wait before dequeuing the event.
35 * @rep:scope public
36 * @rep:lifecycle active
37 * @rep:displayname Dequeue Business Event After Wait
38 * @rep:compatibility S
39 */
40 -- Bug 5034154
41 -- Added as a wrapper over the existing dequeue with two parameters
42 PROCEDURE dequeue(p_agent_guid in raw,
43 p_event out nocopy wf_event_t,
44 p_wait in binary_integer);
45 -------------------------------------------------------------------------
46 /*#
47 * Enqueues an event message onto the queue associated with the outbound error agent.
48 * You can optionally specify an override agent where you want to enqueue the event message.
49 * Otherwise, the event message is enqueued on the From Agent specified within the message.
50 * @param p_event The event message.
51 * @param p_out_agent_override The address of the override outbound agent.
52 * @rep:scope public
53 * @rep:lifecycle active
54 * @rep:displayname Enqueue Business Event
55 * @rep:compatibility S
56 */
57 PROCEDURE enqueue(p_event in wf_event_t,
58 p_out_agent_override in wf_agent_t default null);
59 -------------------------------------------------------------------------
60 end WF_ERROR_QH;