1 Package IRC_VARIABLE_COMP_ELEMENT_API as
2 /* $Header: irvceapi.pkh 120.2 2008/02/21 14:39:44 viviswan noship $ */
3 /*#
4 * This package contains APIs for variable compensation elements for a vacancy.
5 * @rep:scope public
6 * @rep:product irc
7 * @rep:displayname Variable Compensation Element
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_variable_compensation >-------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a variable compensation element for a vacancy.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with iRecruitment.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The vacancy must already exist
24 *
25 * <p><b>Post Success</b><br>
26 * The variable compensation element will be created for the vacancy
27 *
28 * <p><b>Post Failure</b><br>
29 * The variable compensation element will not be created for the vacancy and an
30 * error will be raised
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_vacancy_id Identifies the vacancy that the variable compensation
35 * element is for
36 * @param p_variable_comp_lookup The type of variable compensation element.
37 * Valid values are defined by 'IRC_VARIABLE_COMP_ELEMENT' lookup type.
38 * @param p_effective_date Reference date for validating lookup values are
39 * applicable during the start to end active date range. This date does not
40 * determine when the changes take effect.
41 * @param p_object_version_number If p_validate is false, then set to the
42 * version number of the created variable compensation element. If p_validate
43 * is true, then the value will be null.
44 * @rep:displayname Create Variable Compensation
45 * @rep:category BUSINESS_ENTITY PER_VACANCY
46 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
47 * @rep:scope public
48 * @rep:lifecycle active
49 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
50 */
51 --
52 -- {End Of Comments}
53 --
54 procedure CREATE_VARIABLE_COMPENSATION
55 (p_validate in boolean default false
56 ,p_vacancy_id in number
57 ,p_variable_comp_lookup in varchar2
58 ,p_effective_date in date
59 ,p_object_version_number out nocopy number
60 );
61 --
62 -- ----------------------------------------------------------------------------
63 -- |-----------------------< delete_variable_compensation >-------------------|
64 -- ----------------------------------------------------------------------------
65 --
66 -- {Start Of Comments}
67 /*#
68 * This API deletes a variable compensation element for a vacancy.
69 *
70 *
71 * <p><b>Licensing</b><br>
72 * This API is licensed for use with iRecruitment.
73 *
74 * <p><b>Prerequisites</b><br>
75 * The variable compensation element must already exist
76 *
77 * <p><b>Post Success</b><br>
78 * The variable compensation element will be deleted from the database
79 *
80 * <p><b>Post Failure</b><br>
81 * The variable compensation element will not be deleted from the database and
82 * an error will be raised
83 * @param p_validate If true, then validation alone will be performed and the
84 * database will remain unchanged. If false and all validation checks pass,
85 * then the database will be modified.
86 * @param p_vacancy_id Identifies the vacancy for which we are deleting a
87 * variable compensation element
88 * @param p_variable_comp_lookup Identifies the variable compensation element
89 * type for which we are deleting a variable compensation element. Valid values
90 * are defined by 'IRC_VARIABLE_COMP_ELEMENT' lookup type.
91 * @param p_object_version_number Current version number of the variable
92 * consideration element to be deleted.
93 * @rep:displayname Delete Variable Compensation
94 * @rep:category BUSINESS_ENTITY PER_VACANCY
95 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
96 * @rep:scope public
97 * @rep:lifecycle active
98 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
99 */
100 --
101 -- {End Of Comments}
102 --
103 procedure DELETE_VARIABLE_COMPENSATION
104 (p_validate in boolean default false
105 ,p_vacancy_id in number
106 ,p_variable_comp_lookup in varchar2
107 ,p_object_version_number in number
108 );
109 --
110 end IRC_VARIABLE_COMP_ELEMENT_API;
[Home] [Help]