DBA Data[Home] [Help]

PACKAGE: APPS.AME_RULE_API

Source


1 Package ame_rule_api as
2 /* $Header: amrulapi.pkh 120.4 2006/05/05 04:46:56 avarri noship $ */
3 /*#
4  * This package contains the AME Rule APIs.
5  * @rep:scope public
6  * @rep:product AME
7  * @rep:displayname Rule
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_ame_rule >--------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a rule and a usage for this rule for the given
17  * transaction type.
18  *
19  * <p><b>Licensing</b><br>
20  * This API is available for use with any licensed component of the
21  * e-business suite.
22  *
23  * <p><b>Prerequisites</b><br>
24  * The condition, action, and the application that are used to create a rule
25  * should be valid. The condition, action and rule type should be compatible.
26  *
27  * <p><b>Post Success</b><br>
28  * The rule and its usage is created.
29  *
30  * <p><b>Post Failure</b><br>
31  * No rule is created and an error is raised.
32  *
33  * @param p_validate If true, then validation alone will be performed and the
34  * database will remain unchanged. If false and all validation checks pass,
35  * then the database will be modified.
36  * @param p_language_code Specifies to which language the translation values
37  * apply. You can set to the base or any installed language. The default value
38  * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
39  * value.
40  * @param p_rule_key A unique key for the rule.
41  * @param p_description The description of the rule.
42  * @param p_rule_type The type of the rule. The valid values are defined in
43  * the look up AME_RULE_TYPE.
44  * @param p_item_class_id This uniquely identifies the item class for which
45  * the rule has to be created.
46  * @param p_condition_id This uniquely identifies the condition that is used
47  * to define the rule. The condition should correspond to the rule type.
48  * @param p_action_id This uniquely identifies the action that is used to
49  * define the rule. The action should correspond to the rule type.
50  * @param p_application_id This uniquely identifies the transaction type
51  * for which the rule usage has to be created.
52  * @param p_priority The rule priority. This can be used only when
53  * Rule Priority Mode is enabled for rule type. Valid values are from
54  * 1 to 99999.
55  * @param p_approver_category The approver category. The valid values are
56  * defined in the look up type AME_APPROVER_CATEGORY.
57  * @param p_rul_start_date If p_validate is false, it is set to the start date
58  * for the rule definition. If it is set to true, it is set to null.
59  * @param p_rul_end_date If p_validate is false, it is set to the end date of
60  * the rule definition. If p_validate is true, it is set to null.
61  * @param p_rule_id If p_validate is false, it is set to the rule id for
62  * the newly created rule. If p_validate is true, it is set to null.
63  * @param p_rul_object_version_number If p_validate is false, it is set to the
64  * start date of the rule definition. If p_validate is true, it is set to null.
65  * @param p_rlu_object_version_number If p_validate is false, it is set to
66  * the version number for the rule usage. If p_validate is true,
67  * it is set to null.
68  * @param p_rlu_start_date If p_validate is false, it is set to the start date
69  * for the rule usage. If it is set to true, it is set to null.
70  * @param p_rlu_end_date If p_validate is false, it is set to the end date of
71  * the rule usage. If p_validate is true, it is set to null.
72  * @param p_cnu_object_version_number f p_validate is false, it is set to the
73  * version number for the condition usage. If p_validate is true, it is set
74  * to null.
75  * @param p_cnu_start_date If p_validate is false, it is set to the start date
76  * of the condition usage. If p_validate is true, it is set to null.
77  * @param p_cnu_end_date If p_validate is false, it is set to the end date of
78  * the condition usage. If p_validate is true, it is set to null.
79  * @param p_acu_object_version_number If p_validate is false, it is set to the
80  * version number for the action usage. If p_validate is true,
81  * it is set to null.
82  * @param p_acu_start_date If p_validate is false, it is set to the
83  * start date of the action usage. If p_validate is true, it is set to null.
84  * @param p_acu_end_date If p_validate is false, it is set to the end date
85  * of the action usage. If p_validate is true, it is set to null.
86  * @rep:displayname Create Ame Rule.
87  * @rep:category BUSINESS_ENTITY AME_RULE
88  * @rep:lifecycle active
89  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
90  * @rep:scope public
91 */
92 --
93 -- {End Of Comments}
94 --
95 procedure create_ame_rule
96   (p_validate                      in     boolean  default false
97   ,p_language_code                 in     varchar2 default hr_api.userenv_lang
98   ,p_rule_key                      in     varchar2
99   ,p_description                   in     varchar2
100   ,p_rule_type                     in     varchar2
101   ,p_item_class_id                 in     number   default null
102   ,p_condition_id                  in     number   default null
103   ,p_action_id                     in     number   default null
104   ,p_application_id                in     number   default null
105   ,p_priority                      in     number   default null
106   ,p_approver_category             in     varchar2 default null
107   ,p_rul_start_date                in out nocopy   date
108   ,p_rul_end_date                  in out nocopy   date
109   ,p_rule_id                          out nocopy   number
110   ,p_rul_object_version_number        out nocopy   number
111   ,p_rlu_object_version_number        out nocopy   number
112   ,p_rlu_start_date                   out nocopy   date
113   ,p_rlu_end_date                     out nocopy   date
114   ,p_cnu_object_version_number        out nocopy   number
115   ,p_cnu_start_date                   out nocopy   date
116   ,p_cnu_end_date                     out nocopy   date
117   ,p_acu_object_version_number        out nocopy   number
118   ,p_acu_start_date                   out nocopy   date
119   ,p_acu_end_date                     out nocopy   date
120   );
121 --
122 -- ----------------------------------------------------------------------------
123 -- |--------------------------< create_ame_rule_usage >-----------------------|
124 -- ----------------------------------------------------------------------------
125 --
126 -- {Start Of Comments}
127 /*#
128  * This API creates a usage for an existing rule for the given
129  * transaction type.
130  *
131  * <p><b>Licensing</b><br>
132  * This API is available for use with any licensed component of the
133  * e-business suite.
134  *
135  * <p><b>Prerequisites</b><br>
136  * The rule and the application should be valid.
137  *
138  * <p><b>Post Success</b><br>
139  * A usage for the rule will be created for the given transaction type.
140  *
141  * <p><b>Post Failure</b><br>
142  * No usage is created and the API will raise an error.
143  *
144  * @param p_validate If true, then validation alone will be performed and the
145  * database will remain unchanged. If false and all validation checks pass,
146  * then the database will be modified.
147  * @param p_rule_id This uniquely identifies the rule for which the usage
148  * has to be created.
149  * @param p_application_id This uniquely identifies the transaction type
150  * for which the rule usage has to be created.
151  * @param p_priority The rule priority. This can be used only when
152  * Rule Priority Mode is enabled for rule type. Valid values are from
153  * 1 to 99999.
154  * @param p_approver_category The approver category. The valid values are
155  * defined in the look up AME_APPROVER_CATEGORY.
156  * @param p_start_date If p_validate is false, it is set to the start date of
157  * the rule usage. If p_validate is true, it is set to null.
158  * @param p_end_date If p_validate is false, it is set to the end date of
159  * the rule usage. If p_validate is true, it is set to null.
160  * @param p_object_version_number If p_validate is false, it is set to the
161  * version number for the rule usage. If p_validate is true, it is set to null.
162  * @rep:displayname Create Ame Rule Usage
163  * @rep:category BUSINESS_ENTITY AME_RULE
164  * @rep:lifecycle active
165  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
166  * @rep:scope public
167 */
168 --
169 -- {End Of Comments}
170 --
171 procedure create_ame_rule_usage
172   (p_validate                      in     boolean  default false
173   ,p_rule_id                       in     number
174   ,p_application_id                in     number
175   ,p_priority                      in     number   default null
176   ,p_approver_category             in     varchar2 default null
177   ,p_start_date                    in out nocopy   date
178   ,p_end_date                      in out nocopy   date
179   ,p_object_version_number            out nocopy   number
180   );
181 --
182 -- ----------------------------------------------------------------------------
183 -- |-----------------------< create_ame_condition_to_rule >-------------------|
184 -- ----------------------------------------------------------------------------
185 --
186 -- {Start Of Comments}
187 /*#
188  * This API adds a condition to an existing rule.
189  *
190  * <p><b>Licensing</b><br>
191  * This API is available for use with any licensed component of the
192  * e-business suite.
193  *
194  * <p><b>Prerequisites</b><br>
195  * The condition and the rule should be valid.
196  *
197  * <p><b>Post Success</b><br>
198  * The condition is added to the given rule.
199  *
200  * <p><b>Post Failure</b><br>
201  * The condition is not added to the rule and an error is raised.
202  *
203  * @param p_validate If true, then validation alone will be performed and the
204  * database will remain unchanged. If false and all validation checks pass,
205  * then the database will be modified.
206  * @param p_rule_id This uniquely identifies the rule for which the
207  * condition usage has to be created.
208  * @param p_condition_id This uniquely identifies the condition that has to be
209  * added to the rule. The condition should correspond to the rule type.
210  * @param p_object_version_number If p_validate is false, it is set to the
211  * version number for the condition usage. If p_validate is true,
212  * it is set to null.
213  * @param p_start_date If p_validate is false, it is set to the start date
214  * of the condition usage. If p_validate is true, it is set to null.
215  * @param p_end_date If p_validate is false, it is set to the end date of the
216  * condition usage. If p_validate is true, it is set to null.
217  * @param p_effective_date This parameter is used to pass the effective date
218  * from the UI. This parameter is not used when the API is called directly.
219  * @rep:displayname Create Ame Condition To Rule
220  * @rep:category BUSINESS_ENTITY AME_RULE
221  * @rep:lifecycle active
222  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
223  * @rep:scope public
224 */
225 --
226 -- {End Of Comments}
227 --
228 procedure create_ame_condition_to_rule
229   (p_validate                      in     boolean  default false
230   ,p_rule_id                       in     number
231   ,p_condition_id                  in     number
232   ,p_object_version_number            out nocopy   number
233   ,p_start_date                       out nocopy   date
234   ,p_end_date                         out nocopy   date
235   ,p_effective_date                in     date     default  null
236   );
237 --
238 -- ----------------------------------------------------------------------------
239 -- |---------------------------< replace_lm_condition >-----------------------|
240 -- ----------------------------------------------------------------------------
241 --
242 -- {Start Of Comments}
243 /*#
244  * This API replaces the list modification condition of an existing list
245  * modification or substitution rule.
246  *
247  * <p><b>Licensing</b><br>
248  * This API is available for use with any licensed component of the
249  * e-business suite.
250  *
251  * <p><b>Prerequisites</b><br>
252  * Both the rule and condition should be valid. The condition should be a
253  * list modification condition. The rule type should correspond to the
254  * condition.
255  *
256  * <p><b>Post Success</b><br>
257  * The list modification condition associated to the given rule is replaced
258  * by the new condition specified.
259  *
260  * <p><b>Post Failure</b><br>
261  * The list modification condition is not replaced and an error is raised.
262  *
263  * @param p_validate If true, then validation alone will be performed and the
264  * database will remain unchanged. If false and all validation checks pass,
265  * then the database will be modified.
266  * @param p_rule_id This uniquely identifies the rule for which the
267  * list modification condition has to be replaced. The rule can either
268  * be a list modification or substitution rule.
269  * @param p_condition_id This uniquely identifies the new List Modification
270  * condition that replaces the existing List Modification condition
271  * in the rule.
272  * @param p_object_version_number If p_validate is false, it is set to the
273  * version number for the condition usage. If p_validate is true, it is
274  * set to null.
275  * @param p_start_date If p_validate is false, it is set to the start date
276  * of the condition usage. If p_validate is true, it is set to null.
277  * @param p_end_date If p_validate is false, it is set to the end date
278  * of the condition usage. If p_validate is true, it is set to null.
279  * @rep:displayname Replace LM Condition
280  * @rep:category BUSINESS_ENTITY AME_RULE
281  * @rep:lifecycle active
282  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
283  * @rep:scope public
284 */
285 --
286 -- {End Of Comments}
287 --
288 procedure replace_lm_condition
289   (p_validate                      in     boolean  default false
290   ,p_rule_id                       in     number
291   ,p_condition_id                  in     number
292   ,p_object_version_number            out nocopy   number
293   ,p_start_date                       out nocopy   date
294   ,p_end_date                         out nocopy   date
295   );
296 --
297 -- ----------------------------------------------------------------------------
298 -- |------------------------< create_ame_action_to_rule >---------------------|
299 -- ----------------------------------------------------------------------------
300 --
301 -- {Start Of Comments}
302 /*#
303  * This API adds an action to an existing rule.
304  *
305  * <p><b>Licensing</b><br>
306  * This API is available for use with any licensed component of the
307  * e-business suite.
308  *
309  * <p><b>Prerequisites</b><br>
310  * The action and the rule should be valid.
311  *
312  * The action's action type should be available for the transaction type
313  * containing the rule.
314  *
315  * <p><b>Post Success</b><br>
316  * The action is added to the given rule.
317  *
318  * <p><b>Post Failure</b><br>
319  * The action is not added to the rule and an error is raised.
320  *
321  * @param p_validate If true, then validation alone will be performed and the
322  * database will remain unchanged. If false and all validation checks pass,
323  * then the database will be modified.
324  * @param p_rule_id This uniquely identifies the rule to which the action
325  * has to be added.
326  * @param p_action_id This uniquely identifies the action that has to
327  * be added to the rule. The action should correspond to the rule type.
328  * @param p_object_version_number If p_validate is false, it is set to the
329  * version number for the action usage. If p_validate is true,
330  * it is set to null.
331  * @param p_start_date If p_validate is false, it is set to the start date
332  * of the action usage. If p_validate is true, it is set to null.
333  * @param p_end_date If p_validate is false, it is set to the end date
334  * of the action usage. If p_validate is true, it is set to null.
335  * @param p_effective_date This parameter is used to pass the effective date
336  * from the UI. This parameter is not used when the API is called directly.
340  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
337  * @rep:displayname Create Ame Action To Rule
338  * @rep:category BUSINESS_ENTITY AME_RULE
339  * @rep:lifecycle active
341  * @rep:scope public
342 */
343 --
344 -- {End Of Comments}
345 --
346 procedure create_ame_action_to_rule
347   (p_validate                      in     boolean  default false
348   ,p_rule_id                       in     number
349   ,p_action_id                     in     number
350   ,p_object_version_number            out nocopy   number
351   ,p_start_date                       out nocopy   date
352   ,p_end_date                         out nocopy   date
353   ,p_effective_date                in     date     default  null
354   );
355 --
356 -- ----------------------------------------------------------------------------
357 -- |-----------------------------< update_ame_rule >--------------------------|
358 -- ----------------------------------------------------------------------------
359 --
360 -- {Start Of Comments}
361 /*#
362  * This API updates the rule definition.
363  *
364  * <p><b>Licensing</b><br>
365  * This API is available for use with any licensed component of the
366  * e-business suite.
367  *
368  * <p><b>Prerequisites</b><br>
369  * The rule should be valid.
370  *
371  * <p><b>Post Success</b><br>
372  * The rule is updated.
373  *
374  * <p><b>Post Failure</b><br>
375  * The rule is not updated and an error is raised.
376  *
377  * @param p_validate If true, then validation alone will be performed and the
378  * database will remain unchanged. If false and all validation checks pass,
379  * then the database will be modified.
380  * @param p_language_code Specifies to which language the translation values
381  * apply. You can set to the base or any installed language. The default value
382  * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
383  * value.
384  * @param p_rule_id This uniquely identifies the rule that has to be updated.
385  * @param p_description The description of the rule.
386  * @param p_object_version_number Pass in the current version number of the
387  * rule to be updated. When the API completes, if p_validate is false,
388  * it will be set to the new version number of the updated rule. If
389  * p_validate is true, will be set to the same value which was passed in.
390  * @param p_start_date If p_validate is false, it is set to present date.
391  * If p_validate is true, it is set to the same date, which was passed in.
392  * @param p_end_date It is the date up to, which the updated rule is
393  * effective. If p_validate is false, it is set to 31-Dec-4712.
394  * If p_validate is true, it is set to the same date, which was passed in.
395  * @param p_effective_date This parameter is used to pass the effective date
396  * from the UI. This parameter is not used when the API is called directly.
397  * @rep:displayname Update Ame Rule
398  * @rep:category BUSINESS_ENTITY AME_RULE
399  * @rep:lifecycle active
400  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
401  * @rep:scope public
402 */
403 --
404 -- {End Of Comments}
405 --
406 procedure update_ame_rule
407   (p_validate                      in     boolean  default false
408   ,p_language_code                 in     varchar2 default hr_api.userenv_lang
409   ,p_rule_id                       in     number
410   ,p_description                   in     varchar2 default hr_api.g_varchar2
411   ,p_object_version_number         in out nocopy   number
412   ,p_start_date                    in out nocopy   date
413   ,p_end_date                      in out nocopy   date
414   ,p_effective_date                in     date     default null
415   );
416 --
417 -- ----------------------------------------------------------------------------
418 -- |--------------------------< update_ame_rule_usage >-----------------------|
419 -- ----------------------------------------------------------------------------
420 --
421 -- {Start Of Comments}
422 /*#
423  * This API updates the rule usage.
424  *
425  * <p><b>Licensing</b><br>
426  * This API is available for use with any licensed component of the
427  * e-business suite.
428  *
429  * <p><b>Prerequisites</b><br>
430  * The rule and the rule usage should be valid.
431  *
432  * <p><b>Post Success</b><br>
433  * The rule usage is updated.
434  *
435  * <p><b>Post Failure</b><br>
436  * The rule usage is not updated and an error is raised.
437  *
438  * @param p_validate If true, then validation alone will be performed and the
439  * database will remain unchanged. If false and all validation checks pass,
440  * then the database will be modified.
441  * @param p_rule_id This uniquely identifies the rule whose usage has to be
442  * updated.
443  * @param p_application_id This uniquely identifies the transaction type for
444  * which the rule usage has to be modified.
445  * @param p_priority The rule priority. This can be used only when
446  * Rule Priority Mode is enabled for rule type. Valid values are from
447  * 1 to 99999.
448  * @param p_approver_category The approver category. The valid values are
449  * defined in the look up AME_APPROVER_CATEGORY.
450  * @param p_old_start_date The start date of the current rule usage.
451  * @param p_object_version_number Pass in the current version number of the
452  * rule usage to be updated. When the API completes, if p_validate is false,
453  * it will be set to the new version number of the updated rule usage. If
454  * p_validate is true, will be set to the same value which was passed in.
455  * @param p_start_date If p_validate is false, it is set to the start date
456  * for the rule usage. If p_validate is true, it is set to null.
457  * @param p_end_date It is the date up to, which the updated rule usage is
458  * effective. If p_validate is false, it is set to the same date, which is
462  * @rep:displayname Update Ame Rule Usage
459  * passed in. If p_validate is true, it is set to null.
460  * @param p_effective_date This parameter is used to pass the effective date
461  * from the UI. This parameter is not used when the API is called directly.
463  * @rep:category BUSINESS_ENTITY AME_RULE
464  * @rep:lifecycle active
465  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
466  * @rep:scope public
467 */
468 --
469 -- {End Of Comments}
470 --
471 procedure update_ame_rule_usage
472   (p_validate                      in     boolean  default false
473   ,p_rule_id                       in     number
474   ,p_application_id                in     number
475   ,p_priority                      in     number   default hr_api.g_number
476   ,p_approver_category             in     varchar2 default hr_api.g_varchar2
477   ,p_old_start_date                in     date
478   ,p_object_version_number         in out nocopy   number
479   ,p_start_date                    in out nocopy   date
480   ,p_end_date                      in out nocopy   date
481   ,p_effective_date                in     date     default null
482   );
483 --
484 -- ----------------------------------------------------------------------------
485 -- |--------------------------< delete_ame_rule_usage >-----------------------|
486 -- ----------------------------------------------------------------------------
487 --
488 -- {Start Of Comments}
489 /*#
490  * This API removes the rule usage from a given transaction type.
491  *
492  * <p><b>Licensing</b><br>
493  * This API is available for use with any licensed component of the
494  * e-business suite.
495  *
496  * <p><b>Prerequisites</b><br>
497  * The rule usage and the transaction type should be valid.
498  *
499  * <p><b>Post Success</b><br>
500  * The rule usage is removed from the given transaction type.
501  *
502  * <p><b>Post Failure</b><br>
503  * The rule usage is not removed from the given transaction type and
504  * an error is raised.
505  *
506  * @param p_validate If true, then validation alone will be performed and the
507  * database will remain unchanged. If false and all validation checks pass,
508  * then the database will be modified.
509  * @param p_rule_id This uniquely identifies the rule whose usage has to be
510  * deleted.
511  * @param p_application_id This uniquely identifies the transaction type from
512  * which the rule usage has to be removed.
513  * @param p_object_version_number Pass in the current version number of the
514  * rule usage to be deleted. When the API completes if p_validate is false,
515  * will be set to the new version number of the deleted rule usage. If
516  * p_validate is true will be set to the same value which was passed in.
517  * @param p_start_date If p_validate is false, it is set to the start date
518  * for the rule usage. If p_validate is true, it is set to null.
519  * @param p_end_date If p_validate is false, it is set to the end date of the
520  * rule usage. If p_validate is true, it is set to null.
521  * @rep:displayname Delete Ame Rule Usage
522  * @rep:category BUSINESS_ENTITY AME_RULE
523  * @rep:lifecycle active
524  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
525  * @rep:scope public
526 */
527 --
528 -- {End Of Comments}
529 --
530 procedure delete_ame_rule_usage
531   (p_validate                      in     boolean  default false
532   ,p_rule_id                       in     number
533   ,p_application_id                in     number
534   ,p_object_version_number         in out nocopy   number
535   ,p_start_date                    in out nocopy   date
536   ,p_end_date                      in out nocopy   date
537   );
538 --
539 -- ----------------------------------------------------------------------------
540 -- |------------------------< delete_ame_rule_condition >---------------------|
541 -- ----------------------------------------------------------------------------
542 --
543 -- {Start Of Comments}
544 /*#
545  * This API deletes the condition from the rule.
546  *
547  * <p><b>Licensing</b><br>
548  * This API is available for use with any licensed component of the
549  * e-business suite.
550  *
551  * <p><b>Prerequisites</b><br>
552  * The condition and the rule should be valid. The condition should be
553  * associated to the rule.
554  *
555  * <p><b>Post Success</b><br>
556  * The condition usage gets deleted for the rule.
557  *
558  * <p><b>Post Failure</b><br>
559  * The condition usage is not deleted from the rule and an error is raised.
560  *
561  * @param p_validate If true, then validation alone will be performed and the
562  * database will remain unchanged. If false and all validation checks pass,
563  * then the database will be modified.
564  * @param p_rule_id This uniquely identifies the rule for which the
565  * condition usage has to be deleted.
566  * @param p_condition_id This uniquely identifies the condition that has to
567  * be deleted from the rule.
568  * @param p_object_version_number If p_validate is false, it is set to the
569  * version number for the condition usage. If p_validate is true,
570  * it is set to null.
571  * @param p_start_date If p_validate is false, it is set to the start date
572  * of the condition usage. If p_validate is true, it is set to null.
573  * @param p_end_date If p_validate is false, it is set to the end date of
574  * the condition usage. If p_validate is true, it is set to null.
575  * @param p_effective_date This parameter is used to pass the effective date
576  * from the UI. This parameter is not used when the API is called directly.
577  * @rep:displayname Delete Ame Rule Condition
578  * @rep:category BUSINESS_ENTITY AME_RULE
579  * @rep:lifecycle active
580  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
581  * @rep:scope public
582 */
583 --
584 -- {End Of Comments}
585 --
586 procedure delete_ame_rule_condition
587   (p_validate                      in     boolean  default false
588   ,p_rule_id                       in     number
589   ,p_condition_id                  in     number
590   ,p_object_version_number         in out nocopy   number
591   ,p_start_date                       out nocopy   date
592   ,p_end_date                         out nocopy   date
593   ,p_effective_date               in     date      default null
594   );
595 --
596 -- ----------------------------------------------------------------------------
597 -- |--------------------------< delete_ame_rule_action >----------------------|
598 -- ----------------------------------------------------------------------------
599 --
600 -- {Start Of Comments}
601 /*#
602  * This API deletes an action from a rule.
603  *
604  * <p><b>Licensing</b><br>
605  * This API is available for use with any licensed component of the
606  * e-business suite.
607  *
608  * <p><b>Prerequisites</b><br>
609  * The action and the rule should be valid. The action should be
610  * associated to the rule.
611  *
612  * <p><b>Post Success</b><br>
613  * The action gets deleted from the rule.
614  *
615  * <p><b>Post Failure</b><br>
616  * The action is not deleted from the rule and an error is raised.
617  *
618  * @param p_validate If true, then validation alone will be performed and the
619  * database will remain unchanged. If false and all validation checks pass,
620  * then the database will be modified.
621  * @param p_rule_id ID (Unique identifier) of the rule for which the
622  * action usage has to be deleted.
623  * @param p_action_id This uniquely identifies the action that has to be
624  * deleted from the rule.
625  * @param p_object_version_number If p_validate is false, it is set to the
626  * version number for the action usage. If p_validate is true,
627  * it is set to null.
631  * action usage. If p_validate is true, it is set to null.
628  * @param p_start_date If p_validate is false, it is set to the start date
629  * of the action usage. If p_validate is true, it is set to null.
630  * @param p_end_date If p_validate is false, it is set to the end date of the
632  * @param p_effective_date This parameter is used to pass the effective date
633  * from the UI. This parameter is not used when the API is called directly.
634  * @rep:displayname Delete Ame Rule Action
635  * @rep:category BUSINESS_ENTITY AME_RULE
636  * @rep:lifecycle active
637  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
638  * @rep:scope public
639 */
640 --
641 -- {End Of Comments}
642 --
643 procedure delete_ame_rule_action
644   (p_validate                      in     boolean  default false
645   ,p_rule_id                       in     number
646   ,p_action_id                     in     number
647   ,p_object_version_number         in out nocopy   number
648   ,p_start_date                       out nocopy   date
649   ,p_end_date                         out nocopy   date
650   ,p_effective_date               in     date      default null
651   );
652 --
653 end ame_rule_api;