1 PACKAGE PAY_BALANCE_DIMENSION_API AS
2 /* $Header: pybldapi.pkh 120.2 2005/11/02 06:35:51 sgottipa noship $ */
3 /*#
4 * This package contains Balance Dimension APIs.
5 * @rep:scope public
6 * @rep:product PAY
7 * @rep:displayname Balance Dimension
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_balance_dimension >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This Business Process is used to create a new Balance Dimension.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Payroll.
21 *
22 * <p><b>Prerequisites</b><br>
23 * If this balance dimension to be used only within a business group then a
24 * valid business group should exist.
25 *
26 * <p><b>Post Success</b><br>
27 * The balance dimension will be successfully inserted into the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * Error Messages are raised if any business rule is violated and the balance
31 * dimension is not created.
32 *
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_balance_dimension_id Primary Key If p_validate is true then this
37 * will be set to null.
38 * @param p_business_group_id Business group of the Balance Dimension.
39 * @param p_legislation_code Legislation of the Balance Dimension.
40 * @param p_route_id Route Id of the Balance Dimension.
41 * @param p_database_item_suffix {@rep:casecolumn
42 * PAY_BALANCE_DIMENSIONS.DATABASE_ITEM_SUFFIX}
43 * @param p_dimension_name Name of the Balance Dimension.
44 * @param p_dimension_type {@rep:casecolumn
45 * PAY_BALANCE_DIMENSIONS.DIMENSION_TYPE}
46 * @param p_description User Description of the Balance Dimension.
47 * @param p_feed_checking_code {@rep:casecolumn
48 * PAY_BALANCE_DIMENSIONS.FEED_CHECKING_CODE}
49 * @param p_legislation_subgroup Identifies the legislation of the predefined
50 * data for the element.
51 * @param p_payments_flag {@rep:casecolumn
52 * PAY_BALANCE_DIMENSIONS.PAYMENTS_FLAG}
53 * @param p_expiry_checking_code {@rep:casecolumn
54 * PAY_BALANCE_DIMENSIONS.EXPIRY_CHECKING_CODE}
55 * @param p_expiry_checking_level Indicates the balance dimension expiry
56 * checking level.
57 * @param p_feed_checking_type Indicates whether the latest balance should
58 * expire and if so, at what level (i.e., Payroll Action, Assignment Action
59 * or Date Expiry Level).
60 * @param p_dimension_level {@rep:casecolumn
61 * PAY_BALANCE_DIMENSIONS.DIMENSION_LEVEL}
62 * @param p_period_type {@rep:casecolumn PAY_BALANCE_DIMENSIONS.PERIOD_TYPE}
63 * @param p_asg_action_balance_dim_id {@rep:casecolumn
64 * PAY_BALANCE_DIMENSIONS.ASG_ACTION_BALANCE_DIM_ID}
65 * @param p_database_item_function {@rep:casecolumn
66 * PAY_BALANCE_DIMENSIONS.DATABASE_ITEM_FUNCTION}
67 * @param p_save_run_balance_enabled {@rep:casecolumn
68 * PAY_BALANCE_DIMENSIONS.SAVE_RUN_BALANCE_ENABLED}
69 * @param p_start_date_code {@rep:casecolumn
70 * PAY_BALANCE_DIMENSIONS.START_DATE_CODE}
71 * @rep:displayname Create Balance Dimension
72 * @rep:category BUSINESS_ENTITY PAY_BALANCE
73 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
74 * @rep:scope public
75 * @rep:lifecycle active
76 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
77 */
78 --
79 -- {End Of Comments}
80 --
81 procedure create_balance_dimension
82 (p_validate in boolean default FALSE,
83 p_balance_dimension_id out nocopy NUMBER,
84 p_business_group_id in NUMBER,
85 p_legislation_code in VARCHAR2,
86 p_route_id in NUMBER,
87 p_database_item_suffix in VARCHAR2,
88 p_dimension_name in VARCHAR2,
89 p_dimension_type in VARCHAR2,
90 p_description in VARCHAR2,
91 p_feed_checking_code in VARCHAR2,
92 p_legislation_subgroup in VARCHAR2,
93 p_payments_flag in VARCHAR2,
94 p_expiry_checking_code in VARCHAR2,
95 p_expiry_checking_level in VARCHAR2,
96 p_feed_checking_type in VARCHAR2,
97 p_dimension_level in VARCHAR2,
98 p_period_type in VARCHAR2,
99 p_asg_action_balance_dim_id in NUMBER,
100 p_database_item_function in VARCHAR2,
101 p_save_run_balance_enabled in VARCHAR2,
102 p_start_date_code in VARCHAR2
103 ) ;
104 --
105 -- ----------------------------------------------------------------------------
106 -- |------------------------< update_balance_dimension >----------------------|
107 -- ----------------------------------------------------------------------------
108 --
109 -- {Start Of Comments}
110 /*#
111 * This Business Process is used to update Balance Dimension.
112 *
113 *
114 * <p><b>Licensing</b><br>
115 * This API is licensed for use with Payroll.
116 *
117 * <p><b>Prerequisites</b><br>
118 * The balance dimension to be updated should exist.
119 *
120 * <p><b>Post Success</b><br>
121 * The balance dimension will be successfully updated into the database.
122 *
123 * <p><b>Post Failure</b><br>
124 * Error Messages are raised if any business rule is violated and the balance
125 * dimension is not updated.
126 *
127 * @param p_validate If true, then validation alone will be performed and the
128 * database will remain unchanged. If false and all validation checks pass,
129 * then the database will be modified.
130 * @param p_balance_dimension_id primary key.
131 * @param p_business_group_id Business group of the Balance Dimension.
132 * @param p_legislation_code Legislation of the Balance Dimension.
133 * @param p_route_id Route Id of the Balance Dimension.
134 * @param p_database_item_suffix {@rep:casecolumn
135 * PAY_BALANCE_DIMENSIONS.DATABASE_ITEM_SUFFIX}
136 * @param p_dimension_name Name of the Balance Dimension.
137 * @param p_dimension_type {@rep:casecolumn
138 * PAY_BALANCE_DIMENSIONS.DIMENSION_TYPE}
139 * @param p_description User Description of the Balance Dimension.
140 * @param p_feed_checking_code {@rep:casecolumn
141 * PAY_BALANCE_DIMENSIONS.FEED_CHECKING_CODE}
142 * @param p_legislation_subgroup Identifies the legislation of the predefined
143 * data for the element.
144 * @param p_payments_flag {@rep:casecolumn
145 * PAY_BALANCE_DIMENSIONS.PAYMENTS_FLAG}
146 * @param p_expiry_checking_code {@rep:casecolumn
147 * PAY_BALANCE_DIMENSIONS.EXPIRY_CHECKING_CODE}
148 * @param p_expiry_checking_level Indicates the balance dimension expiry
149 * checking level.
150 * @param p_feed_checking_type Indicates whether the latest balance should
151 * expire and if so, at what level (i.e., Payroll Action, Assignment Action
152 * or Date Expiry Level).
153 * @param p_dimension_level {@rep:casecolumn
154 * PAY_BALANCE_DIMENSIONS.DIMENSION_LEVEL}
155 * @param p_period_type {@rep:casecolumn PAY_BALANCE_DIMENSIONS.PERIOD_TYPE}
156 * @param p_asg_action_balance_dim_id {@rep:casecolumn
157 * PAY_BALANCE_DIMENSIONS.ASG_ACTION_BALANCE_DIM_ID}
158 * @param p_database_item_function {@rep:casecolumn
159 * PAY_BALANCE_DIMENSIONS.DATABASE_ITEM_FUNCTION}
160 * @param p_save_run_balance_enabled {@rep:casecolumn
161 * PAY_BALANCE_DIMENSIONS.SAVE_RUN_BALANCE_ENABLED}
162 * @param p_start_date_code {@rep:casecolumn
163 * PAY_BALANCE_DIMENSIONS.START_DATE_CODE}
164 * @rep:displayname Update Balance Dimension
165 * @rep:category BUSINESS_ENTITY PAY_BALANCE
166 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
167 * @rep:scope public
168 * @rep:lifecycle active
169 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
170 */
171 --
172 -- {End Of Comments}
173 --
174 procedure update_balance_dimension
175 (p_validate in boolean default FALSE,
176 p_balance_dimension_id in NUMBER,
177 p_business_group_id in NUMBER,
178 p_legislation_code in VARCHAR2,
179 p_route_id in NUMBER,
180 p_database_item_suffix in VARCHAR2,
181 p_dimension_name in VARCHAR2,
182 p_dimension_type in VARCHAR2,
183 p_description in VARCHAR2,
184 p_feed_checking_code in VARCHAR2,
185 p_legislation_subgroup in VARCHAR2,
186 p_payments_flag in VARCHAR2,
187 p_expiry_checking_code in VARCHAR2,
188 p_expiry_checking_level in VARCHAR2,
189 p_feed_checking_type in VARCHAR2,
190 p_dimension_level in VARCHAR2,
191 p_period_type in VARCHAR2,
192 p_asg_action_balance_dim_id in NUMBER,
193 p_database_item_function in VARCHAR2,
194 p_save_run_balance_enabled in VARCHAR2,
195 p_start_date_code in VARCHAR2
196 ) ;
197 --
198 -- ----------------------------------------------------------------------------
199 -- |------------------------< delete_balance_dimension >----------------------|
200 -- ----------------------------------------------------------------------------
201 --
202 -- {Start Of Comments}
203 /*#
204 * This Business Process is used to delete Balance Dimension.
205 *
206 *
207 * <p><b>Licensing</b><br>
208 * This API is licensed for use with Payroll.
209 *
210 * <p><b>Prerequisites</b><br>
211 * The balance dimension to be deleted should exist.
212 *
213 * <p><b>Post Success</b><br>
214 * The balance dimension will be successfully deleted from the database.
215 *
216 * <p><b>Post Failure</b><br>
217 * Error Messages are raised if any business rule is violated and the balance
218 * dimension is not updated.
219 *
220 * @param p_validate If true, then validation alone will be performed and the
221 * database will remain unchanged. If false and all validation checks pass,
222 * then the database will be modified.
223 * @param p_balance_dimension_id primary key.
224 * @rep:displayname Delete Balance Dimension
225 * @rep:category BUSINESS_ENTITY PAY_BALANCE
226 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
227 * @rep:scope public
228 * @rep:lifecycle active
229 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
230 */
231 --
232 -- {End Of Comments}
233 --
234 procedure delete_balance_dimension
235 (p_validate in boolean default false,
236 p_balance_dimension_id in NUMBER
237 );
238
239 function return_dml_status return boolean;
240
241 --
242 -- ----------------------------------------------------------------------------
243 -- | Package Header Variable |
244 -- ----------------------------------------------------------------------------
245 --
246 g_dml_status boolean:= FALSE; -- Global package variable
247 --
248 END PAY_BALANCE_DIMENSION_API ;
249
[Home] [Help]