1 Package hr_api_wf_events as
2 /* $Header: hrapiwfe.pkh 120.1 2005/12/14 17:51:14 rbanda noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |----------------------< create_business_event_code >----------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 -- This code creates a package body and header for sending workflow
11 -- business events for an api hook
12 --
13 -- Prerequisites:
14 -- A valid api hook package
15 --
16 -- In Parameters:
17 -- Name Reqd Type Description
18 -- p_hook_package Yes varchar2 Name of the package to
19 -- generate code for
20 -- Post Success:
21 -- A package will be created to call workflow business events.
22 --
23 -- Post Failure:
24 -- A package will not be created, and an error will be raised.
25 --
26 -- Access Status:
27 -- Internal Use Only.
28 --
29 -- {End Of Comments}
30 --
31 procedure create_business_event_code(p_hook_package varchar2);
32 --
33 -- ----------------------------------------------------------------------------
34 -- |-------------------< subscribe_business_event_code >----------------------|
35 -- ----------------------------------------------------------------------------
36 -- {Start Of Comments}
37 --
38 -- Description:
39 -- This code subscribes the business event code to the user hook
40 --
41 -- Prerequisites:
42 -- A valid generated business event package
43 --
44 -- In Parameters:
45 -- Name Reqd Type Description
46 -- p_hook_package Yes varchar2 Name of the package to
47 -- subscribe events to
48 -- p_regenerate No boolean if true, the user hooks will
49 -- be regenerated.
50 -- Post Success:
51 -- The business event code will be added to the user hooks.
52 --
53 -- Post Failure:
54 -- The business event code will not be added to the user hooks and an error
55 -- will be raised.
56 --
57 -- Access Status:
58 -- Internal Use Only.
59 --
60 -- {End Of Comments}
61 --
62 procedure subscribe_business_event_code(p_hook_package varchar2
63 ,p_regenerate boolean default TRUE);
64 --
65 -- ----------------------------------------------------------------------------
66 -- |--------------------< register_business_event >---------------------------|
67 -- ----------------------------------------------------------------------------
68 -- {Start Of Comments}
69 --
70 -- Description:
71 -- This code registers a the workflow business events for a user hook
72 -- package with the business events system
73 --
74 -- Prerequisites:
75 -- A valid generated business event package
76 --
77 -- In Parameters:
78 -- Name Reqd Type Description
79 -- p_hook_package Yes varchar2 Name of the package to
80 -- register events for
81 -- Post Success:
82 -- The business event code will be registered.
83 --
84 -- Post Failure:
85 -- The business event code will not be registered and an error
86 -- will be raised.
87 --
88 -- Access Status:
89 -- Internal Use Only.
90 --
91 -- {End Of Comments}
92 --
93 procedure register_business_event(p_hook_package varchar2);
94 --
95 -- ----------------------------------------------------------------------------
96 -- |-----------------------------< add_event >--------------------------------|
97 -- ----------------------------------------------------------------------------
98 -- {Start Of Comments}
99 --
100 -- Description:
101 -- This code calls create_business_event_code, subscribe_business_event_code
102 -- and subscribe_business_event for a user hook package
103 --
104 -- Prerequisites:
105 -- A valid user hook package
106 --
107 -- In Parameters:
108 -- Name Reqd Type Description
109 -- p_hook_package Yes varchar2 Name of the package to
110 -- build events for
111 -- p_regenerate No boolean if true, the user hooks will
112 -- be regenerated.
113 -- Post Success:
114 -- The business event code will generated, added to the user hook and
115 -- registered with the business events system.
116 --
117 -- Post Failure:
118 -- An error will be raised.
119 --
120 -- Access Status:
121 -- Internal Use Only.
122 --
123 -- {End Of Comments}
124 --
125 procedure add_event(p_hook_package varchar2
126 ,p_regenerate boolean default TRUE);
127 --
128 -- ----------------------------------------------------------------------------
129 -- |------------------------< add_event_for_api >-----------------------------|
130 -- ----------------------------------------------------------------------------
131 -- {Start Of Comments}
132 --
133 -- Description:
134 -- This code calls create_business_event_code, subscribe_business_event_code
135 -- and subscribe_business_event for all of the user hooks for an api package
136 --
137 -- Prerequisites:
138 -- A valid user hook package
139 --
140 -- In Parameters:
141 -- Name Reqd Type Description
142 -- p_api_package Yes varchar2 Name of the api package to
143 -- build events for
144 -- p_regenerate No boolean if true, the user hooks will
145 -- be regenerated.
146 -- Post Success:
147 -- The business event code will generated, added to the user hook and
148 -- registered with the business events system.
149 --
150 -- Post Failure:
151 -- An error will be raised.
152 --
153 -- Access Status:
154 -- Internal Use Only.
155 --
156 -- {End Of Comments}
157 --
158 --
159 procedure add_events_for_api(p_api_package varchar2
160 ,p_regenerate boolean default TRUE);
161 --
162 -- ----------------------------------------------------------------------------
163 -- |---------------------------< default_rule >-------------------------------|
164 -- ----------------------------------------------------------------------------
165 -- {Start Of Comments}
166 --
167 -- Description:
168 -- This is a rule function that is set on a subscription which results in
169 -- CORRELATION_ID attribute of P_EVENT to be unique.
170 --
171 -- Prerequisites:
172 --
173 -- In Parameters:
174 -- Name Reqd Type Description
175 -- p_subscription_guid Yes raw GUID of the subscription
176 -- p_event Yes wf_event_t
177 --
178 -- Post Success:
179 --
180 -- Post Failure:
181 --
182 -- Access Status:
183 -- Internal Use Only.
184 --
185 -- {End Of Comments}
186 --
187 function default_rule(p_subscription_guid in RAW,
188 p_event in out nocopy wf_event_t)
189 return varchar2;
190 --
191 end hr_api_wf_events;
[Home] [Help]