1 Package pay_event_updates_api as
2 /* $Header: pypeuapi.pkh 120.1 2005/10/02 02:32:43 aroussel $ */
3 /*#
4 * This package contains APIs for Event Updates.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Event Update
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_event_update >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an Event Update.
17 *
18 * Event Updates are child rows of Dated Tables and are used in the Capture
19 * phase of the Payroll Events Model.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The business group where this record to be created should exist.
26 *
27 * <p><b>Post Success</b><br>
28 * The Event Update has been successfully created.
29 *
30 * <p><b>Post Failure</b><br>
31 * If the change type argument is not a recognisable value for the lookup type
32 * PROCESS_EVENT_TYPE, then raise error HR_xxxx_INVALID_CHANGE_TYPE. Also if
33 * the event type argument is not a recognisable value for the lookup type
34 * EVENT_TYPE, then raise error HR_xxxx_INVALID_EVENT_TYPE.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Reference date for validating lookup values are
39 * applicable during the start to end active date range. This date does not
40 * determine when the changes take effect.
41 * @param p_dated_table_id Dated Table
42 * @param p_change_type Taken from PROCESS_EVENT_TYPE lookup
43 * @param p_table_name Dated Table Name.
44 * @param p_column_name Mandatory only if update_type ='UPDATE'. Should be a
45 * column name off the dated table.
46 * @param p_business_group_id Business Group of the Record.
47 * @param p_legislation_code Legislation Code
48 * @param p_event_type Taken from EVENT_TYPE lookup. Out Parameters: Name Type
49 * Description
50 * @param p_event_update_id If p_validate is false, this uniquely identifies
51 * the created even update. If p_validate is set to true, this parameter will
52 * be null.
53 * @param p_object_version_number If p_validate is false, then set to the
54 * version number of the created event update. If p_validate is true, then the
55 * value will be null.
56 * @rep:displayname Create Event Update
57 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_TABLE_REC_EVENT
58 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
59 * @rep:scope public
60 * @rep:lifecycle active
61 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
62 */
63 --
64 -- {End Of Comments}
65 --
66 procedure create_event_update
67 (
68 p_validate in boolean default false
69 ,p_effective_date in date
70 ,p_dated_table_id in number
71 ,p_change_type in varchar2
72 ,p_table_name in varchar2 default null
73 ,p_column_name in varchar2 default null
74 ,p_business_group_id in number default null
75 ,p_legislation_code in varchar2 default null
76 ,p_event_type in varchar2 default null
77 ,p_event_update_id out nocopy number
78 ,p_object_version_number out nocopy number
79 );
80 --
81 -- ----------------------------------------------------------------------------
82 -- |---------------------------< update_event_update >------------------------|
83 -- ----------------------------------------------------------------------------
84 --
85 -- {Start Of Comments}
86 /*#
87 * This API updates an Event Update.
88 *
89 * Event Updates are child rows of Dated Tables and are used in the Capture
90 * phase of the Payroll Events Model.
91 *
92 * <p><b>Licensing</b><br>
93 * This API is licensed for use with Human Resources.
94 *
95 * <p><b>Prerequisites</b><br>
96 * The event update to be updated should exist.
97 *
98 * <p><b>Post Success</b><br>
99 * The Event Update has been successfully updated.
100 *
101 * <p><b>Post Failure</b><br>
102 * If the change type argument is not a recognisable value for the lookup type
103 * PROCESS_EVENT_TYPE, then raise error HR_xxxx_INVALID_CHANGE_TYPE. Also if
104 * the event type argument is not a recognisable value for the lookup type
105 * EVENT_TYPE, then raise error HR_xxxx_INVALID_EVENT_TYPE.
106 * @param p_validate If true, then validation alone will be performed and the
107 * database will remain unchanged. If false and all validation checks pass,
108 * then the database will be modified.
109 * @param p_effective_date Reference date for validating lookup values are
110 * applicable during the start to end active date range. This date does not
111 * determine when the changes take effect.
112 * @param p_event_update_id Primary Key of the record.
113 * @param p_object_version_number Pass in the current version number of the
114 * event update to be updated. When the API completes if p_validate is false,
115 * will be set to the new version number of the updated event update. If
116 * p_validate is true will be set to the same value which was passed in.
117 * @param p_dated_table_id Dated Table
118 * @param p_change_type Taken from PROCESS_EVENT_TYPE lookup
119 * @param p_table_name Dated Table Name.
120 * @param p_column_name Mandatory only if update_type ='UPDATE'. Should be a
121 * column name of the dated table.
122 * @param p_business_group_id Business Group of the Record.
123 * @param p_legislation_code Legislation Code
124 * @param p_event_type Taken from EVENT_TYPE lookup. Out Parameters Name Type
125 * Description/Valid Values
126 * @rep:displayname Update Event Update
127 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_TABLE_REC_EVENT
128 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
129 * @rep:scope public
130 * @rep:lifecycle active
131 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
132 */
133 --
134 -- {End Of Comments}
135 --
136 procedure update_event_update
137 (
138 p_validate in boolean default false
139 ,p_effective_date in date
140 ,p_event_update_id in number
141 ,p_object_version_number in out nocopy number
142 ,p_dated_table_id in number default hr_api.g_number
143 ,p_change_type in varchar2 default hr_api.g_varchar2
144 ,p_table_name in varchar2 default hr_api.g_varchar2
145 ,p_column_name in varchar2 default hr_api.g_varchar2
146 ,p_business_group_id in number default hr_api.g_number
147 ,p_legislation_code in varchar2 default hr_api.g_varchar2
148 ,p_event_type in varchar2 default hr_api.g_varchar2
149 );
150 --
151 -- ----------------------------------------------------------------------------
152 -- |---------------------------< delete_event_update >------------------------|
153 -- ----------------------------------------------------------------------------
154 --
155 -- {Start Of Comments}
156 /*#
157 * This API deletes an Event Update.
158 *
159 * Event Updates are child rows of Dated Tables and are used in the Capture
160 * phase of the Payroll Events Model.
161 *
162 * <p><b>Licensing</b><br>
163 * This API is licensed for use with Human Resources.
164 *
165 * <p><b>Prerequisites</b><br>
166 * The event update to be deleted should exist.
167 *
168 * <p><b>Post Success</b><br>
169 * The Event Update has been successfully deleted.
170 *
171 * <p><b>Post Failure</b><br>
172 * The API does not delete the event update and raises an error.
173 * @param p_validate If true, then validation alone will be performed and the
174 * database will remain unchanged. If false and all validation checks pass,
175 * then the database will be modified.
176 * @param p_event_update_id Primary Key of the record.
177 * @param p_object_version_number Pass in the current version number of the
178 * Event Update to be deleted. When the API completes if p_validate is false,
179 * will be set to the new version number of the deleted Event Update. If
180 * p_validate is true will be set to the same value which was passed in.
181 * @rep:displayname Delete Event Update
182 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_TABLE_REC_EVENT
183 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
184 * @rep:scope public
185 * @rep:lifecycle active
186 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
187 */
188 --
189 -- {End Of Comments}
190 --
191 procedure delete_event_update
192 (
193 p_validate in boolean default false
194 ,p_event_update_id in number
195 ,p_object_version_number in number
196 );
197 end pay_event_updates_api;
[Home] [Help]