1 Package PAY_ECU_API as
2 /* $Header: pyecuapi.pkh 120.2 2005/12/12 23:31:49 pgongada noship $ */
3 /*#
4 * This package contains Element Classification Usages API.
5 * @rep:scope public
6 * @rep:product PAY
7 * @rep:displayname ecu
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- | Global Definitions - Internal Development Use Only |
12 -- ----------------------------------------------------------------------------
13 --
14 g_api_dml boolean; -- Global api dml status
15 g_package varchar2(33) := ' pay_ecu_api.';
16 --
17 -- ----------------------------------------------------------------------------
18 -- |-------------------------< create_ele_class_usages >----------------------|
19 -- ----------------------------------------------------------------------------
20 --
21 -- {Start Of Comments}
22 /*#
23 * This API creates a new Element classification usage.
24 *
25 * <p><b>Licensing</b><br>
26 * This API is licensed for use with Payroll.
27 *
28 * <p><b>Prerequisites</b><br>
29 * The Classification, Runtype should exist on the Effective date.
30 * The Business Group and Legislation should also exist on the Effective date
31 * if they are specified.
32 *
33 * <p><b>Post Success</b><br>
34 * Creates a new Element classification usage.
35 *
36 * <p><b>Post Failure</b><br>
37 * Element classification usage is not created and an error is raised.
38 *
39 * @param p_validate If true, then validation alone will be performed and
40 * the database will remain unchanged. If false and all validation checks pass,
41 * then the database will be modified.
42 * @param p_effective_date Effective date of the Element classification
43 * usage to be created.
44 * @param p_run_type_id Run type id.
45 * @param p_classification_id Element classification id.
46 * @param p_business_group_id Business Group of the Element classification
47 * usage to be created.
48 * @param p_legislation_code Legislation Code of the Element classification
49 * usage to be created.
50 * @param p_element_class_usage_id If p_validate is false, then set to the
51 * newly created Element classification usage id and if p_validate is true,
52 * then set to null.
53 * @param p_object_version_number If p_validate is false, then set to the
54 * Object version number of the newly created Element classification usage
55 * and if p_validate is true, then set to null.
56 * @param p_effective_start_date If p_validate is false, then set to the
57 * Effective start date of the Element classification usage and if p_validate
58 * is true, then set to null.
59 * @param p_effective_end_date If p_validate is false, then set to the
60 * Effective end date of the Element classification usage and if p_validate
61 * is true, then set to null.
62 * @rep:displayname HRMS Element Classification
63 * @rep:category BUSINESS_ENTITY PAY_ELEMENT_CLASSIFICATION
64 * @rep:lifecycle active
65 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
66 * @rep:scope public
67 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
68 */
69 --
70 -- {End Of Comments}
71 --
72 procedure CREATE_ELE_CLASS_USAGES
73 (p_validate in boolean default false
74 ,p_effective_date in date
75 ,p_run_type_id in number
76 ,p_classification_id in number
77 ,p_business_group_id in number default null
78 ,p_legislation_code in varchar2 default null
79 ,p_element_class_usage_id out nocopy number
80 ,p_object_version_number out nocopy number
81 ,p_effective_start_date out nocopy date
82 ,p_effective_end_date out nocopy date
83 );
84 --
85 --
86 -- ----------------------------------------------------------------------------
87 -- |-------------------------< update_ele_class_usages >----------------------|
88 -- ----------------------------------------------------------------------------
89 --
90 -- {Start Of Comments}
91 /*#
92 * This API updates an Element classification usage.
93 *
94 * <p><b>Licensing</b><br>
95 * This API is licensed for use with Payroll.
96 *
97 * <p><b>Prerequisites</b><br>
98 * The Element classification usage must exist.
99 * The Classification, Runtype should exist on the Effective date if specified.
100 *
101 * <p><b>Post Success</b><br>
102 * Updates the specified Element classification usage.
103 *
104 * <p><b>Post Failure</b><br>
105 * Element classification usage is not updated and an error is raised.
106 *
107 * @param p_validate If true, then validation alone will be performed and
108 * the database will remain unchanged. If false and all validation checks pass,
109 * then the database will be modified.
110 * @param p_effective_date Effective date on which the Element
111 * classification usage should be updated.
112 * @param p_datetrack_mode Date track mode of the update.
113 * @param p_run_type_id Run type id.
114 * @param p_classification_id Element classification id.
115 * @param p_business_group_id Business Group of the Element classification
116 * usage.
117 * @param p_legislation_code Legislation Code of the Element classification
118 * usage.
119 * @param p_element_class_usage_id Element classification usage to be
120 * updated.
121 * @param p_object_version_number Object version number of the Element
122 * classification usage to be updated. If p_validate is false, then
123 * set to the Object version number of the updated record and if p_validate is
124 * true, then set to null.
125 * @param p_effective_start_date If p_validate is false, then set to the
126 * Effective start date of the Element classification usage and if p_validate
127 * is true, then set to null.
128 * @param p_effective_end_date If p_validate is false, then set to the
129 * Effective end date of the Element classification usage and if p_validate
130 * is true, then set to null.
131 * @rep:displayname HRMS Element Classification
132 * @rep:category BUSINESS_ENTITY PAY_ELEMENT_CLASSIFICATION
133 * @rep:lifecycle active
134 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
135 * @rep:scope public
136 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
137 */
138 --
139 -- {End Of Comments}
140 --
141 procedure UPDATE_ELE_CLASS_USAGES
142 (p_validate in boolean default false
143 ,p_effective_date in date
144 ,p_datetrack_mode in varchar2
145 ,p_run_type_id in number default hr_api.g_number
146 ,p_classification_id in number default hr_api.g_number
147 ,p_business_group_id in number default hr_api.g_number
148 ,p_legislation_code in varchar2 default hr_api.g_varchar2
149 ,p_element_class_usage_id in out nocopy number
150 ,p_object_version_number in out nocopy number
151 ,p_effective_start_date out nocopy date
152 ,p_effective_end_date out nocopy date
153 );
154 --
155 --
156 -- ----------------------------------------------------------------------------
157 -- |-------------------------< delete_ele_class_usages >----------------------|
158 -- ----------------------------------------------------------------------------
159 --
160 -- {Start Of Comments}
161 /*#
162 * This API deletes an Element classification usage.
163 *
164 * <p><b>Licensing</b><br>
165 * This API is licensed for use with Payroll.
166 *
167 * <p><b>Prerequisites</b><br>
168 * The Element classification usage must exist.
169 *
170 * <p><b>Post Success</b><br>
171 * Deletes the Element classification usage.
172 *
173 * <p><b>Post Failure</b><br>
174 * Element classification usage is not deleted and an error is raised.
175 *
176 * @param p_validate If true, then validation alone will be performed and
177 * the database will remain unchanged. If false and all validation checks pass,
178 * then the database will be modified.
179 * @param p_effective_date Effective date on which the Element
180 * classification usage should be updated.
181 * @param p_datetrack_mode Date track mode of the delete.
182 * @param p_element_class_usage_id Element classification usage to be
183 * deleted.
184 * @param p_object_version_number Object version number of the Element
185 * classification usage to be deleted. If p_validate is false, then set
186 * to the Object version number of the deleted record and if p_validate is
187 * true, then set to null.
188 * @param p_effective_start_date If p_validate is false, then set to the
189 * Effective start date of the Element classification usage and if p_validate
193 * is true, then set to null.
190 * is true, then set to null.
191 * @param p_effective_end_date If p_validate is false, then set to the
192 * Effective end date of the Element classification usage and if p_validate
194 * @rep:displayname HRMS Element Classification
195 * @rep:category BUSINESS_ENTITY PAY_ELEMENT_CLASSIFICATION
196 * @rep:lifecycle active
197 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
198 * @rep:scope public
199 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
200 */
201 --
202 -- {End Of Comments}
203 --
204 --
205 procedure DELETE_ELE_CLASS_USAGES
206 (p_validate in boolean default false
207 ,p_effective_date in date
208 ,p_datetrack_mode in varchar2
209 ,p_element_class_usage_id in number
210 ,p_object_version_number in out nocopy number
211 ,p_effective_start_date out nocopy date
212 ,p_effective_end_date out nocopy date
213 );
214 --
215 end PAY_ECU_API;
[Home] [Help]