1 Package pqh_roles_api as
2 /* $Header: pqrlsapi.pkh 120.1 2005/10/02 02:27:36 aroussel $ */
3 /*#
4 * This package contains role APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Role
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------------< create_role >----------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a workflow role that determines whether a user can work on
17 * and approve data for a given transaction type.
18 *
19 * Workflow roles can be created for a specific business or they can be global
20 * roles which interact with multiple business groups.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * If the role is created for a specific business group, then that business
27 * group must already exist. If the created role is of a specific role type,
28 * then that role type must already be defined.
29 *
30 * <p><b>Post Success</b><br>
31 * The workflow role will be successfully created in the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The workflow role will not be created and an error will be raised.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_role_id If p_validate is false, then this uniquely identifies the
39 * role created. If p_validate is true, then set to null.
40 * @param p_role_name Unique role name
41 * @param p_role_type_cd Identifies the role type of the role. Valid values are
42 * defined by 'PQH_ROLE_TYPE' lookup_type.
43 * @param p_enable_flag Identifies if the role is enabled/disabled. Valid
44 * values are defined by 'YES_NO' lookup_type.
45 * @param p_object_version_number If p_validate is false, then set to the
46 * version number of the created role. If p_validate is true, then the value
47 * will be null.
48 * @param p_business_group_id Business group of the role.
49 * @param p_effective_date Reference date for validating lookup values are
50 * applicable during the start to end active date range. This date does not
51 * determine when the changes take effect.
52 * @param p_information_category This context value determines which flexfield
53 * structure to use with the developer descriptive flexfield segments.
54 * @param p_information1 Developer descriptive flexfield segment.
55 * @param p_information2 Developer descriptive flexfield segment.
56 * @param p_information3 Developer descriptive flexfield segment.
57 * @param p_information4 Developer descriptive flexfield segment.
58 * @param p_information5 Developer descriptive flexfield segment.
59 * @param p_information6 Developer descriptive flexfield segment.
60 * @param p_information7 Developer descriptive flexfield segment.
61 * @param p_information8 Developer descriptive flexfield segment.
62 * @param p_information9 Developer descriptive flexfield segment.
63 * @param p_information10 Developer descriptive flexfield segment.
64 * @param p_information11 Developer descriptive flexfield segment.
65 * @param p_information12 Developer descriptive flexfield segment.
66 * @param p_information13 Developer descriptive flexfield segment.
67 * @param p_information14 Developer descriptive flexfield segment.
68 * @param p_information15 Developer descriptive flexfield segment.
69 * @param p_information16 Developer descriptive flexfield segment.
70 * @param p_information17 Developer descriptive flexfield segment.
71 * @param p_information18 Developer descriptive flexfield segment.
72 * @param p_information19 Developer descriptive flexfield segment.
73 * @param p_information20 Developer descriptive flexfield segment.
74 * @param p_information21 Developer descriptive flexfield segment.
75 * @param p_information22 Developer descriptive flexfield segment.
76 * @param p_information23 Developer descriptive flexfield segment.
77 * @param p_information24 Developer descriptive flexfield segment.
78 * @param p_information25 Developer descriptive flexfield segment.
79 * @param p_information26 Developer descriptive flexfield segment.
80 * @param p_information27 Developer descriptive flexfield segment.
81 * @param p_information28 Developer descriptive flexfield segment.
82 * @param p_information29 Developer descriptive flexfield segment.
83 * @param p_information30 Developer descriptive flexfield segment.
84 * @rep:displayname Create Workflow Role
85 * @rep:category BUSINESS_ENTITY HR_ROLE
86 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
87 * @rep:scope public
88 * @rep:lifecycle active
89 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
90 */
91 --
92 -- {End Of Comments}
93 --
94 procedure create_role
95 (
96 p_validate in boolean default false
97 ,p_role_id out nocopy number
98 ,p_role_name in varchar2 default null
99 ,p_role_type_cd in varchar2 default null
100 ,p_enable_flag in varchar2 default 'Y'
101 ,p_object_version_number out nocopy number
102 ,p_business_group_id in number default null
103 ,p_effective_date in date
104 ,p_information_category in varchar2 default null
105 ,p_information1 in varchar2 default null
106 ,p_information2 in varchar2 default null
107 ,p_information3 in varchar2 default null
108 ,p_information4 in varchar2 default null
109 ,p_information5 in varchar2 default null
110 ,p_information6 in varchar2 default null
111 ,p_information7 in varchar2 default null
112 ,p_information8 in varchar2 default null
113 ,p_information9 in varchar2 default null
114 ,p_information10 in varchar2 default null
115 ,p_information11 in varchar2 default null
116 ,p_information12 in varchar2 default null
117 ,p_information13 in varchar2 default null
118 ,p_information14 in varchar2 default null
119 ,p_information15 in varchar2 default null
120 ,p_information16 in varchar2 default null
121 ,p_information17 in varchar2 default null
122 ,p_information18 in varchar2 default null
123 ,p_information19 in varchar2 default null
124 ,p_information20 in varchar2 default null
125 ,p_information21 in varchar2 default null
126 ,p_information22 in varchar2 default null
127 ,p_information23 in varchar2 default null
128 ,p_information24 in varchar2 default null
129 ,p_information25 in varchar2 default null
130 ,p_information26 in varchar2 default null
131 ,p_information27 in varchar2 default null
132 ,p_information28 in varchar2 default null
133 ,p_information29 in varchar2 default null
134 ,p_information30 in varchar2 default null
135 );
136 --
137 -- ----------------------------------------------------------------------------
138 -- |-------------------------------< update_role >----------------------------|
139 -- ----------------------------------------------------------------------------
140 --
141 -- {Start Of Comments}
142 /*#
143 * This API updates the workflow role details.
144 *
145 * If a workflow role is saved as business group specific or global, it cannot
146 * be changed to the other option. Each role name must be unique.
147 *
148 * <p><b>Licensing</b><br>
149 * This API is licensed for use with Human Resources.
150 *
151 * <p><b>Prerequisites</b><br>
152 * The role to be updated must already exist. If the role type of the role is
153 * updated, then that new role type must already be defined.
154 *
155 * <p><b>Post Success</b><br>
156 * The role will be successfully updated in the database.
157 *
158 * <p><b>Post Failure</b><br>
159 * The role will not be updated and an error will be raised.
160 * @param p_validate If true, then validation alone will be performed and the
161 * database will remain unchanged. If false and all validation checks pass,
162 * then the database will be modified.
163 * @param p_role_id Identifies the role record to be modified.
164 * @param p_role_name Unique role name.
165 * @param p_role_type_cd Identifies the role type of the role. Valid values are
166 * defined by 'PQH_ROLE_TYPE' lookup_type.
167 * @param p_enable_flag Identifies if the role is enabled/disabled. Valid
168 * values are defined by 'YES_NO' lookup_type.
169 * @param p_object_version_number Pass in the current version number of the
170 * role to be updated. When the API completes if p_validate is false, will be
171 * set to the new version number of the updated role. If p_validate is true
172 * will be set to the same value which was passed in.
173 * @param p_business_group_id Business group of the role.
174 * @param p_effective_date Reference date for validating lookup values are
175 * applicable during the start to end active date range. This date does not
176 * determine when the changes take effect.
177 * @param p_information_category This context value determines which flexfield
178 * structure to use with the developer descriptive flexfield segments.
179 * @param p_information1 Developer descriptive flexfield segment.
180 * @param p_information2 Developer descriptive flexfield segment.
181 * @param p_information3 Developer descriptive flexfield segment.
182 * @param p_information4 Developer descriptive flexfield segment.
183 * @param p_information5 Developer descriptive flexfield segment.
184 * @param p_information6 Developer descriptive flexfield segment.
185 * @param p_information7 Developer descriptive flexfield segment.
186 * @param p_information8 Developer descriptive flexfield segment.
187 * @param p_information9 Developer descriptive flexfield segment.
188 * @param p_information10 Developer descriptive flexfield segment.
189 * @param p_information11 Developer descriptive flexfield segment.
190 * @param p_information12 Developer descriptive flexfield segment.
191 * @param p_information13 Developer descriptive flexfield segment.
192 * @param p_information14 Developer descriptive flexfield segment.
193 * @param p_information15 Developer descriptive flexfield segment.
194 * @param p_information16 Developer descriptive flexfield segment.
195 * @param p_information17 Developer descriptive flexfield segment.
196 * @param p_information18 Developer descriptive flexfield segment.
197 * @param p_information19 Developer descriptive flexfield segment.
198 * @param p_information20 Developer descriptive flexfield segment.
199 * @param p_information21 Developer descriptive flexfield segment.
200 * @param p_information22 Developer descriptive flexfield segment.
201 * @param p_information23 Developer descriptive flexfield segment.
202 * @param p_information24 Developer descriptive flexfield segment.
203 * @param p_information25 Developer descriptive flexfield segment.
204 * @param p_information26 Developer descriptive flexfield segment.
205 * @param p_information27 Developer descriptive flexfield segment.
206 * @param p_information28 Developer descriptive flexfield segment.
207 * @param p_information29 Developer descriptive flexfield segment.
208 * @param p_information30 Developer descriptive flexfield segment.
209 * @rep:displayname Update Workflow Role
210 * @rep:category BUSINESS_ENTITY HR_ROLE
211 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
212 * @rep:scope public
213 * @rep:lifecycle active
214 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
215 */
216 --
217 -- {End Of Comments}
218 --
219 procedure update_role
220 (
221 p_validate in boolean default false
222 ,p_role_id in number
223 ,p_role_name in varchar2 default hr_api.g_varchar2
224 ,p_role_type_cd in varchar2 default hr_api.g_varchar2
225 ,p_enable_flag in varchar2 default hr_api.g_varchar2
226 ,p_object_version_number in out nocopy number
227 ,p_business_group_id in number default hr_api.g_number
228 ,p_effective_date in date
229 ,p_information_category in varchar2 default hr_api.g_varchar2
230 ,p_information1 in varchar2 default hr_api.g_varchar2
231 ,p_information2 in varchar2 default hr_api.g_varchar2
232 ,p_information3 in varchar2 default hr_api.g_varchar2
233 ,p_information4 in varchar2 default hr_api.g_varchar2
234 ,p_information5 in varchar2 default hr_api.g_varchar2
235 ,p_information6 in varchar2 default hr_api.g_varchar2
236 ,p_information7 in varchar2 default hr_api.g_varchar2
237 ,p_information8 in varchar2 default hr_api.g_varchar2
238 ,p_information9 in varchar2 default hr_api.g_varchar2
239 ,p_information10 in varchar2 default hr_api.g_varchar2
240 ,p_information11 in varchar2 default hr_api.g_varchar2
241 ,p_information12 in varchar2 default hr_api.g_varchar2
242 ,p_information13 in varchar2 default hr_api.g_varchar2
243 ,p_information14 in varchar2 default hr_api.g_varchar2
244 ,p_information15 in varchar2 default hr_api.g_varchar2
245 ,p_information16 in varchar2 default hr_api.g_varchar2
246 ,p_information17 in varchar2 default hr_api.g_varchar2
247 ,p_information18 in varchar2 default hr_api.g_varchar2
248 ,p_information19 in varchar2 default hr_api.g_varchar2
249 ,p_information20 in varchar2 default hr_api.g_varchar2
250 ,p_information21 in varchar2 default hr_api.g_varchar2
251 ,p_information22 in varchar2 default hr_api.g_varchar2
252 ,p_information23 in varchar2 default hr_api.g_varchar2
253 ,p_information24 in varchar2 default hr_api.g_varchar2
254 ,p_information25 in varchar2 default hr_api.g_varchar2
255 ,p_information26 in varchar2 default hr_api.g_varchar2
256 ,p_information27 in varchar2 default hr_api.g_varchar2
257 ,p_information28 in varchar2 default hr_api.g_varchar2
258 ,p_information29 in varchar2 default hr_api.g_varchar2
259 ,p_information30 in varchar2 default hr_api.g_varchar2
260 );
261 --
262 -- ----------------------------------------------------------------------------
263 -- |-------------------------------< delete_role >----------------------------|
264 -- ----------------------------------------------------------------------------
265 --
266 -- {Start Of Comments}
267 /*#
268 * This API deletes a workflow role.
269 *
270 * If a role has routing history it cannot be deleted. If the role is no longer
271 * needed it can be disabled instead of being deleted.
272 *
273 * <p><b>Licensing</b><br>
274 * This API is licensed for use with Human Resources.
275 *
276 * <p><b>Prerequisites</b><br>
277 * The role to be deleted must already exist. The role must not be associated
278 * to any user, position or template. The role must not be used as a routing
279 * list member. It should not be used as override approver in transaction type
280 * setup.
281 *
282 * <p><b>Post Success</b><br>
283 * The role will be successfully deleted from the database.
284 *
285 * <p><b>Post Failure</b><br>
286 * The role will not be deleted and an error will be raised.
287 * @param p_validate If true, then validation alone will be performed and the
288 * database will remain unchanged. If false and all validation checks pass,
289 * then the database will be modified.
290 * @param p_role_id Identifies uniquely the role to be deleted.
291 * @param p_object_version_number Current version number of the role to be
292 * deleted.
293 * @param p_effective_date Reference date for validating lookup values are
294 * applicable during the start to end active date range. This date does not
295 * determine when the changes take effect.
296 * @rep:displayname Delete Workflow Role
297 * @rep:category BUSINESS_ENTITY HR_ROLE
298 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
299 * @rep:scope public
300 * @rep:lifecycle active
301 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
302 */
303 --
304 -- {End Of Comments}
305 --
306 procedure delete_role
307 (
308 p_validate in boolean default false
309 ,p_role_id in number
310 ,p_object_version_number in number
311 ,p_effective_date in date
312 );
313 --
314 --
315 end pqh_roles_api;
[Home] [Help]