1 Package PAY_ELEMENT_TYPE_USAGE_API as
2 /* $Header: pyetuapi.pkh 120.1 2005/10/02 02:30:59 aroussel $ */
3 /*#
4 * This package contains element type usage APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Element Type Usage
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_element_type_usage >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates new element type usages.
17 *
18 * The role of this process is to insert a fully validated row into the
19 * pay_element_type_usages_f of the HR schema.
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 element type must already exist.
26 *
27 * <p><b>Post Success</b><br>
28 * The element type usage will be successfully inserted into the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The element type usage will not be created and an error will be raised.
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_effective_date Determines when the DateTrack operation comes into
36 * force.
37 * @param p_run_type_id {@rep:casecolumn PAY_ELEMENT_TYPE_USAGES_F.RUN_TYPE_ID}
38 * @param p_element_type_id {@rep:casecolumn
39 * PAY_ELEMENT_TYPES_F.ELEMENT_TYPE_ID}
40 * @param p_inclusion_flag {@rep:casecolumn
41 * PAY_ELEMENT_TYPE_USAGES_F.INCLUSION_FLAG}
42 * @param p_business_group_id {@rep:casecolumn
43 * PAY_ELEMENT_TYPE_USAGES_F.BUSINESS_GROUP_ID}
44 * @param p_legislation_code {@rep:casecolumn
45 * PAY_ELEMENT_TYPE_USAGES_F.LEGISLATION_CODE}
46 * @param p_usage_type {@rep:casecolumn PAY_ELEMENT_TYPE_USAGES_F.USAGE_TYPE}
47 * @param p_element_type_usage_id If p_validate is false, uniquely identifies
48 * the element type usage created. If p_validate is set to true, set to null.
49 * @param p_object_version_number If p_validate is false, then set to the
50 * version number of the created element type usage. If p_validate is true,
51 * then the value will be null.
52 * @param p_effective_start_date If p_validate is false, then set to the
53 * earliest effective start date for the created element type usage. If
54 * p_validate is true, then set to null.
55 * @param p_effective_end_date If p_validate is false, then set to the
56 * effective end date for the created element type usage. If p_validate is
57 * true, then set to null.
58 * @rep:displayname Create Element Type Usage
59 * @rep:category BUSINESS_ENTITY PAY_ELEMENT
60 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
61 * @rep:scope public
62 * @rep:lifecycle active
63 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
64 */
65 --
66 -- {End Of Comments}
67 --
68 procedure create_element_type_usage
69 (p_validate in boolean default false
70 ,p_effective_date in date
71 ,p_run_type_id in number
72 ,p_element_type_id in number
73 ,p_inclusion_flag in varchar2 default 'N'
74 ,p_business_group_id in number default null
75 ,p_legislation_code in varchar2 default null
76 ,p_usage_type in varchar2 default null
77 ,p_element_type_usage_id out nocopy number
78 ,p_object_version_number out nocopy number
79 ,p_effective_start_date out nocopy date
80 ,p_effective_end_date out nocopy date
81 );
82 --
83 -- ----------------------------------------------------------------------------
84 -- |------------------------< update_element_type_usage >---------------------|
85 -- ----------------------------------------------------------------------------
86 --
87 -- {Start Of Comments}
88 /*#
89 * This API updates element type usages.
90 *
91 * The role of this process is to perform a validated, date-effective update of
92 * an existing row in the pay_element_type_usages_f table of the HR schema.
93 *
94 * <p><b>Licensing</b><br>
95 * This API is licensed for use with Human Resources.
96 *
97 * <p><b>Prerequisites</b><br>
98 * The element type usage as identified by the in parameters
99 * p_element_type_usage_id and p_object_version_number must already exist.
100 *
101 * <p><b>Post Success</b><br>
102 * The element type usage will have been successfully updated in the database.
103 *
104 * <p><b>Post Failure</b><br>
105 * The element type usage will not be updated and an error will be raised.
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 Determines when the DateTrack operation comes into
110 * force.
111 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
112 * updating the record. You must set to either UPDATE, CORRECTION,
113 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
114 * particular record depend on the dates of previous record changes and the
115 * effective date of this change.
116 * @param p_inclusion_flag {@rep:casecolumn
117 * PAY_ELEMENT_TYPE_USAGES_F.INCLUSION_FLAG}
118 * @param p_element_type_usage_id {@rep:casecolumn
119 * PAY_ELEMENT_TYPE_USAGES_F.ELEMENT_TYPE_USAGE_ID}
120 * @param p_object_version_number Pass in the current version number of the
121 * element type extra information to be updated. When the API completes if
122 * p_validate is false, will be set to the new version number of the updated
123 * element type extra information. If p_validate is true will be set to the
124 * same value which was passed in.
125 * @param p_business_group_id {@rep:casecolumn
126 * PAY_ELEMENT_TYPE_USAGES_F.BUSINESS_GROUP_ID}
127 * @param p_legislation_code {@rep:casecolumn
128 * PAY_ELEMENT_TYPE_USAGES_F.LEGISLATION_CODE}
129 * @param p_usage_type {@rep:casecolumn PAY_ELEMENT_TYPE_USAGES_F.USAGE_TYPE}
130 * @param p_effective_start_date If p_validate is false, then set to the
131 * effective start date on the updated element type usage row which now exists
132 * as of the effective date. If p_validate is true, then set to null.
133 * @param p_effective_end_date If p_validate is false, then set to the
134 * effective end date on the updated element type usage row which now exists as
135 * of the effective date. If p_validate is true, then set to null.
136 * @rep:displayname Update Element Type Usage
137 * @rep:category BUSINESS_ENTITY PAY_ELEMENT
138 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
139 * @rep:scope public
140 * @rep:lifecycle active
141 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
142 */
143 --
144 -- {End Of Comments}
145 --
146 procedure update_element_type_usage
147 (p_validate in boolean default false
148 ,p_effective_date in date
149 ,p_datetrack_update_mode in varchar2
150 ,p_inclusion_flag in varchar2 default hr_api.g_varchar2
151 ,p_element_type_usage_id in number
152 ,p_object_version_number in out nocopy number
153 ,p_business_group_id in number default hr_api.g_number
154 ,p_legislation_code in varchar2 default hr_api.g_varchar2
155 ,p_usage_type in varchar2 default hr_api.g_varchar2
156 ,p_effective_start_date out nocopy date
157 ,p_effective_end_date out nocopy date
158 );
159 --
160 -- ----------------------------------------------------------------------------
161 -- |------------------------< delete_element_type_usage >---------------------|
162 -- ----------------------------------------------------------------------------
163 --
164 -- {Start Of Comments}
165 /*#
166 * This API deletes an element type usage.
167 *
168 * The role of this process is to perform a validated, date-effective delete of
169 * an existing row in the pay_element_type_usages_f table of the HR schema.
170 *
171 * <p><b>Licensing</b><br>
172 * This API is licensed for use with Human Resources.
173 *
174 * <p><b>Prerequisites</b><br>
175 * The element type usage as identified by the in parameters
176 * p_element_type_usage_id and p_object_version_number must already exist.
177 *
178 * <p><b>Post Success</b><br>
179 * The element type usage will have been successfully deleted from the
180 * database.
181 *
182 * <p><b>Post Failure</b><br>
183 * The element type usage will not be deleted and an error will be raised.
184 * @param p_validate If true, then validation alone will be performed and the
185 * database will remain unchanged. If false and all validation checks pass,
186 * then the database will be modified.
187 * @param p_effective_date Determines when the DateTrack operation comes into
188 * force.
189 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
190 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
191 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
192 * on the dates of previous record changes and the effective date of this
193 * change.
194 * @param p_element_type_usage_id {@rep:casecolumn
195 * PAY_ELEMENT_TYPE_USAGES_F.ELEMENT_TYPE_USAGE_ID}
196 * @param p_object_version_number Pass in the current version number of the
197 * element type usage to be deleted. When the API completes if p_validate is
198 * false, will be set to the new version number of the deleted element type
199 * usage. If p_validate is true will be set to the same value which was passed
200 * in.
201 * @param p_business_group_id {@rep:casecolumn
202 * PAY_ELEMENT_TYPE_USAGES_F.BUSINESS_GROUP_ID}
203 * @param p_legislation_code {@rep:casecolumn
204 * PAY_ELEMENT_TYPE_USAGES_F.LEGISLATION_CODE}
205 * @param p_effective_start_date If p_validate is false, then set to the
206 * effective start date for the deleted element type usage row which now exists
207 * as of the effective date. If p_validate is true or all row instances have
208 * been deleted then set to null.
209 * @param p_effective_end_date If p_validate is false, then set to the
210 * effective end date for the deleted element type usage row which now exists
211 * as of the effective date. If p_validate is true or all row instances have
212 * been deleted then set to null.
213 * @rep:displayname Delete Element Type Usage
214 * @rep:category BUSINESS_ENTITY PAY_ELEMENT
215 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
216 * @rep:scope public
217 * @rep:lifecycle active
218 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
219 */
220 --
221 -- {End Of Comments}
222 --
223 procedure delete_element_type_usage
224 (p_validate in boolean default false
225 ,p_effective_date in date
226 ,p_datetrack_delete_mode in varchar2
227 ,p_element_type_usage_id in number
228 ,p_object_version_number in out nocopy number
229 ,p_business_group_id in number default hr_api.g_number
230 ,p_legislation_code in varchar2 default hr_api.g_varchar2
231 ,p_effective_start_date out nocopy date
232 ,p_effective_end_date out nocopy date
233 );
234 --
235 end pay_element_type_usage_api;
[Home] [Help]