1 Package hr_cagr_ent_item_api as
2 /* $Header: peceiapi.pkh 120.2 2006/10/18 08:49:35 grreddy noship $ */
3 /*#
4 * This package contains APIs that maintain collective agreement entitlement
5 * items.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Collective Agreement Entitlement Item
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------< create_cagr_entitlement_item >-------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a collective agreement entitlement item.
18 *
19 * An entitlement item is a basic unit of a collective agreement relating to a
20 * specific term of employment that employees receive. For example, the Normal
21 * Working Hours entitlement item holds meta-data that describes working hours
22 * as a term of employment on the assignment. A collective agreement is likely
23 * to comprise of many different entitlement items, grouped into categories, to
24 * represent its varied terms. An entitlement item may be used in one or more
25 * collective agreements.
26 *
27 * <p><b>Licensing</b><br>
28 * This API is licensed for use with Human Resources.
29 *
30 * <p><b>Prerequisites</b><br>
31 * None.
32 *
33 * <p><b>Post Success</b><br>
34 * An entitlement item record will be created.
35 *
36 * <p><b>Post Failure</b><br>
37 * The entitlement item record will not be created and an error will be raised.
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_effective_date Reference date for validating lookup values are
42 * applicable during the start to end active date range. This date does not
43 * determine when the changes take effect.
44 * @param p_language_code Specifies to which language the translation values
45 * apply. You can set to the base or any installed language. The default value
46 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
47 * value.
48 * @param p_business_group_id The business group of the record.
49 * @param p_item_name The Name of the Entitlement Item (in the language
50 * specified by the language_code parameter).
51 * @param p_element_type_id The element type to which this item corresponds, if
52 * the item is of category 'Payroll'.
53 * @param p_input_value_id The input value to which this item corresponds, if
54 * the item is of category 'Payroll'.
55 * @param p_column_type The data type of the entitlement item. Valid values are
56 * defined by the 'CAGR_PARAM_TYPES' lookup type.
57 * @param p_column_size The maximum size of the entitlement item, for the
58 * column type (data type).
59 * @param p_legislation_code The legislation code of the entitlement item.
60 * @param p_beneficial_rule The beneficial rule for the entitlement item. Valid
61 * values are defined by the 'CAGR_BENEFICIAL_RULE' lookup type.
62 * @param p_cagr_api_param_id The API parameter that will be used to propagate
63 * the entitlement item's value during collective agreement processing.
64 * @param p_category_name The category of the entitlement item. Valid values
65 * are defined by the 'CAGR_CATEGORIES' lookup type.
66 * @param p_beneficial_formula_id The fast formula to be used to determine the
67 * beneficial rule.
68 * @param p_uom The unit of measure the entitlement item value is expressed in.
69 * Valid values are defined by the 'UNITS' lookup type.
70 * @param p_flex_value_set_id The value set supplying values for the
71 * entitlement item.
72 * @param p_ben_rule_value_set_id The value set determining the beneficial
73 * rule.
74 * @param p_mult_entries_allowed_flag Indicates whether more than one element
75 * entry may be modified for the element type parameter, during collective
76 * agreement processing.
77 * @param p_auto_create_entries_flag Indicates whether an element entry should
78 * be created for the element type parameter, where one does not already exist,
79 * during collective agreement processing.
80 * @param p_object_version_number If p_validate is false, then set to the
81 * version number of the created entitlement item. If p_validate is true, then
82 * the value will be null.
83 * @param p_cagr_entitlement_item_id If p_validate is false, then this uniquely
84 * identifies the entitlement item created. If p_validate is true, then set to
85 * null.
86 * @param p_opt_id If p_validate is false, then this uniquely identifies the
87 * option compensation object created. If p_validate is true, then set to null.
88 * @rep:displayname Create Collective Agreement Entitlement Item
89 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT_ITEM
90 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
91 * @rep:scope public
92 * @rep:lifecycle active
93 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
94 */
95 --
96 -- {End Of Comments}
97 --
98 procedure create_cagr_entitlement_item
99 (p_validate in boolean default false
100 ,p_effective_date in date
101 ,p_language_code IN varchar2 default hr_api.userenv_lang
102 ,p_business_group_id in number default null
103 ,p_item_name in varchar2
104 ,p_element_type_id in number default null
105 ,p_input_value_id in varchar2 default null
106 ,p_column_type in varchar2
107 ,p_column_size in number default 2000
108 ,p_legislation_code in varchar2 default null
109 ,p_beneficial_rule in varchar2 default null
110 ,p_cagr_api_param_id in number default null
111 ,p_category_name in varchar2
112 ,p_beneficial_formula_id in number default null
113 ,p_uom in varchar2
114 ,p_flex_value_set_id in number default null
115 ,p_ben_rule_value_set_id in number default null
116 ,p_mult_entries_allowed_flag in varchar2 default null
117 ,p_auto_create_entries_flag in varchar2 default null -- CEI Enh
118 ,p_object_version_number out nocopy number
119 ,p_cagr_entitlement_item_id out nocopy number
120 ,p_opt_id out nocopy number
121 );
122 --
123 -- ----------------------------------------------------------------------------
124 -- |-----------------------< update_cagr_entitlement_item >-------------------|
125 -- ----------------------------------------------------------------------------
126 --
127 -- {Start Of Comments}
128 /*#
129 * This API updates a collective agreement entitlement item.
130 *
131 * An entitlement item is a basic unit of a collective agreement relating to a
132 * specific term of employment that employees receive. For example, the Normal
133 * Working Hours entitlement item holds meta-data that describes working hours
134 * as a term of employment on the assignment. A collective agreement is likely
135 * to comprise of many different entitlement items, grouped into categories, to
136 * represent its varied terms. An entitlement item may be used in one or more
137 * collective agreements.
138 *
139 * <p><b>Licensing</b><br>
140 * This API is licensed for use with Human Resources.
141 *
142 * <p><b>Prerequisites</b><br>
143 * The entitlement item record to be updated must exist.
144 *
145 * <p><b>Post Success</b><br>
146 * An entitlement item record will be updated.
147 *
148 * <p><b>Post Failure</b><br>
149 * The entitlement item record will not be updated and an error will be raised.
150 * @param p_validate If true, then validation alone will be performed and the
151 * database will remain unchanged. If false and all validation checks pass,
152 * then the database will be modified.
153 * @param p_effective_date Reference date for validating lookup values are
154 * applicable during the start to end active date range. This date does not
155 * determine when the changes take effect.
156 * @param p_language_code Specifies to which language the translation values
157 * apply. You can set to the base or any installed language. The default value
158 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
159 * value.
160 * @param p_cagr_entitlement_item_id This uniquely identifies the entitlement
161 * item to be updated.
162 * @param p_business_group_id The business group of the record.
163 * @param p_item_name The Name of the Entitlement Item (in the language
164 * specified by the language_code parameter).
165 * @param p_element_type_id The element type to which this item corresponds, if
166 * the item is of category 'Payroll'.
167 * @param p_input_value_id The input value to which this item corresponds, if
168 * the item is of category 'Payroll'.
169 * @param p_column_type The data type of the entitlement item. Valid values are
170 * defined by the 'CAGR_PARAM_TYPES' lookup type.
171 * @param p_column_size The maximum size of the entitlement item, for the
172 * column type (data type).
173 * @param p_legislation_code The legislation code of the entitlement item.
174 * @param p_beneficial_rule The beneficial rule for the entitlement item. Valid
175 * values are defined by the 'CAGR_BENEFICIAL_RULE' lookup type.
176 * @param p_cagr_api_param_id The API parameter that will be used to propagate
177 * the entitlement item's value during collective agreement processing.
178 * @param p_category_name The category of the entitlement item. Valid values
179 * are defined by the 'CAGR_CATEGORIES' lookup type.
180 * @param p_beneficial_formula_id The fast formula to be used to determine the
181 * beneficial rule.
182 * @param p_uom The unit of measure the entitlement item value is expressed in.
183 * Valid values are defined by the 'UNITS' lookup type.
184 * @param p_flex_value_set_id The value set supplying values for the
185 * entitlement item.
186 * @param p_ben_rule_value_set_id The value set determining the beneficial
187 * rule.
188 * @param p_mult_entries_allowed_flag Indicates whether more than one element
189 * entry may be modified for the element type parameter, during collective
190 * agreement processing.
191 * @param p_object_version_number Pass in the current version number of the
192 * entitlement item to be updated. When the API completes if p_validate is
193 * false, will be set to the new version number of the updated person. If
194 * p_validate is true will be set to the same value which was passed in.
195 * @rep:displayname Update Collective Agreement Entitlement Item
196 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT_ITEM
197 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
198 * @rep:scope public
199 * @rep:lifecycle active
200 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
201 */
202 --
203 -- {End Of Comments}
204 --
205 procedure update_cagr_entitlement_item
206 (p_validate in boolean default false
207 ,p_effective_date in date
208 ,p_language_code in varchar2 default hr_api.userenv_lang
209 ,p_cagr_entitlement_item_id in number default hr_api.g_number
210 ,p_business_group_id in number default hr_api.g_number
211 ,p_item_name in varchar2 default hr_api.g_varchar2
212 ,p_element_type_id in number default hr_api.g_number
213 ,p_input_value_id in varchar2 default hr_api.g_varchar2
214 ,p_column_type in varchar2 default hr_api.g_varchar2
215 ,p_column_size in number default hr_api.g_number
216 ,p_legislation_code in varchar2 default hr_api.g_varchar2
217 ,p_beneficial_rule in varchar2 default hr_api.g_varchar2
218 ,p_cagr_api_param_id in number default hr_api.g_number
219 ,p_category_name in varchar2 default hr_api.g_varchar2
220 ,p_beneficial_formula_id in number default hr_api.g_number
221 ,p_uom in varchar2 default hr_api.g_varchar2
222 ,p_flex_value_set_id in number default hr_api.g_number
223 ,p_ben_rule_value_set_id in number default hr_api.g_number
224 ,p_mult_entries_allowed_flag in varchar2 default hr_api.g_varchar2
225 ,p_object_version_number in out nocopy number
226 );
227 --
228 -- ----------------------------------------------------------------------------
229 -- |-----------------------< delete_cagr_entitlement_item >-------------------|
230 -- ----------------------------------------------------------------------------
231 --
232 -- {Start Of Comments}
233 /*#
234 * This API deletes a collective agreement entitlement item.
235 *
236 * An entitlement item is a basic unit of a collective agreement relating to a
237 * specific term of employment that employees receive. For example, the Normal
238 * Working Hours entitlement item holds meta-data that describes working hours
239 * as a term of employment on the assignment. A collective agreement is likely
240 * to comprise of many different entitlement items, grouped into categories, to
241 * represent its varied terms. An entitlement item may be used in one or more
242 * collective agreements.
243 *
244 * <p><b>Licensing</b><br>
245 * This API is licensed for use with Human Resources.
246 *
247 * <p><b>Prerequisites</b><br>
248 * The entitlement item must exist.
249 *
250 * <p><b>Post Success</b><br>
251 * The entitlement item record will be deleted.
252 *
253 * <p><b>Post Failure</b><br>
254 * The entitlement item record will not be deleted and an error will be raised.
255 * @param p_validate If true, then validation alone will be performed and the
256 * database will remain unchanged. If false and all validation checks pass,
257 * then the database will be modified.
258 * @param p_effective_date Reference date for validating lookup values are
259 * applicable during the start to end active date range. This date does not
260 * determine when the changes take effect.
261 * @param p_cagr_entitlement_item_id This uniquely identifies the entitlement
262 * item to be deleted.
263 * @param p_object_version_number Current object version number of the
264 * entitlement item to be deleted.
265 * @rep:displayname Delete Collective Agreement Entitlement Item
266 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT_ITEM
267 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
268 * @rep:scope public
269 * @rep:lifecycle active
270 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
271 */
272 --
273 -- {End Of Comments}
274 --
275 procedure delete_cagr_entitlement_item
276 (p_validate in boolean default false
277 ,p_effective_date in date
278 ,p_cagr_entitlement_item_id in number
279 ,p_object_version_number in out nocopy number
280 );
281 --
282 end hr_cagr_ent_item_api;
[Home] [Help]