1 Package pay_event_procedures_api AUTHID CURRENT_USER as
2 /* $Header: pyevpapi.pkh 120.2 2005/10/24 00:52:54 adkumar noship $*/
3 /*#
4 * This package contains APIs for Event Procedures.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Event Procedure
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_event_proc >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an Event Procedure.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The event group to be deleted should exists.
24 *
25 * <p><b>Post Success</b><br>
26 * The Event Procedure has been successfully created.
27 *
28 * <p><b>Post Failure</b><br>
29 * If the column name argument is not a column on the table specified in the
30 * table name argument, raise error HR_xxxx_INVALID_COLUMN_NAME.
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_dated_table_id Identifies the dated table.
35 * @param p_procedure_name Procedure name
36 * @param p_business_group_id Business Group of the Record.
37 * @param p_legislation_code Legislation Code
38 * @param p_column_name Has to be a column on the dated table. Out Parameters:
39 * Name Type Description
40 * @param p_event_procedure_id Primary Key of the record.
41 * @param p_object_version_number If p_validate is false, then set to the
42 * version number of the created event procedure. If p_validate is true, then
43 * the value will be null.
44 * @rep:displayname Create Event Procedure
45 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_TABLE_REC_EVENT
46 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
47 * @rep:scope public
48 * @rep:lifecycle active
49 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
50 */
51 --
52 -- {End Of Comments}
53 --
54 procedure create_event_proc
55 (p_validate in boolean default false
56 ,p_dated_table_id in number
57 ,p_procedure_name in varchar2 default null
58 ,p_business_group_id in number default null
59 ,p_legislation_code in varchar2 default null
60 ,p_column_name in varchar2 default null
61 ,p_event_procedure_id out nocopy number
62 ,p_object_version_number out nocopy number
63 );
64 --
65 -- ----------------------------------------------------------------------------
66 -- |----------------------------< update_event_proc >-------------------------|
67 -- ----------------------------------------------------------------------------
68 --
69 -- {Start Of Comments}
70 /*#
71 * This API updates an Event Procedure.
72 *
73 *
74 * <p><b>Licensing</b><br>
75 * This API is licensed for use with Human Resources.
76 *
77 * <p><b>Prerequisites</b><br>
78 * The event procedure to be updated should exists.
79 *
80 * <p><b>Post Success</b><br>
81 * The Event Procedure has been successfully updated.
82 *
83 * <p><b>Post Failure</b><br>
84 * If the column name argument is not a column on the table specified in the
85 * table name argument, raise error HR_xxxx_INVALID_COLUMN_NAME.
86 * @param p_validate If true, then validation alone will be performed and the
87 * database will remain unchanged. If false and all validation checks pass,
88 * then the database will be modified.
89 * @param p_event_procedure_id Primary Key of the record.
90 * @param p_object_version_number Pass in the current version number of the
91 * event procedure to be updated. When the API completes if p_validate is
92 * false, will be set to the new version number of the updated event procedure.
93 * If p_validate is true will be set to the same value which was passed in.
94 * @param p_dated_table_id Identifies the dated table.
95 * @param p_procedure_name Procedure name
96 * @param p_business_group_id Business Group of the Record.
97 * @param p_legislation_code Legislation Code
98 * @param p_column_name Has to be a column on the dated table. Out Parameters:
99 * Name Type Description
100 * @rep:displayname Update Event Procedure
101 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_TABLE_REC_EVENT
102 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
103 * @rep:scope public
104 * @rep:lifecycle active
105 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
106 */
107 --
108 -- {End Of Comments}
109 --
110 Procedure update_event_proc
111 (p_validate in boolean default false
112 ,p_event_procedure_id in number
113 ,p_object_version_number in out nocopy number
114 ,p_dated_table_id in number default hr_api.g_number
115 ,p_procedure_name in varchar2 default hr_api.g_varchar2
116 ,p_business_group_id in number default hr_api.g_number
117 ,p_legislation_code in varchar2 default hr_api.g_varchar2
118 ,p_column_name in varchar2 default hr_api.g_varchar2
119 );
120 --
121 -- ----------------------------------------------------------------------------
122 -- |----------------------------< delete_event_proc >-------------------------|
123 -- ----------------------------------------------------------------------------
124 --
125 -- {Start Of Comments}
126 /*#
127 * This API deletes an Event Procedure.
128 *
129 *
130 * <p><b>Licensing</b><br>
131 * This API is licensed for use with Human Resources.
132 *
133 * <p><b>Prerequisites</b><br>
134 * The event procedure to be deleted should exists.
135 *
136 * <p><b>Post Success</b><br>
137 * The Event Procedure has been successfully deleted.
138 *
139 * <p><b>Post Failure</b><br>
140 * An error will be raised and the Event Procedure will not be deleted.
141 * @param p_validate If true, then validation alone will be performed and the
142 * database will remain unchanged. If false and all validation checks pass,
143 * then the database will be modified.
144 * @param p_event_procedure_id Primary Key of the record.
145 * @param p_object_version_number Pass in the current version number of the
146 * Event Group to be deleted. When the API completes if p_validate is false,
147 * will be set to the new version number of the deleted Event Group. If
148 * p_validate is true will be set to the same value which was passed in.
149 * @rep:displayname Delete Event Procedure
150 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_TABLE_REC_EVENT
151 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
152 * @rep:scope public
153 * @rep:lifecycle active
154 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
155 */
156 --
157 -- {End Of Comments}
158 --
159 Procedure delete_event_proc
160 (
161 p_validate in boolean default false
162 ,p_event_procedure_id in number
163 ,p_object_version_number in out nocopy number
164 );
165 --
166 end pay_event_procedures_api;
167 --
[Home] [Help]