[Home] [Help]
PACKAGE: APPS.HR_CN_API
Source
1 PACKAGE hr_cn_api AS
2 /* $Header: hrcnapi.pkh 120.1.12000000.1 2007/01/22 14:29:42 appldev ship $ */
3
4 g_package VARCHAR2(33);
5
6 TYPE char_tab_type IS TABLE OF VARCHAR2(255) INDEX BY BINARY_INTEGER;
7
8 ----------------------------------------------------------------------------
9 -- --
10 -- Name : SET_LOCATION --
11 -- Type : PROCEDURE --
12 -- Access : Public --
13 -- Description : Procedure to set the location based on the trace --
14 -- --
15 -- Parameters : --
16 -- IN : p_message varchar2 --
17 -- p_step number --
18 -- p_trace varchar2 --
19 -- --
20 ---------------------------------------------------------------------------
21 PROCEDURE set_location (p_trace IN BOOLEAN
22 ,p_message IN VARCHAR2
23 ,p_step IN INTEGER
24 );
25
26 ----------------------------------------------------------------------------
27 -- --
28 -- Name : SET_LOCATION --
29 -- Type : PROCEDURE --
30 -- Access : Public --
31 -- Description : Procedure to set the location irrespective of trace --
32 -- --
33 -- Parameters : --
34 -- IN : p_message varchar2 --
35 -- p_step number --
36 -- --
37 ---------------------------------------------------------------------------
38 PROCEDURE set_location (p_message IN VARCHAR2
39 ,p_step IN INTEGER
40 );
41
42 ----------------------------------------------------------------------------
43 -- --
44 -- Name : CHECK_LOOKUP --
45 -- Type : Procedure --
46 -- Access : Public --
47 -- Description : Function to validate the lookupcode in lookuptype --
48 -- Function will return true in case the lookupcode is --
49 -- found in the lookuptype.Used in the check_employee. --
50 -- Parameters : --
51 -- IN : p_value varchar2 --
52 -- p_lookup_name varchar2 --
53 -- RETURN : Boolean --
54 ---------------------------------------------------------------------------
55 PROCEDURE check_lookup (
56 p_lookup_type IN VARCHAR2,
57 p_argument IN VARCHAR2,
58 p_argument_value IN VARCHAR2
59 );
60
61 --------------------------------------------------------------------------
62 -- --
63 -- Name : IS_POSITIVE_INTEGER --
64 -- Type : Function --
65 -- Access : Public --
66 -- Description : Function to validate the char as positive integer --
67 -- Parameters : --
68 -- IN : p_value varchar2 --
69 -- RETURN : Boolean --
70 -- --
71 ---------------------------------------------------------------------------
72 FUNCTION is_positive_integer
73 (p_value IN NUMBER
74 )
75 RETURN BOOLEAN;
76
77 --------------------------------------------------------------------------
78 -- --
79 -- Name : IS_VALID_PERCENTAGE --
80 -- Type : Function --
81 -- Access : Public --
82 -- Description : Function to validate the char as positive percentage--
83 -- Parameters : --
84 -- IN : p_value varchar2 --
85 -- RETURN : Boolean --
86 -- --
87 ---------------------------------------------------------------------------
88
89 FUNCTION is_valid_percentage
90 ( p_value IN NUMBER
91 )
92 RETURN BOOLEAN;
93
94 --------------------------------------------------------------------------
95 -- Name : IS_VALID_POSTAL_CODE --
96 -- Type : Function --
97 -- Access : Public --
98 -- Description : The function validates the postal code ,checks to --
99 -- see if the postal code is a 6 digit value and that --
100 -- all digits are numbers,if so returns true else false--
101 -- Parameters : --
102 -- IN : p_value_to_be_checked IN VARCHAR2 --
103 -- RETURN : Boolean --
104 -- --
105 ---------------------------------------------------------------------------
106 FUNCTION is_valid_postal_code
107 (p_value IN VARCHAR2
108 )
109 RETURN BOOLEAN;
110
111 --------------------------------------------------------------------------
112 -- --
113 -- Name : CHK_PERSON_TYPE --
114 -- Type : Function --
115 -- Access : Public --
116 -- Description : Returns true/false if p_code is a valid Person Type --
117 -- Parameters : --
118 -- IN : p_code VARCHAR2 --
119 -- OUT : N/A --
120 -- RETURN : BOOLEAN --
121 -- --
122 ---------------------------------------------------------------------------
123 FUNCTION chk_person_type
124 (p_code in varchar2)
125 RETURN BOOLEAN;
126 --------------------------------------------------------------------------
127 -- --
128 -- Name : CHECK_ORGANIZATION --
129 -- Type : Procedure --
130 -- Access : Public --
131 -- Description : The function checks if the organization id --
132 -- belongs to the business group specified for the --
133 -- legislation --
134 -- Parameters : --
135 -- IN : p_organization_id IN NUMBER --
136 -- : p_business_group_id IN NUMBER --
137 -- p_legislation_code IN NUMBER --
138 -- p_effective_date IN DATE --
139 -- RETURN : Boolean --
140 -- --
141 ---------------------------------------------------------------------------
142
143 PROCEDURE check_organization
144 (p_organization_id IN NUMBER
145 ,p_business_group_id IN NUMBER
146 ,p_legislation_code IN VARCHAR2
147 ,p_effective_date IN DATE
148 ) ;
149
150 --------------------------------------------------------------------------
151 -- --
152 -- Name : CHECK_ORG_CLASS --
153 -- Type : Procedure --
154 -- Access : Public --
155 -- Description : The function checks if org classification is as per --
156 -- the classification passed as a parameter --
157 -- Parameters : --
158 -- IN : p_organization_id IN NUMBER --
159 -- : p_classification IN VARCHAR2 --
160 -- --
161 --------------------------------------------------------------------------
162
163 PROCEDURE check_org_class
164 (p_organization_id IN NUMBER
165 ,p_classification IN VARCHAR2
166 ) ;
167
168 --------------------------------------------------------------------------
169 -- --
170 -- Name : CHECK_ORG_TYPE --
171 -- Type : Procedure --
172 -- Access : Public --
173 -- Description : The function checks if org type is as per --
174 -- the type passed as a parameter --
175 -- Parameters : --
176 -- IN : p_organization_id IN NUMBER --
177 -- : p_type IN VARCHAR2 --
178 -- --
179 ---------------------------------------------------------------------------
180 PROCEDURE check_org_type
181 (p_organization_id IN NUMBER
182 ,p_type IN VARCHAR2
183 ) ;
184
185 --
186 --------------------------------------------------------------------------
187 -- --
188 -- Name : IS_NUMBER --
189 -- Type : Function --
190 -- Access : Public --
191 -- Description : Procedure to check if a value is numeric --
192 -- Parameters : --
193 -- IN : p_value varchar2 --
194 -- --
195 ---------------------------------------------------------------------------
196
197 FUNCTION is_number
198 (p_value in varchar2)
199 RETURN BOOLEAN;
200
201 --
202 --------------------------------------------------------------------------
203 -- --
204 -- Name : CHECK_CIN --
205 -- Type : Procedure --
206 -- Access : Public --
207 -- Description : Procedure to validate the citizen identification num--
208 -- : CIN should be mandatory in case of Chinese EMP/APL --
209 -- Parameters : --
210 -- IN : p_business_group_id NUMBER --
211 -- p_national_identifier VARCHAR2, --
212 -- p_person_type_id NUMBER, --
213 -- p_expatriate_indicator VARCHAR2, --
214 -- p_effective_date DATE, --
215 -- p_person_id NUMBER --
216 -- --
217 ---------------------------------------------------------------------------
218 PROCEDURE check_cin
219 ( p_business_group_id NUMBER,
220 p_national_identifier VARCHAR2,
221 p_person_type_id NUMBER,
222 p_expatriate_indicator VARCHAR2,
223 p_effective_date DATE,
224 p_person_id NUMBER
225 );
226
227
228
229 --
230 --------------------------------------------------------------------------
231 -- --
232 -- Name : CHECK_TAX_DEPENDENCE --
233 -- Type : Procedure --
234 -- Access : Public --
235 -- Description : Procedure to validate the tax dependence on --
236 -- the exemption indicator. --
237 -- Exemption Indicator Tax Percentage --
238 -- N Should be null --
239 -- Y Should be valid % --
240 -- Parameters : --
241 -- IN : p_tax_exemption_indicator varchar2 --
242 -- : p_percentage varchar2 --
243 -- OUT : p_return_number number --
244 -- --
245 ---------------------------------------------------------------------------
246 PROCEDURE check_tax_dependence
247 ( p_tax_exemption_indicator IN VARCHAR2
248 ,p_percentage IN NUMBER
249 );
250
251 ----------------------------------------------------------------------------
252 -- --
253 -- Name : CHECK_BUS_GRP --
254 -- Type : PROCEDURE --
255 -- Access : Public --
256 -- Description : Procedure to validate the Business Group --
257 -- --
258 -- Parameters : --
259 -- IN : p_business_group_id NUMBER --
260 -- p_legislation_code VARCHAR2 --
261 ---------------------------------------------------------------------------
262 PROCEDURE check_bus_grp (p_business_group_id IN NUMBER
263 ,p_legislation_code IN VARCHAR2
264 );
265
266 ----------------------------------------------------------------------------
267 -- --
268 -- Name : CHECK_PERSON --
269 -- Type : PROCEDURE --
270 -- Access : Public --
271 -- Description : Procedure to validate the Business Group --
272 -- --
273 -- Parameters : --
274 -- IN : p_person_id NUMBER --
275 -- p_legislation_code VARCHAR2 --
276 ---------------------------------------------------------------------------
277 PROCEDURE check_person (p_person_id IN NUMBER
278 ,p_legislation_code IN VARCHAR2
279 ,p_effective_date IN DATE
280 );
281
282 ----------------------------------------------------------------------------
283 -- --
284 -- Name : CHECK_ADDRESS --
285 -- Type : PROCEDURE --
286 -- Access : Public --
287 -- Description : Procedure to validate the Business Group --
288 -- --
289 -- Parameters : --
290 -- IN : p_address_id NUMBER --
291 -- p_address_style VARCHAR2 --
292 ---------------------------------------------------------------------------
293 PROCEDURE check_address (p_address_id IN NUMBER
294 ,p_address_style IN VARCHAR2
295 );
296
297
298 ----------------------------------------------------------------------------
299 -- --
300 -- Name : CHECK_ASSIGNMENT --
301 -- Type : PROCEDURE --
302 -- Access : Public --
303 -- Description : Procedure to validate the Assignment --
304 -- --
305 -- Parameters : --
306 -- IN : p_assignment_id NUMBER --
307 -- p_legislation_code VARCHAR2 --
308 -- p_effective_date DATE --
309 ---------------------------------------------------------------------------
310 PROCEDURE check_assignment
311 (p_assignment_id IN NUMBER
312 ,p_legislation_code IN VARCHAR2
313 ,p_effective_date IN DATE
314 ) ;
315
316 ----------------------------------------------------------------------------
317 -- --
318 -- Name : CHECK_PAYMENT_METHOD --
319 -- Type : PROCEDURE --
320 -- Access : Public --
321 -- Description : Procedure to validate the Payment Method --
322 -- --
323 -- Parameters : --
324 -- IN : p_payment_method_id NUMBER --
325 -- p_legislation_code VARCHAR2 --
326 -- p_effective_date DATE --
327 ---------------------------------------------------------------------------
328 PROCEDURE check_payment_method
329 ( p_personal_payment_method_id IN NUMBER
330 ,p_effective_date IN DATE
331 ,p_legislation_code IN VARCHAR2
332 ) ;
333
334 --------------------------------------------------------------------------
335 -- --
336 -- Name : GET_PAY_MESSAGE --
337 -- Type : FUNCTION --
338 -- Access : Public --
339 -- Description : Function to construct the message for FF --
340 -- --
341 -- Parameters : --
342 -- IN : p_message_name VARCHAR2 --
343 -- p_token1 VARCHAR2 --
344 -- p_token2 VARCHAR2 --
345 -- p_token3 VARCHAR2 --
346 -- p_token4 VARCHAR2 --
347 -- RETURN : VARCHAR2 --
348 ---------------------------------------------------------------------------
349 FUNCTION get_pay_message
350 (p_message_name IN VARCHAR2
351 ,p_token1 IN VARCHAR2 DEFAULT NULL
352 ,p_token2 IN VARCHAR2 DEFAULT NULL
353 ,p_token3 IN VARCHAR2 DEFAULT NULL
354 ,p_token4 IN VARCHAR2 DEFAULT NULL
355 )
356 RETURN VARCHAR2;
357
358 --------------------------------------------------------------------------
359 -- --
360 -- Name : GET_USER_TABLE_VALUE --
361 -- Type : FUNCTION --
362 -- Access : Public --
363 -- Description : Function to fetch the user table value --
364 -- --
365 -- Parameters : --
366 -- IN : p_business_group_id NUMBER --
367 -- p_table_name VARCHAR2 --
368 -- p_column_name VARCHAR2 --
369 -- p_row_name VARCHAR2 --
370 -- p_row_value VARCHAR2 --
371 -- RETURN : VARCHAR2 --
372 -- OUT : p_message VARCHAR2 --
373 -- --
374 ---------------------------------------------------------------------------
375 FUNCTION get_user_table_value
376 (p_business_group_id IN NUMBER
377 ,p_table_name IN VARCHAR2
378 ,p_column_name IN VARCHAR2
379 ,p_row_name IN VARCHAR2
380 ,p_row_value IN VARCHAR2
381 ,p_effective_date IN DATE
382 ,p_message OUT NOCOPY VARCHAR2
383 )
384 RETURN VARCHAR2;
385
386 --------------------------------------------------------------------------
387 -- --
388 -- Name : GET_DFF_TL_VALUE --
389 -- Type : FUNCTION --
390 -- Access : Public --
391 -- Description : Function to fetch the translated value --
392 -- --
393 -- Parameters : --
394 -- IN : p_column_name VARCHAR2 --
395 -- p_dff VARCHAR2 --
396 -- p_dff_context_code VARCHAR2 --
397 -- RETURN : VARCHAR2 --
398 -- --
399 ---------------------------------------------------------------------------
400 FUNCTION get_dff_tl_value(p_column_name IN VARCHAR2
401 ,p_dff IN VARCHAR2
402 ,p_dff_context_code IN VARCHAR2
403 )
404 RETURN VARCHAR2;
405
406 --------------------------------------------------------------------------
407 -- --
408 -- Name : RAISE_MESSAGE --
409 -- Type : PROCEDURE --
410 -- Access : Public --
411 -- Description : Procedure to raise the error message --
412 -- --
413 -- Parameters : --
414 -- IN : p_application_id NUMBER --
415 -- p_message_name VARCHAR2 --
416 -- p_token_name HR_CN_API.CHAR_TAB_TYPE --
417 -- p_token_value HR_CN_API.CHAR_TAB_TYPE --
418 -- --
419 ---------------------------------------------------------------------------
420 PROCEDURE raise_message(p_application_id IN NUMBER
421 ,p_message_name IN VARCHAR2
422 ,p_token_name IN OUT NOCOPY hr_cn_api.char_tab_type
423 ,p_token_value IN OUT NOCOPY hr_cn_api.char_tab_type
424 );
425
429 -- Type : FUNCTION --
426 --------------------------------------------------------------------------
427 -- --
428 -- Name : get_class_tl_name --
430 -- Access : Public --
431 -- Description : Function to raise the error message --
432 -- --
433 -- Parameters : --
434 -- IN : p_classification_name VARCHAR2 --
435 -- RETURN : VARCHAR2 --
436 -- --
437 --------------------------------------------------------------------------
438 FUNCTION get_class_tl_name(p_classification_name IN VARCHAR2)
439 RETURN VARCHAR2;
440
441 END hr_cn_api;