1 Package PQH_CRITERIA_RATE_ELEMENTS_API AUTHID CURRENT_USER as
2 /* $Header: pqcreapi.pkh 120.4 2006/04/21 15:18:07 srajakum noship $ */
3 /*#
4 * This package contains criteria rate elements APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Criteria rate element
8 */
9
10
11 --
12 -- ----------------------------------------------------------------------------
13 -- |--------------------------< create_criteria_rate_element >--------------------------|
14 -- ----------------------------------------------------------------------------
15 -- {Start Of Comments}
16 --
17 /*#
18 * This API creates a new criteria rate element.
19 *
20 * An element type can be associated to only one criteria rate definition.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources and HR Foundation.
24 *
25 * <p><b>Prerequisites</b><br>
26 * The element that is linked to the criteria rate definition must already
27 * exist.
28 *
29 * <p><b>Post Success</b><br>
30 * A criteria rate element row is created.
31 *
32 * <p><b>Post Failure</b><br>
33 * A criteria rate element is not created and error is raised.
34 *
35 * @param p_validate If true, then validation alone will be performed and
36 * the database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Reference date for validating lookup values are
39 * effective during the start to end active date range. This date does not
40 * determine when the changes take effect.
41 * @param p_criteria_rate_element_id If p_validate is false, then this uniquely
42 * identifies the criteria rate element created. If p_validate is true, then set to null.
43 * @param p_criteria_rate_defn_id The criteria rate definition to which the
44 * element is linked.
45 * @param p_element_type_id Element type linked to the criteria rate definition.
46 * @param p_input_value_id Input value for element in which a person's rate for
47 * the current criteria rate definition will be recorded.
48 * @param p_business_group_id Business group of the criteria rate element.
49 * @param p_legislation_code Legislation of the criteria rate element.
50 * @param p_object_version_number If p_validate is false, then set to the
51 * version number of the created criteria rate element. If p_validate is true,
52 * then set to null.
53 * @rep:displayname Create criteria rate element
57 * @rep:scope public
54 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
55 * @rep:lifecycle active
56 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
58 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
59 */
60
61 --
62 -- {End Of Comments}
63 --
64
65 procedure create_criteria_rate_element
66 (p_validate in boolean default false
67 ,p_effective_date in date
68 ,p_criteria_rate_element_id out nocopy number
69 ,p_criteria_rate_defn_id in number
70 ,p_element_type_id in number
71 ,p_input_value_id in number
72 ,p_business_group_id in number default null
73 ,p_legislation_code in varchar2 default null
74 ,p_object_version_number out nocopy number
75 );
76
77 --
78 -- ----------------------------------------------------------------------------
79 -- |--------------------------< update_criteria_rate_element >--------------------------|
80 -- ----------------------------------------------------------------------------
81 -- {Start Of Comments}
82 --
83 /*#
84 * This API updates a criteria rate element.
85 *
86 * An element type can be associated to only one criteria rate definition.
87 *
88 * <p><b>Licensing</b><br>
89 * This API is licensed for use with Human Resources and HR Foundation.
90 *
91 * <p><b>Prerequisites</b><br>
92 * The criteria rate element record that is modified must already exist.
93 *
94 * <p><b>Post Success</b><br>
95 * The criteria rate element is updated.
96 *
97 * <p><b>Post Failure</b><br>
98 * The criteria rate element is not updated and error is raised.
99 *
100 * @param p_validate If true, then validation alone will be performed and
101 * the database will remain unchanged. If false and all validation checks pass,
102 * then the database will be modified.
103 * @param p_effective_date Reference date for validating lookup values are
104 * effective during the start to end active date range. This date does not
105 * determine when the changes take effect.
106 * @param p_criteria_rate_element_id If p_validate is false, then this
107 * uniquely identifies the criteria rate element created. If p_validate is true,
108 * then set to null.
109 * @param p_criteria_rate_defn_id The criteria rate definition to which the
110 * element is linked.
111 * @param p_element_type_id Element type linked to the criteria rate definition.
112 * @param p_input_value_id Input value for element in which a person's rate for
113 * the current criteria rate definition will be recorded.
114 * @param p_business_group_id Business group of the criteria rate element.
115 * @param p_legislation_code Legislation of the criteria rate element.
116 * @param p_object_version_number Pass in the current version number of the
117 * criteria rate element to be updated. When the API completes if p_validate is false,
118 * will be set to the new version number of the updated criteria rate element.
119 * If p_validate is true will be set to the same value which was passed in.
120 * @rep:displayname Update criteria rate element
121 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
122 * @rep:lifecycle active
123 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
124 * @rep:scope public
125 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
126 */
127 --
128 -- {End Of Comments}
129 --
130
131 procedure update_criteria_rate_element
132 (p_validate in boolean default false
133 ,p_effective_date in date
134 ,p_criteria_rate_element_id in number
135 ,p_criteria_rate_defn_id in number default hr_api.g_number
136 ,p_element_type_id in number default hr_api.g_number
137 ,p_input_value_id in number default hr_api.g_number
138 ,p_business_group_id in number default hr_api.g_number
139 ,p_legislation_code in varchar2 default hr_api.g_varchar2
140 ,p_object_version_number in out nocopy number
141 );
142
143 --
144 -- ----------------------------------------------------------------------------
145 -- |--------------------------< delete_criteria_rate_element >--------------------------|
146 -- ----------------------------------------------------------------------------
147 -- {Start Of Comments}
148 --
149 /*#
150 * This API deletes the criteria rate element.
151 *
152 * The API deletes only the link between the criteria rate definition
153 * and the element type. The actual criteria rate definition and the
154 * element type is not deleted.
155 *
156 * <p><b>Licensing</b><br>
157 * This API is licensed for use with Human Resources and HR Foundation.
158 *
159 * <p><b>Prerequisites</b><br>
160 * The associated elements for the criteria rate element and rate factor
161 * on element details must be deleted.
162 *
163 * <p><b>Post Success</b><br>
164 * The criteria rate element is deleted.
165 *
166 * <p><b>Post Failure</b><br>
167 * The criteria rate element is not deleted and error is raised.
168 *
169 * @param p_validate If true, then validation alone will be performed and
170 * the database will remain unchanged. If false and all validation checks pass,
171 * then the database will be modified.
172 * @param p_effective_date Reference date for validating lookup values
173 * are applicable during the start to end active date range. This date does not
174 * determine when the changes take effect.
175 * @param p_criteria_rate_element_id Identifies the criteria rate element to be
176 * deleted.
177 * @param p_object_version_number Current version number of the criteria
178 * rate element to be deleted.
179 * @rep:displayname Delete criteria rate element
180 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
181 * @rep:lifecycle active
182 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
183 * @rep:scope public
184 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
185 */
186 --
187 -- {End Of Comments}
188 --
189
190 procedure delete_criteria_rate_element
191 (p_validate in boolean default false
192 ,p_effective_date in date
193 ,p_criteria_rate_element_id in number
194 ,p_object_version_number in number
195 );
196
197
198 --
199
200 end PQH_CRITERIA_RATE_ELEMENTS_API;
201
[Home] [Help]