1 Package pay_event_groups_api AUTHID CURRENT_USER as
2 /* $Header: pyevgapi.pkh 120.3 2005/10/24 01:00:46 adkumar noship $ */
3 /*#
4 * This package contains APIs for Event Groups.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Event Groups
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_event_group >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an Event Group.
17 *
18 * Used in the Interpretation phase of the Payroll Events Model.
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Human Resources.
22 *
23 * <p><b>Prerequisites</b><br>
24 * A valid business group should exists.
25 *
26 * <p><b>Post Success</b><br>
27 * The Event Group has been successfully created.
28 *
29 * <p><b>Post Failure</b><br>
30 * If the event group type is not a recognisable value for the lookup type
31 * EVENT_GROUP_TYPE, then raise error HR_xxxx_INVALID_EVENT_GROUP. Also if the
32 * proration period type is not a recognisable value for the lookup type
33 * PRORATION_PERIOD_TYPE, raise error HR_xxxx_INVALID_PERIOD_TYPE.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Reference date for validating lookup values are
38 * applicable during the start to end active date range. This date does not
39 * determine when the changes take effect.
40 * @param p_event_group_name Event Group Name
41 * @param p_event_group_type Taken from EVENT_GROUP_TYPE lookup
42 * @param p_proration_type Taken from PRORATION_PERIOD_TYPE lookup.
43 * @param p_business_group_id Business Group of the Record.
44 * @param p_legislation_code Legislation Code
45 * @param p_event_group_id Primary Key of the record.
46 * @param p_object_version_number If p_validate is false, then set to the
47 * version number of the createdevent group. If p_validate is true, then the
48 * value will be null.
49 * @param p_time_definition_id Identifier for the time definition.
50 * @rep:displayname Create Event Group
51 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_EVENT_GROUP
52 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
53 * @rep:scope public
54 * @rep:lifecycle active
55 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
56 */
57 --
58 -- {End Of Comments}
59 --
60 procedure create_event_group
61 (
62 p_validate in boolean default false
63 ,p_effective_date in date
64 ,p_event_group_name in varchar2
65 ,p_event_group_type in varchar2
66 ,p_proration_type in varchar2 default null
67 ,p_business_group_id in number default null
68 ,p_legislation_code in varchar2 default null
69 ,p_event_group_id out nocopy number
70 ,p_object_version_number out nocopy number
71 ,p_time_definition_id in number default null
72 );
73 --
74 -- ----------------------------------------------------------------------------
75 -- |----------------------------< update_event_group >------------------------|
76 -- ----------------------------------------------------------------------------
77 --
78 -- {Start Of Comments}
79 /*#
80 * This API updates an Event Group.
81 *
82 * Used in the Interpretation phase of the Payroll Events Model.
83 *
84 * <p><b>Licensing</b><br>
85 * This API is licensed for use with Human Resources.
86 *
87 * <p><b>Prerequisites</b><br>
88 * The event group to be updated should exists.
89 *
90 * <p><b>Post Success</b><br>
91 * The Event Group has been successfully updated.
92 *
93 * <p><b>Post Failure</b><br>
94 * If the event group type is not a recognisable value for the lookup type
95 * EVENT_GROUP_TYPE, then raise error HR_xxxx_INVALID_EVENT_GROUP. Also if the
96 * proration period type is not a recognisable value for the lookup type
97 * PRORATION_PERIOD_TYPE, raise error HR_xxxx_INVALID_PERIOD_TYPE.
98 * @param p_validate If true, then validation alone will be performed and the
99 * database will remain unchanged. If false and all validation checks pass,
100 * then the database will be modified.
101 * @param p_effective_date Reference date for validating lookup values are
102 * applicable during the start to end active date range. This date does not
103 * determine when the changes take effect.
104 * @param p_event_group_id Primary Key of the record.
105 * @param p_object_version_number Pass in the current version number of the
106 * event group to be updated. When the API completes if p_validate is false,
107 * will be set to the new version number of the updated event group. If
108 * p_validate is true will be set to the same value which was passed in.
109 * @param p_event_group_name Event Group Name
110 * @param p_event_group_type Taken from EVENT_GROUP_TYPE lookup
111 * @param p_proration_type Taken from PRORATION_PERIOD_TYPE lookup.
112 * @param p_business_group_id Business Group of the Record.
113 * @param p_legislation_code Legislation Code
114 * @param p_time_definition_id Identifier for the time definition.
115 * @rep:displayname Update Event Group
116 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_EVENT_GROUP
117 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
118 * @rep:scope public
119 * @rep:lifecycle active
120 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
121 */
122 --
123 -- {End Of Comments}
124 --
125 procedure update_event_group
126 (
127 p_validate in boolean default false
128 ,p_effective_date in date
129 ,p_event_group_id in number
130 ,p_object_version_number in out nocopy number
131 ,p_event_group_name in varchar2 default hr_api.g_varchar2
132 ,p_event_group_type in varchar2 default hr_api.g_varchar2
133 ,p_proration_type in varchar2 default hr_api.g_varchar2
134 ,p_business_group_id in number default hr_api.g_number
135 ,p_legislation_code in varchar2 default hr_api.g_varchar2
136 ,p_time_definition_id in number default hr_api.g_number
137 );
138 --
139 -- ----------------------------------------------------------------------------
140 -- |----------------------------< delete_event_group >------------------------|
141 -- ----------------------------------------------------------------------------
142 --
143 -- {Start Of Comments}
144 /*#
145 * This API deletes an Event Group.
146 *
147 * Used in the Interpretation phase of the Payroll Events Model.
148 *
149 * <p><b>Licensing</b><br>
150 * This API is licensed for use with Human Resources.
151 *
152 * <p><b>Prerequisites</b><br>
153 * The event group to be deleted should exists.
154 *
155 * <p><b>Post Success</b><br>
156 * The Event Group has been successfully deleted.
157 *
158 * <p><b>Post Failure</b><br>
159 * The Event Group will not be deleted.
160 * @param p_validate If true, then validation alone will be performed and the
161 * database will remain unchanged. If false and all validation checks pass,
162 * then the database will be modified.
163 * @param p_event_group_id Primary Key of the record.
164 * @param p_object_version_number Pass in the current version number of the
165 * Event Group to be deleted. When the API completes if p_validate is false,
166 * will be set to the new version number of the deleted Event Group. If
167 * p_validate is true will be set to the same value which was passed in.
168 * @rep:displayname Delete Event Group
169 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_EVENT_GROUP
170 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
171 * @rep:scope public
172 * @rep:lifecycle active
173 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
174 */
175 --
176 -- {End Of Comments}
177 --
178 procedure delete_event_group
179 (
180 p_validate in boolean default false
181 ,p_event_group_id in number
182 ,p_object_version_number in number
183 );
184 --
185 -- ----------------------------------------------------------------------------
186 -- |------------------------< lck_event_group >------------------------|
187 -- ----------------------------------------------------------------------------
188 -- {Start Of Comments}
189 --
190 -- Description:
191 --
192 -- Prerequisites:
193 --
194 --
195 -- In Parameters:
196 -- Name Reqd Type Description
197 --
198 -- Post Success:
199 --
200 -- Out Parameters:
201 -- Name Type Description
202 --
203 -- Post Failure:
204 --
205 -- Access Status:
206 -- Public.
207 --
208 -- {End Of Comments}
209 --
210 /*procedure lck_event_group
211 (
212 p_effective_date in date
213 ,p_datetrack_mode in varchar2
214 ,p_iterative_rule_id in number
215 ,p_object_version_number in number
216 ,p_validation_start_date out nocopy date
217 ,p_validation_end_date out nocopy date
218 );
219 */
220 --
221 end pay_event_groups_api;
[Home] [Help]