1 Package pqh_ROUTING_CATEGORIES_api as
2 /* $Header: pqrctapi.pkh 120.1 2005/10/02 02:27:11 aroussel $ */
3 /*#
4 * This package contains routing category APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Routing Category
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_routing_category >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a routing category which identifies which routing
17 * list/position hierarchy/supervisory hierarchy a transaction must be routed
18 * to.
19 *
20 * If a routing category is created as the default routing category, all
21 * transactions that do not satisfy any routing rules for a transaction type,
22 * will be routed to the default routing category.
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * The transaction type for which the routing category is created must already
29 * exist. The routing list or position hierarchy to which the transaction will
30 * be routed must already exist. The override assignment/position/role/user
31 * defined for the routing category must already exist.
32 *
33 * <p><b>Post Success</b><br>
34 * The routing category is successfully created in the database.
35 *
36 * <p><b>Post Failure</b><br>
37 * The routing category is not created and an error is raised.
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_routing_category_id If p_validate is false, then this uniquely
42 * identifies the routing category created. If p_validate is true, then set to
43 * null.
44 * @param p_transaction_category_id {@rep:casecolumn
45 * PQH_ROUTING_CATEGORIES.TRANSACTION_CATEGORY_ID}
46 * @param p_enable_flag Indicates if the routing category is enabled/disabled.
47 * Valid values are defined by 'YES_NO' lookup_type.
48 * @param p_default_flag Indicates if the routing category is the default
49 * routing category for the transaction type. Valid values are defined by
50 * 'YES_NO' lookup_type.
51 * @param p_delete_flag Indicates if the routing category is marked for
52 * deletion. Valid values are defined by 'YES_NO' lookup_type.
53 * @param p_routing_list_id {@rep:casecolumn
54 * PQH_ROUTING_CATEGORIES.ROUTING_LIST_ID}
55 * @param p_position_structure_id {@rep:casecolumn
56 * PQH_ROUTING_CATEGORIES.POSITION_STRUCTURE_ID}
57 * @param p_override_position_id Identifies the position selected as override
58 * approver for the transaction category.
59 * @param p_override_assignment_id {@rep:casecolumn
60 * PQH_ROUTING_CATEGORIES.OVERRIDE_ASSIGNMENT_ID}
61 * @param p_override_role_id {@rep:casecolumn
62 * PQH_ROUTING_CATEGORIES.OVERRIDE_ROLE_ID}
63 * @param p_override_user_id {@rep:casecolumn
64 * PQH_ROUTING_CATEGORIES.OVERRIDE_USER_ID}
65 * @param p_object_version_number If p_validate is false, then set to the
66 * version number of the created routing category. If p_validate is true, then
67 * the value will be null.
68 * @param p_effective_date Reference date for validating lookup values are
69 * applicable during the start to end active date range. This date does not
70 * determine when the changes take effect.
71 * @rep:displayname Create Routing Category
72 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
73 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
74 * @rep:scope public
75 * @rep:lifecycle active
76 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
77 */
78 --
79 -- {End Of Comments}
80 --
81 procedure create_ROUTING_CATEGORY
82 (
83 p_validate in boolean default false
84 ,p_routing_category_id out nocopy number
85 ,p_transaction_category_id in number default null
86 ,p_enable_flag in varchar2 default 'Y'
87 ,p_default_flag in varchar2 default null
88 ,p_delete_flag in varchar2 default null
89 ,p_routing_list_id in number default null
90 ,p_position_structure_id in number default null
91 ,p_override_position_id in number default null
92 ,p_override_assignment_id in number default null
93 ,p_override_role_id in number default null
94 ,p_override_user_id in number default null
95 ,p_object_version_number out nocopy number
96 ,p_effective_date in date
97
98 );
99 --
100 -- ----------------------------------------------------------------------------
101 -- |-------------------------< update_routing_category >----------------------|
102 -- ----------------------------------------------------------------------------
103 --
104 -- {Start Of Comments}
105 /*#
106 * This API updates routing category details.
107 *
108 * The transaction type of a routing category cannot be updated.
109 *
110 * <p><b>Licensing</b><br>
111 * This API is licensed for use with Human Resources.
112 *
113 * <p><b>Prerequisites</b><br>
114 * The routing category to be updated must already exist. The transaction type
115 * to which this routing category belongs, must be in an unfrozen status.
116 *
117 * <p><b>Post Success</b><br>
118 * The routing category will be successfully updated in the database.
119 *
120 * <p><b>Post Failure</b><br>
121 * The routing category will not be updated and an error will be raised.
122 * @param p_validate If true, then validation alone will be performed and the
123 * database will remain unchanged. If false and all validation checks pass,
124 * then the database will be modified.
125 * @param p_routing_category_id Identifies the routing category record to be
126 * modified.
127 * @param p_transaction_category_id {@rep:casecolumn
128 * PQH_ROUTING_CATEGORIES.TRANSACTION_CATEGORY_ID}
129 * @param p_enable_flag Indicates if the routing category is enabled/disabled.
130 * Valid values are defined by 'YES_NO' lookup_type.
131 * @param p_default_flag Indicates if the routing category is the default
132 * routing category for the transaction type. Valid values are defined by
133 * 'YES_NO' lookup_type.
134 * @param p_delete_flag Indicates if the routing category is marked for
135 * deletion. Valid values are defined by 'YES_NO' lookup_type.
136 * @param p_routing_list_id {@rep:casecolumn
137 * PQH_ROUTING_CATEGORIES.ROUTING_LIST_ID}
138 * @param p_position_structure_id {@rep:casecolumn
139 * PQH_ROUTING_CATEGORIES.POSITION_STRUCTURE_ID}
140 * @param p_override_position_id Position selected as override approver for the
141 * transaction category.
142 * @param p_override_assignment_id {@rep:casecolumn
143 * PQH_ROUTING_CATEGORIES.OVERRIDE_ASSIGNMENT_ID}
144 * @param p_override_role_id {@rep:casecolumn
145 * PQH_ROUTING_CATEGORIES.OVERRIDE_ROLE_ID}
146 * @param p_override_user_id {@rep:casecolumn
147 * PQH_ROUTING_CATEGORIES.OVERRIDE_USER_ID}
148 * @param p_object_version_number Pass in the current version number of the
149 * routing category to be updated. When the API completes if p_validate is
150 * false, will be set to the new version number of the updated routing
151 * category. If p_validate is true will be set to the same value which was
152 * passed in.
153 * @param p_effective_date Reference date for validating lookup values are
154 * applicable during the start to end active date range. This date does not
155 * determine when the changes take effect.
156 * @rep:displayname Update Routing Category
157 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
158 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
159 * @rep:scope public
160 * @rep:lifecycle active
161 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
162 */
163 --
164 -- {End Of Comments}
165 --
166 procedure update_ROUTING_CATEGORY
167 (
168 p_validate in boolean default false
169 ,p_routing_category_id in number
170 ,p_transaction_category_id in number default hr_api.g_number
171 ,p_enable_flag in varchar2 default hr_api.g_varchar2
172 ,p_default_flag in varchar2 default hr_api.g_varchar2
173 ,p_delete_flag in varchar2 default hr_api.g_varchar2
174 ,p_routing_list_id in number default hr_api.g_number
175 ,p_position_structure_id in number default hr_api.g_number
176 ,p_override_position_id in number default hr_api.g_number
177 ,p_override_assignment_id in number default hr_api.g_number
178 ,p_override_role_id in number default hr_api.g_number
179 ,p_override_user_id in number default hr_api.g_number
180 ,p_object_version_number in out nocopy number
181 ,p_effective_date in date
182 );
183 --
184 -- ----------------------------------------------------------------------------
185 -- |-------------------------< delete_routing_category >----------------------|
186 -- ----------------------------------------------------------------------------
187 --
188 -- {Start Of Comments}
189 /*#
190 * This API deletes routing category.
191 *
192 * A routing category cannot be deleted if routing history exists for it. If
193 * the routing category is no longer needed, the alternate option to deleting
194 * it is to disable it.
195 *
196 * <p><b>Licensing</b><br>
197 * This API is licensed for use with Human Resources.
198 *
199 * <p><b>Prerequisites</b><br>
200 * The routing category that is to be deleted must already exist. There must be
201 * no routing or approval rules associated with the routing category. The
202 * routing category must not have been previously used to route transactions.
203 *
204 * <p><b>Post Success</b><br>
205 * The routing category is successfully deleted from the database.
206 *
207 * <p><b>Post Failure</b><br>
208 * The routing category will not be deleted and an error will be raised.
209 * @param p_validate If true, then validation alone will be performed and the
210 * database will remain unchanged. If false and all validation checks pass,
211 * then the database will be modified.
212 * @param p_routing_category_id Identifies the routing category record to be
213 * deleted.
214 * @param p_object_version_number Current version number of the routing
215 * category to be deleted.
216 * @param p_effective_date Reference date for validating lookup values are
217 * applicable during the start to end active date range. This date does not
218 * determine when the changes take effect.
219 * @rep:displayname Delete Routing Category
220 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
221 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
222 * @rep:scope public
223 * @rep:lifecycle active
224 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
225 */
226 --
227 -- {End Of Comments}
228 --
229 procedure delete_ROUTING_CATEGORY
230 (
231 p_validate in boolean default false
232 ,p_routing_category_id in number
233 ,p_object_version_number in number
234 ,p_effective_date in date
235 );
236 --
237 --
238 Procedure disable_routing_categories
239 (p_transaction_category_id in pqh_transaction_categories.transaction_category_id%type,
240 p_routing_type in pqh_transaction_categories.member_cd%type);
241 --
242 --
243 end pqh_ROUTING_CATEGORIES_api;
[Home] [Help]