1 Package pay_ncr_api AUTHID CURRENT_USER as
2 /* $Header: pyncrapi.pkh 120.0.12010.3 2006/06/21 11:27:54 rvarshne noship $ */
3 /*#
4 * This package contains Net Calculation Rule APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Net Calculation Rule
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------< create_pay_net_calc_rule >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a net calculation rule for an accrual plan.
17 *
18 * Use this API to create additional net calculation rules. A net calculation
19 * rule contains a reference to an element type and an input value. When
20 * calculating net entitlements, the application adds or subtracts the entry
21 * values for each element associated with a net calculation rule. When you
22 * create a new accrual plan, the application automatically creates one net
23 * calculation rule for Absences and one for carry over.
24 *
25 * <p><b>Licensing</b><br>
26 * This API is licensed for use with Human Resources.
27 *
28 * <p><b>Prerequisites</b><br>
29 * The accrual plan for which this net calculation rule is being created must
30 * already exist. The element type and input value that is to be used as a net
31 * calculation rule must already exist.
32 *
33 * <p><b>Post Success</b><br>
34 * The net calculation rule will have been created.
35 *
36 * <p><b>Post Failure</b><br>
37 * The net calculation rule 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_business_group_id The business group under which the net
42 * calculation rule is created.
43 * @param p_accrual_plan_id Uniquely identifies the accrual plan for which this
44 * net calculation rule is created.
45 * @param p_input_value_id Uniquely identifies the input value the application
46 * uses to include additional element entries in the net entitlement
47 * calculations for paid time off.
48 * @param p_add_or_subtract Determines whether the entry value should add to or
49 * subtract from the net entitlement. Valid values are 1 (Add) and -1
50 * (Subtract).
51 * @param p_date_input_value_id Uniquely identifies the date input value the
52 * application uses to determine the date to adjust the paid time off net
53 * entitlement balance.
54 * @param p_net_calculation_rule_id If p_validate is false, then this uniquely
55 * identifies the Net Calculation Rule. If p_validate is true, then this is set
56 * to null.
57 * @param p_object_version_number If p_validate is false, then set to the
58 * version number of the created Net Calculation Rule. If p_validate is true,
59 * then the value will be null.
60 * @rep:displayname Create Net Calculation Rule
61 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ABSENCE
62 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
63 * @rep:scope public
64 * @rep:lifecycle active
65 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
66 */
67 --
68 -- {End Of Comments}
69 --
70 procedure create_pay_net_calc_rule
71 (p_validate in boolean default false
72 ,p_business_group_id in number
73 ,p_accrual_plan_id in number
74 ,p_input_value_id in number
75 ,p_add_or_subtract in varchar2
76 ,p_date_input_value_id in number default null
77 ,p_net_calculation_rule_id out nocopy number
78 ,p_object_version_number out nocopy number
79 );
80 --
81
82 -- ----------------------------------------------------------------------------
83 -- |-----------------------< update_pay_net_calc_rule >-----------------------|
84 -- ----------------------------------------------------------------------------
85 -- {Start Of Comments}
86 /*#
87 * This API updates a net calculation rule for an accrual plan.
88 *
89 * Use this API to update net calculation rules. A net calculation rule
90 * contains a reference to an element type and an input value. When calculating
91 * net entitlements, the application adds or subtracts the entry values for
92 * each element associated with a net calculation rule. When you create a new
93 * accrual plan, the application automatically creates one net calculation rule
94 * for Absences and one for carry over.
95 *
96 * <p><b>Licensing</b><br>
97 * This API is licensed for use with Human Resources.
98 *
99 * <p><b>Prerequisites</b><br>
100 * The net calculation rule being updated must already exist.
101 *
102 * <p><b>Post Success</b><br>
103 * The net calculation rule will have been updated.
104 *
105 * <p><b>Post Failure</b><br>
106 * The net calculation rule will not be updated and an error will be raised.
107 * @param p_validate If true, then validation alone will be performed and the
108 * database will remain unchanged. If false and all validation checks pass,
109 * then the database will be modified.
110 * @param p_net_calculation_rule_id Uniquely identifies the net calculation
111 * rule that is being updated.
112 * @param p_accrual_plan_id Uniquely identifies the accrual plan for which this
113 * net calculation rule is being updated, implying that the rule will move from
114 * one accrual plan to another.
115 * @param p_input_value_id Uniquely identifies the input value used by the
116 * application to include additional element entries in the net entitlement
117 * calculations for paid time off.
118 * @param p_add_or_subtract Determines whether the entry value should add to or
119 * subtract from the net entitlement. Valid values are 1 (Add) and -1
120 * (Subtract).
121 * @param p_date_input_value_id Uniquely identifies the date input value the
122 * application uses to determine the date to adjust the paid time off net
123 * entitlement balance.
124 * @param p_object_version_number Pass in the current version number of the Net
125 * Calculation Rule to be updated. When the API completes if p_validate is
126 * false, will be set to the new version number of the updated Net Calculation
127 * Rule. If p_validate is true will be set to the same value which was passed
128 * in.
129 * @rep:displayname Update Net Calculation Rule
130 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ABSENCE
131 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
132 * @rep:scope public
133 * @rep:lifecycle active
134 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
135 */
136 --
137 -- {End Of Comments}
138 --
139 procedure update_pay_net_calc_rule
140 (p_validate in boolean default false
141 ,p_net_calculation_rule_id in number
142 ,p_accrual_plan_id in number default hr_api.g_number
143 ,p_input_value_id in number default hr_api.g_number
144 ,p_add_or_subtract in varchar2 default hr_api.g_varchar2
145 ,p_date_input_value_id in number default hr_api.g_number
146 ,p_object_version_number in out nocopy number
147 );
148 --
149
150 -- ----------------------------------------------------------------------------
151 -- |-----------------------< delete_pay_net_calc_rule >-----------------------|
152 -- ----------------------------------------------------------------------------
153 -- {Start Of Comments}
154 /*#
155 * This API deletes a net calculation rule for an accrual plan.
156 *
157 * A net calculation rule contains a reference to an element type and an input
158 * value. When calculating net entitlements, the application adds or subtracts
159 * the entry values for each element associated with a net calculation rule.
160 *
161 * <p><b>Licensing</b><br>
162 * This API is licensed for use with Human Resources.
163 *
164 * <p><b>Prerequisites</b><br>
165 * The net calculation rule being deleted must already exist.
166 *
167 * <p><b>Post Success</b><br>
168 * The net calculation rule will have been deleted.
169 *
170 * <p><b>Post Failure</b><br>
171 * The net calculation rule will not be deleted and an error will be raised.
172 * @param p_validate If true, then validation alone will be performed and the
173 * database will remain unchanged. If false and all validation checks pass,
174 * then the database will be modified.
175 * @param p_net_calculation_rule_id Uniquely identifies the net calculation
176 * rule that is being deleted.
177 * @param p_object_version_number Current version number of the Net Calculation
178 * Rule to be deleted.
179 * @rep:displayname Delete Net Calculation Rule
180 * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ABSENCE
181 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
182 * @rep:scope public
183 * @rep:lifecycle active
184 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
185 */
186 --
187 -- {End Of Comments}
188 --
189 procedure delete_pay_net_calc_rule
190 (p_validate in boolean default false
191 ,p_net_calculation_rule_id in number
192 ,p_object_version_number in number
193 );
194 --
195 end pay_ncr_api;
[Home] [Help]