4 * This package contains attribute range APIs.
1 Package pqh_ATTRIBUTE_RANGES_api AUTHID CURRENT_USER as
2 /* $Header: pqrngapi.pkh 120.1 2005/10/02 02:27:43 aroussel $ */
3 /*#
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Attribute Range
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_attribute_range >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an attribute range that makes up an approval or routing
17 * rule.
18 *
19 * A routing or approval rule consists of one or more conditions that must all
20 * be met for the rule to be satisfied. Attribute range makes up one condition.
21 * The user enters the from and to values when creating the attribute range,
22 * that a transaction attribute must satisfy, to be routed to a particular
23 * routing category or approver.
24 *
25 * <p><b>Licensing</b><br>
26 * This API is licensed for use with Human Resources.
27 *
28 * <p><b>Prerequisites</b><br>
29 * The user must have selected one or more transaction category attributes as
30 * routing and approval attributes. The position hierarchy/supervisory
31 * hierarchy/routing list for which routing rules are defined must already
32 * exist. The position/assignment/routing list member for which the approval
33 * rules are defined must already exist.
34 *
35 * <p><b>Post Success</b><br>
36 * The attribute range is created successfully in the database.
37 *
38 * <p><b>Post Failure</b><br>
42 * then the database will be modified.
39 * The attribute range is not created and an error is raised.
40 * @param p_validate If true, then validation alone will be performed and the
41 * database will remain unchanged. If false and all validation checks pass,
43 * @param p_attribute_range_id If p_validate is false, then this uniquely
44 * identifies the attribute range created. If p_validate is true, then set to
45 * null.
46 * @param p_approver_flag Identifies if rule is an approval rule. Valid values
47 * are defined by 'YES_NO' lookup_type.
48 * @param p_enable_flag Identifies if rule is enabled/disabled. Valid values
49 * are defined by 'YES_NO' lookup_type.
50 * @param p_delete_flag Identifies if rule is marked for deletion. Valid values
51 * are defined by 'YES_NO' lookup_type.
52 * @param p_assignment_id Identifies the assignment for which the approval rule
53 * is defined.
54 * @param p_attribute_id Identifies the attribute for which the range of values
55 * are entered.
56 * @param p_from_char Starting varchar2 value of the range.
57 * @param p_from_date Starting date value of the range.
58 * @param p_from_number Starting number value of the range.
59 * @param p_position_id Identifies the position for which the approval rule is
60 * defined.
61 * @param p_range_name Rule name.
62 * @param p_routing_category_id Identifies the routing category for which
63 * routing rules are defined.
64 * @param p_routing_list_member_id Identifies the routing list member for which
65 * the approval rule is defined.
66 * @param p_to_char Ending varchar2 value of the range.
67 * @param p_to_date Ending date value of the range.
68 * @param p_to_number Ending number value of the range.
69 * @param p_object_version_number If p_validate is false, then set to the
70 * version number of the created attribute range. If p_validate is true, then
71 * the value will be null.
72 * @param p_effective_date Reference date for validating lookup values are
73 * applicable during the start to end active date range. This date does not
74 * determine when the changes take effect.
75 * @rep:displayname Create Attribute Range
76 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
77 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
78 * @rep:scope public
79 * @rep:lifecycle active
80 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
81 */
82 --
83 -- {End Of Comments}
84 --
85 procedure create_ATTRIBUTE_RANGE
86 (
87 p_validate in boolean default false
88 ,p_attribute_range_id out nocopy number
89 ,p_approver_flag in varchar2 default null
90 ,p_enable_flag in varchar2 default 'Y'
91 ,p_delete_flag in varchar2 default null
92 ,p_assignment_id in number default null
93 ,p_attribute_id in number default null
94 ,p_from_char in varchar2 default null
95 ,p_from_date in date default null
96 ,p_from_number in number default null
97 ,p_position_id in number default null
98 ,p_range_name in varchar2
99 ,p_routing_category_id in number
100 ,p_routing_list_member_id in number default null
101 ,p_to_char in varchar2 default null
102 ,p_to_date in date default null
103 ,p_to_number in number default null
104 ,p_object_version_number out nocopy number
105 ,p_effective_date in date
106 );
107 --
108 -- ----------------------------------------------------------------------------
109 -- |--------------------------< update_attribute_range >----------------------|
110 -- ----------------------------------------------------------------------------
111 --
112 -- {Start Of Comments}
113 /*#
114 * This API updates attribute range values.
115 *
116 * When an attribute range values are updated, the application does not
117 * validate the conditions entered in the from/to value fields. It is up to the
118 * user to ensure that values entered are valid, as defined by the
119 * organization's unique implementation.
120 *
121 * <p><b>Licensing</b><br>
122 * This API is licensed for use with Human Resources.
123 *
124 * <p><b>Prerequisites</b><br>
125 * The attribute range to be updated must already exist. Updating an attribute
126 * range values must not cause routing rules for a transaction type to overlap.
127 * Updating an attribute range values must not cause approval rules for an
128 * approver to overlap.
129 *
130 * <p><b>Post Success</b><br>
131 * The attribute range is updated successfully in the database.
132 *
133 * <p><b>Post Failure</b><br>
134 * The attribute range is not updated and an error is raised.
135 * @param p_validate If true, then validation alone will be performed and the
136 * database will remain unchanged. If false and all validation checks pass,
137 * then the database will be modified.
138 * @param p_attribute_range_id Identifies uniquely the attribute range to be
139 * modified.
140 * @param p_approver_flag Identifies if rule is an approval rule. Valid values
141 * are defined by 'YES_NO' lookup_type.
142 * @param p_enable_flag Identifies if rule is enabled/disabled. Valid values
143 * are defined by 'YES_NO' lookup_type.
144 * @param p_delete_flag Identifies if rule is marked for deletion. Valid values
145 * are defined by 'YES_NO' lookup_type.
146 * @param p_assignment_id Identifies the assignment for which the approval rule
147 * is defined.
151 * @param p_from_date Starting date value of the range.
148 * @param p_attribute_id Identifies the attribute for which the range of values
149 * are entered.
150 * @param p_from_char Starting varchar2 value of the range.
152 * @param p_from_number Starting number value of the range.
153 * @param p_position_id Identifies the position for which the approval rule is
154 * defined..
155 * @param p_range_name Rule name.
156 * @param p_routing_category_id Identifies the routing category for which
157 * routing rules are defined.
158 * @param p_routing_list_member_id Identifies the routing list member for which
159 * the approval rule is defined.
160 * @param p_to_char Ending varchar2 value of the range.
161 * @param p_to_date Ending date value of the range.
162 * @param p_to_number Ending number value of the range.
163 * @param p_object_version_number Pass in the current version number of the
164 * attribute range to be updated. When the API completes if p_validate is
165 * false, will be set to the new version number of the updated attribute range.
166 * If p_validate is true will be set to the same value which was passed in.
167 * @param p_effective_date Reference date for validating lookup values are
168 * applicable during the start to end active date range. This date does not
169 * determine when the changes take effect.
170 * @rep:displayname Update Attribute Range
171 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
172 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
173 * @rep:scope public
174 * @rep:lifecycle active
175 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
176 */
177 --
178 -- {End Of Comments}
179 --
180 procedure update_ATTRIBUTE_RANGE
181 (
182 p_validate in boolean default false
183 ,p_attribute_range_id in number
184 ,p_approver_flag in varchar2 default hr_api.g_varchar2
185 ,p_enable_flag in varchar2 default hr_api.g_varchar2
186 ,p_delete_flag in varchar2 default hr_api.g_varchar2
187 ,p_assignment_id in number default hr_api.g_number
188 ,p_attribute_id in number default hr_api.g_number
189 ,p_from_char in varchar2 default hr_api.g_varchar2
190 ,p_from_date in date default hr_api.g_date
191 ,p_from_number in number default hr_api.g_number
192 ,p_position_id in number default hr_api.g_number
193 ,p_range_name in varchar2 default hr_api.g_varchar2
194 ,p_routing_category_id in number default hr_api.g_number
195 ,p_routing_list_member_id in number default hr_api.g_number
196 ,p_to_char in varchar2 default hr_api.g_varchar2
197 ,p_to_date in date default hr_api.g_date
198 ,p_to_number in number default hr_api.g_number
199 ,p_object_version_number in out nocopy number
200 ,p_effective_date in date
201 );
202 --
203 -- ----------------------------------------------------------------------------
204 -- |--------------------------< delete_attribute_range >----------------------|
205 -- ----------------------------------------------------------------------------
206 --
207 -- {Start Of Comments}
208 /*#
209 * This API deletes an attribute range record.
210 *
211 * Deleting an attribute range removes a condition that makes up the routing or
212 * approval rule.
213 *
214 * <p><b>Licensing</b><br>
215 * This API is licensed for use with Human Resources.
216 *
217 * <p><b>Prerequisites</b><br>
218 * The attribute range to be deleted must already exist. Deleting an attribute
219 * range must not cause routing rules for a transaction type to overlap.
220 * Deleting an attribute range must not cause approval rules for an approver to
221 * overlap. The routing/approval rule must not have already been used to route
222 * transactions.
223 *
224 * <p><b>Post Success</b><br>
225 * The attribute range is deleted successfully from the database.
226 *
227 * <p><b>Post Failure</b><br>
228 * The attribute range is not deleted and an error is raised.
229 * @param p_validate If true, then validation alone will be performed and the
230 * database will remain unchanged. If false and all validation checks pass,
231 * then the database will be modified.
232 * @param p_attribute_range_id Identifies uniquely the attribute range to be
233 * deleted.
234 * @param p_object_version_number Current version number of the attribute range
235 * to be deleted.
236 * @param p_effective_date Reference date for validating lookup values are
237 * applicable during the start to end active date range. This date does not
238 * determine when the changes take effect.
239 * @rep:displayname Delete Attribute Range
240 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
241 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
242 * @rep:scope public
243 * @rep:lifecycle active
244 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
245 */
246 --
247 -- {End Of Comments}
248 --
249 procedure delete_ATTRIBUTE_RANGE
250 (
251 p_validate in boolean default false
252 ,p_attribute_range_id in number
253 ,p_object_version_number in number
254 ,p_effective_date in date
255 );
256 --
257 --
258 end pqh_ATTRIBUTE_RANGES_api;
[Home] [Help]