1 package WF_AGENTS_PKG as
2 /* $Header: WFEVAGTS.pls 120.1 2005/07/02 03:13:57 appldev ship $ */
3 /*#
4 * Provides APIs to communicate agent definitions to and from the
5 * WF_AGENTS table.
6 * @rep:scope public
7 * @rep:product OWF
8 * @rep:displayname Workflow Agent
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY WF_EVENT
12 * @rep:ihelp FND/@besrepapis See the related online help
13 */
14 -----------------------------------------------------------------------------
15 procedure INSERT_ROW (
16 X_ROWID in out nocopy varchar2,
17 X_GUID in raw,
18 X_NAME in varchar2,
19 X_SYSTEM_GUID in raw,
20 X_PROTOCOL in varchar2,
21 X_ADDRESS in varchar2,
22 X_QUEUE_HANDLER in varchar2,
23 X_QUEUE_NAME in varchar2,
24 X_DIRECTION in varchar2,
25 X_STATUS in varchar2,
26 X_DISPLAY_NAME in varchar2,
27 X_DESCRIPTION in varchar2,
28 X_TYPE in varchar2 default 'AGENT',
29 X_JAVA_QUEUE_HANDLER in varchar2 default null
30 );
31 -----------------------------------------------------------------------------
32 procedure UPDATE_ROW (
33 X_GUID in raw,
34 X_NAME in varchar2,
35 X_SYSTEM_GUID in raw,
36 X_PROTOCOL in varchar2,
37 X_ADDRESS in varchar2,
38 X_QUEUE_HANDLER in varchar2,
39 X_QUEUE_NAME in varchar2,
40 X_DIRECTION in varchar2,
41 X_STATUS in varchar2,
42 X_DISPLAY_NAME in varchar2,
43 X_DESCRIPTION in varchar2,
44 X_TYPE in varchar2 default null,
45 X_JAVA_QUEUE_HANDLER in varchar2 default null
46 );
47 -----------------------------------------------------------------------------
48 procedure DELETE_ROW (
49 X_GUID in raw
50 );
51 -----------------------------------------------------------------------------
52 procedure LOAD_ROW (
53 X_GUID in raw,
54 X_NAME in varchar2,
55 X_SYSTEM_GUID in raw,
56 X_PROTOCOL in varchar2,
57 X_ADDRESS in varchar2,
58 X_QUEUE_HANDLER in varchar2,
59 X_QUEUE_NAME in varchar2,
60 X_DIRECTION in varchar2,
61 X_STATUS in varchar2,
62 X_DISPLAY_NAME in varchar2,
63 X_DESCRIPTION in varchar2,
64 X_TYPE in varchar2 default 'AGENT',
65 X_JAVA_QUEUE_HANDLER in varchar2 default null
66 );
67 -----------------------------------------------------------------------------
68 /*#
69 * Generates an XML message containing the complete information from the
70 * WF_AGENTS table for the specified agent definition.
71 * @param x_guid Agent GUID
72 * @return Agent XML Message
73 * @rep:scope public
74 * @rep:lifecycle active
75 * @rep:displayname Generate Agent Message
76 * @rep:compatibility S
77 * @rep:ihelp FND/@besrepapis#a_evagtgen See the related online help
78 */
79 function GENERATE (
80 X_GUID in raw
81 ) return varchar2;
82 -----------------------------------------------------------------------------
83 /*#
84 * Receives an XML message containing the complete information for an agent
85 * definition and loads the information into the WF_AGENTS table.
86 * @param x_message Agent XML Message
87 * @rep:scope public
88 * @rep:lifecycle active
89 * @rep:displayname Receive Agent Message
90 * @rep:compatibility S
91 * @rep:ihelp FND/@besrepapis#a_evagtrec See the related online help
92 */
93 procedure RECEIVE (
94 X_MESSAGE in varchar2
95 );
96 -----------------------------------------------------------------------------
97 end WF_AGENTS_PKG;