1 Package pay_cnu_api AUTHID CURRENT_USER as
2 /* $Header: pycnuapi.pkh 120.1 2005/10/02 02:29:59 aroussel $ */
3 /*#
4 * This package contains Contribution Usage APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Contribution Usage
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_contribution_usage >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API allows the user to create a contribution usage for a business group
17 * for France.
18 *
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 * The business group and associated lookups must exist in the database.
25 *
26 * <p><b>Post Success</b><br>
27 * The contribution usage record is successfully inserted into the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * The API does not create a contribution usage, and raises an error.
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_effective_date Reference date for validating which lookup values
35 * are applicable during the start to end active date range. This date does not
36 * determine when the changes take effect.
37 * @param p_date_from Date from which the row applies
38 * @param p_date_to Date after which the row no longer applies
39 * @param p_group_code The group code for the contribution type. Valid values
40 * exist in either the 'FR_ELEMENT_GROUP' lookup type, or the
41 * 'FR_USER_ELEMENT_GROUP' lookup type.
42 * @param p_process_type The process type for the contribution type.Valid
43 * values exist in the 'FR_PROCESS_TYPE' lookup type.
44 * @param p_element_name The element name used by this contribution type.
45 * @param p_contribution_usage_type The contribution usage type for the
46 * contribution type. Valid values exist in the 'FR_CONTRIBUTION_USAGE_TYPE'
47 * lookup type.
48 * @param p_rate_type The rate type for the contribution type. Valid values
49 * exist in the 'FR_CONTRIBUTION_RATE_TYPE' lookup type.
50 * @param p_rate_category The rate category.
51 * @param p_contribution_code The contribution code.
52 * @param p_contribution_type The type of contribution.
53 * @param p_retro_contribution_code The retro contribution code for the
54 * contribution type.
55 * @param p_business_group_id The business group owning this contribution type.
56 * @param p_object_version_number If p_validate is false, then set to the
57 * version number of the created contribution usage. If p_validate is true,
58 * then the value will be null.
59 * @param p_contribution_usage_id If p_validate is false, then set to the
63 * contribution code.
60 * unique identifier of the contribution usage. If p_validate is true then the
61 * value will be null.
62 * @param p_code_rate_id The unique identifier of the rate type with
64 * @rep:displayname Create Contribution Usage
65 * @rep:category BUSINESS_ENTITY PAY_CONTRIBUTION_USAGE
66 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
67 * @rep:scope public
68 * @rep:lifecycle active
69 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
70 */
71 --
72 -- {End Of Comments}
73 --
74 procedure create_contribution_usage(
75 p_validate IN boolean default false
76 ,p_effective_date IN date
77 ,p_date_from IN date
78 ,p_date_to IN date default null
79 ,p_group_code IN varchar2
80 ,p_process_type IN varchar2
81 ,p_element_name IN varchar2
82 ,p_contribution_usage_type IN varchar2
83 ,p_rate_type IN varchar2 default null
84 ,p_rate_category IN varchar2
85 ,p_contribution_code IN varchar2 default null
86 ,p_contribution_type IN varchar2
87 ,p_retro_contribution_code IN varchar2 default null
88 ,p_business_group_id IN varchar2 default null
89 ,p_object_version_number OUT nocopy number
90 ,p_contribution_usage_id OUT nocopy number
91 ,p_code_rate_id IN OUT nocopy number
92 );
93 --
94 -- ----------------------------------------------------------------------------
95 -- |------------------------< update_contribution_usage >---------------------|
96 -- ----------------------------------------------------------------------------
97 --
98 -- {Start Of Comments}
99 /*#
100 * This API allows the user to update a contribution usage for a business group
101 * for France.
102 *
103 *
104 * <p><b>Licensing</b><br>
105 * This API is licensed for use with Human Resources.
106 *
107 * <p><b>Prerequisites</b><br>
108 * The contribution usage to be updated must exist.
109 *
110 * <p><b>Post Success</b><br>
111 * The contribution usage record is successfully updated in the database.
112 *
113 * <p><b>Post Failure</b><br>
114 * The API does not update the contribution usage, and raises an error.
115 * @param p_validate If true, then validation alone will be performed and the
116 * database will remain unchanged. If false and all validation checks pass,
117 * then the database will be modified.
118 * @param p_effective_date Reference date for validating which lookup values
119 * are applicable during the start to end active date range. This date does not
120 * determine when the changes take effect.
121 * @param p_contribution_usage_id The unique identifier for the contribution
122 * usage.
123 * @param p_date_to Date after which the row no longer applies
124 * @param p_contribution_code The contribution code contribution type.
125 * @param p_contribution_type The type of contribution.
126 * @param p_retro_contribution_code The retro contribution code for the
127 * contribution type.
128 * @param p_object_version_number Pass in the current version number of the
129 * contribution usage to be updated. When the API completes if p_validate is
130 * false, will be set to the new version number of the updated contribution
131 * usage. If p_validate is true will be set to the same value which was passed
132 * in.
133 * @param p_code_rate_id The unique identifier of the rate type with
134 * contribution code.
135 * @rep:displayname Update Contribution Usage
136 * @rep:category BUSINESS_ENTITY PAY_CONTRIBUTION_USAGE
137 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
138 * @rep:scope public
139 * @rep:lifecycle active
140 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
141 */
142 --
143 -- {End Of Comments}
144 --
145 procedure update_contribution_usage
146 (p_validate IN boolean default false
147 ,p_effective_date IN date
148 ,p_contribution_usage_id IN number
149 ,p_date_to IN date default hr_api.g_date
150 ,p_contribution_code IN varchar2
151 ,p_contribution_type IN varchar2
152 ,p_retro_contribution_code IN varchar2 default hr_api.g_varchar2
153 ,p_object_version_number IN OUT nocopy number
154 ,p_code_rate_id IN varchar2
155 );
156 --
157 -- ----------------------------------------------------------------------------
158 -- |------------------------< delete_contribution_usage >---------------------|
159 -- ----------------------------------------------------------------------------
160 --
161 -- {Start Of Comments}
162 /*#
163 * This API allows the user to delete a contribution usage for a business group
164 * for France.
165 *
166 *
167 * <p><b>Licensing</b><br>
168 * This API is licensed for use with Human Resources.
169 *
170 * <p><b>Prerequisites</b><br>
171 * The contribution usage to be deleted must exist.
172 *
173 * <p><b>Post Success</b><br>
174 * The specified row is deleted.
175 *
176 * <p><b>Post Failure</b><br>
177 * The API does not delete the contribution usage, and raises an error.
178 * @param p_validate If true, then validation alone will be performed and the
179 * database will remain unchanged. If false and all validation checks pass,
180 * then the database will be modified.
181 * @param p_contribution_usage_id The unique identifier for the contribution
182 * usage.
186 * @rep:category BUSINESS_ENTITY PAY_CONTRIBUTION_USAGE
183 * @param p_object_version_number Current version number of the contribution
184 * usage to be deleted.
185 * @rep:displayname Delete Contribution Usage
187 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
188 * @rep:scope public
189 * @rep:lifecycle active
190 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
191 */
192 --
193 -- {End Of Comments}
194 --
195 procedure delete_contribution_usage
196 (p_validate in boolean default false
197 ,p_contribution_usage_id in number
198 ,p_object_version_number in number
199 );
200 end pay_cnu_api;
[Home] [Help]