1 Package PQH_RATE_MATRIX_RATES_API as
2 /* $Header: pqrmrapi.pkh 120.5 2006/03/14 11:27:52 srajakum noship $ */
3 /*#
4 * This package contains rate matrix rate APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Rate matrix rate
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_rate_matrix_rate >--------------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 --
15 /*#
16 * This API creates a new rate matrix rate.
17 *
18 * The rate is created for a given rate matrix node and criteria rate
19 * definition.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources and HR Foundation.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The rate matrix node and the criteria rate definition for which the
26 * rate is created must already exist.
27 *
28 * <p><b>Post Success</b><br>
29 * The rate matrix rate is created.
30 *
31 * <p><b>Post Failure</b><br>
32 * The rate matrix rate is not created and error is raised.
33 *
34 * @param p_validate If true, then validation alone will be performed and
35 * the database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Determines when the DateTrack operation comes
38 * into force.
39 * @param p_rate_matrix_rate_id If p_validate is false, then this uniquely
40 * identifies the rate matrix rate created. If p_validate is true, then
41 * set to null.
42 * @param p_effective_start_date If p_validate is false, then set to the
43 * earliest start date for the created rate matrix rate. If p_validate is true,
44 * then set to null.
45 * @param p_effective_end_date If p_validate is false, then set to the
46 * effective end date for the created rate matrix rate. If p_validate is true,
47 * then set to null.
48 * @param p_rate_matrix_node_id Identifies the rate matrix node for which
49 * rate is created.
50 * @param p_criteria_rate_defn_id Identifies the criteria rate definition
51 * for which rate is created.
52 * @param p_min_rate_value Minimum rate value.
53 * @param p_max_rate_value Maximum rate value.
54 * @param p_mid_rate_value Mid rate value.
55 * @param p_rate_value Default rate value.
56 * @param p_business_group_id Business group of the rate matrix rate.
57 * @param p_legislation_code Legislation code of the rate matrix rate.
58 * @param p_object_version_number If p_validate is false, then set to
59 * the version number of the created rate matrix rate. If p_validate
60 * is true, then the value will be null.
61 * @rep:displayname Create rate matrix rate
62 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
63 * @rep:lifecycle active
64 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
65 * @rep:scope public
66 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
67 */
68 --
69 -- {End Of Comments}
70 --
71 procedure create_rate_matrix_rate
72 (p_validate in boolean default false
73 ,p_effective_date in date
74 ,p_rate_matrix_rate_id out nocopy number
75 ,p_EFFECTIVE_START_DATE out nocopy date
76 ,p_EFFECTIVE_END_DATE out nocopy date
77 ,p_RATE_MATRIX_NODE_ID in number
78 ,p_CRITERIA_RATE_DEFN_ID in number
79 ,p_MIN_RATE_VALUE in NUMBER default null
80 ,p_MAX_RATE_VALUE in NUMBER default null
81 ,p_MID_RATE_VALUE in NUMBER default null
82 ,p_RATE_VALUE in NUMBER
83 ,p_BUSINESS_GROUP_ID in NUMBER default null
84 ,p_LEGISLATION_CODE in VARCHAR2 default null
85 ,p_object_version_number out nocopy number
86 );
87 --
88 -- ----------------------------------------------------------------------------
89 -- |-----------------------< update_rate_matrix_rate >---------------------|
90 -- ----------------------------------------------------------------------------
91 --
92 -- {Start Of Comments}
93 --
94 /*#
95 * This API updates a rate matrix rate.
96 *
97 * The API allows datetrack update of the rate matrix rate record.
98 *
99 * <p><b>Licensing</b><br>
100 * This API is licensed for use with Human Resources and HR Foundation.
101 *
102 * <p><b>Prerequisites</b><br>
103 * The rate matrix node and the criteria rate definition for which the
104 * rate is updated must already exist.
105 *
106 * <p><b>Post Success</b><br>
107 * The rate matrix rate is updated.
108 *
109 * <p><b>Post Failure</b><br>
110 * The rate matrix rate is not updated and error is raised.
111 *
112 * @param p_validate If true, then validation alone will be performed and
113 * the database will remain unchanged. If false and all validation checks pass,
114 * then the database will be modified.
115 * @param p_effective_date Determines when the DateTrack operation comes
116 * into force.
117 * @param p_datetrack_mode Indicates which DateTrack mode to use when
118 * updating the record. You must set to either UPDATE, CORRECTION,
119 * UPDATE_OVERRIDE, UPDATE_CHANGE_INSERT. Modes available for use with a
120 * particular record depend on dates of the previous record changes and the
121 * effective date of this change.
122 * @param p_rate_matrix_rate_id Identifies the rate matrix rate to be
123 * updated.
124 * @param p_effective_start_date If p_validate is false, then set to the
125 * effective start date of the updated rate matrix rate row which now exists
126 * as of the effective date. If p_validate is true, then set to null.
127 * @param p_effective_end_date If p_validate is false, then set to the
128 * effective end date of the updated rate matrix rate row which now exists
129 * as of the effective date. If p_validate is true, then set to null.
130 * @param p_rate_matrix_node_id Identifies the rate matrix node for which
131 * rate is updated.
132 * @param p_criteria_rate_defn_id Identifies the criteria rate definition
133 * for which rate is updated.
134 * @param p_min_rate_value Minimum rate value.
135 * @param p_max_rate_value Maximum rate value.
136 * @param p_mid_rate_value Mid rate value.
137 * @param p_rate_value Default rate value.
138 * @param p_business_group_id Business group of the rate matrix rate.
139 * @param p_legislation_code Legislation code of the rate matrix rate.
140 * @param p_object_version_number Pass in the current version number of the
141 * rate matrix rate to be updated. When the API completes if p_validate is
142 * false, will be set to the new version number of the updated rate matrix rate.
143 * If p_validate is true will be set to the same value which was passed in.
144 * @rep:displayname Update rate matrix rate
145 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
146 * @rep:lifecycle active
147 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
148 * @rep:scope public
149 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
150 */
151 --
152 -- {End Of Comments}
153 --
154 procedure update_rate_matrix_rate
155 (p_validate in boolean default false
156 ,p_effective_date in date
157 ,p_datetrack_mode in varchar2
158 ,p_RATE_MATRIX_RATE_ID in number
159 ,p_EFFECTIVE_START_DATE out nocopy date
160 ,p_EFFECTIVE_END_DATE out nocopy date
161 ,p_RATE_MATRIX_NODE_ID in number
162 ,p_CRITERIA_RATE_DEFN_ID in number
163 ,p_MIN_RATE_VALUE in NUMBER default hr_api.g_number
164 ,p_MAX_RATE_VALUE in NUMBER default hr_api.g_number
165 ,p_MID_RATE_VALUE in NUMBER default hr_api.g_number
166 ,p_RATE_VALUE in NUMBER
167 ,p_BUSINESS_GROUP_ID in NUMBER default hr_api.g_number
168 ,p_LEGISLATION_CODE in VARCHAR2 default hr_api.g_varchar2
169 ,p_object_version_number in out nocopy number
170 );
171 --
172 -- ----------------------------------------------------------------------------
173 -- |------------------------< delete_rate_matrix_rate >----------------------|
174 -- ----------------------------------------------------------------------------
175 --
176 -- {Start Of Comments}
177 --
178 /*#
179 * This API deletes a rate matrix rate.
180 *
181 * The API allows datetrack delete of the rate value.
182 *
183 * <p><b>Licensing</b><br>
184 * This API is licensed for use with Human Resources and HR Foundation.
185 *
186 * <p><b>Prerequisites</b><br>
187 * The rate matrix rate that is to be deleted must exist.
188 *
189 * <p><b>Post Success</b><br>
190 * The rate matrix rate is deleted.
191 *
192 * <p><b>Post Failure</b><br>
193 * The rate matrix rate is not deleted and error is raised.
194 *
195 * @param p_validate If true, then validation alone will be performed and
196 * the database will remain unchanged. If false and all validation checks pass,
197 * then the database will be modified.
198 * @param p_rate_matrix_rate_id Identifies the rate matrix rate to be
199 * deleted.
200 * @param p_effective_start_date If p_validate is false, then set to the
201 * effective start date of the deleted rate matrix rate row which now exists
202 * as of the effective date. If p_validate is true or all row instances have
203 * been deleted then set to null.
204 * @param p_effective_end_date If p_validate is false, then set to the
205 * effective end date of the deleted rate matrix rate row which now exists
206 * as of the effective date. If p_validate is true or all row instances have
207 * been deleted then set to null.
208 * @param p_object_version_number Current version number of the
209 * rate matrix rate to be deleted.
210 * @param p_effective_date Determines when the DateTrack operation comes
211 * into force.
212 * @param p_datetrack_mode Indicates which DateTrack mode to use when
213 * deleting the record. You must set to either ZAP, DELETE,
214 * FUTURE_CHANGE, DELETE_NEXT_CHANGE. Modes available for use with a
215 * particular record depend on dates of the previous record changes and the
216 * effective date of this change.
217 * @rep:displayname Delete rate matrix rate
218 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
219 * @rep:lifecycle active
220 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
221 * @rep:scope public
222 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
223 */
224 --
225 --
226 -- {End Of Comments}
227 --
228 procedure delete_rate_matrix_rate
229 (p_validate in boolean default false
230 ,p_rate_matrix_rate_ID in number
231 ,p_effective_start_date out nocopy date
232 ,p_effective_end_date out nocopy date
233 ,p_object_version_number in out nocopy number
234 ,p_effective_date in date
235 ,p_datetrack_mode in varchar2
236 );
237 --
238 end PQH_RATE_MATRIX_RATES_API;
[Home] [Help]