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