1 Package PQH_ROUTING_LIST_MEMBERS_api as
2 /* $Header: pqrlmapi.pkh 120.1 2005/10/02 02:27:30 aroussel $ */
3 /*#
4 * This package contains routing list members APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Routing List Member
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_routing_list_member >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a routing list member to whom a transaction can be routed
17 * in a routing list.
18 *
19 * A routing list member is a destination for routing a transaction. By
20 * selecting a role, a group of people can be selected as a routing list
21 * member. A specific person can be selected as routing list member by
22 * selecting a user.
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 role and user selected as routing list member must already exist.
29 *
30 * <p><b>Post Success</b><br>
31 * The routing list member is successfully created in the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The routing list member is not created and an error is 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 {@rep:casecolumn PQH_ROUTING_LIST_MEMBERS.ROLE_ID}
39 * @param p_routing_list_id {@rep:casecolumn
40 * PQH_ROUTING_LIST_MEMBERS.ROUTING_LIST_ID}
41 * @param p_routing_list_member_id If p_validate is false, then this uniquely
42 * identifies the routing list member created. If p_validate is true, then set
43 * to null.
44 * @param p_seq_no Sequential number order of members within routing list.
45 * @param p_approver_flag Identifies if the routing list member is an approver
46 * or not for this associated routing list. Valid values are defined by
47 * 'YES_NO' lookup type.
48 * @param p_enable_flag Identifies if the routing list member is
49 * enabled/disabled. Valid values are defined by 'YES_NO' lookup type.
50 * @param p_object_version_number If p_validate is false, then set to the
51 * version number of the created routing list member. If p_validate is true,
52 * then the value will be null.
53 * @param p_user_id User identifier.
54 * @param p_effective_date Reference date for validating lookup values are
55 * applicable during the start to end active date range. This date does not
56 * determine when the changes take effect.
57 * @rep:displayname Create Routing List Member
58 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
59 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
60 * @rep:scope public
61 * @rep:lifecycle active
62 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
63 */
64 --
65 -- {End Of Comments}
66 --
67 procedure create_routing_list_member
68 (
69 p_validate in boolean default false
70 ,p_role_id in number default null
71 ,p_routing_list_id in number default null
72 ,p_routing_list_member_id out nocopy number
73 ,p_seq_no in number default null
74 ,p_approver_flag in varchar2 default null
75 ,p_enable_flag in varchar2 default 'Y'
76 ,p_object_version_number out nocopy number
77 ,p_user_id in number default null
78 ,p_effective_date in date
79 );
80 --
81 -- ----------------------------------------------------------------------------
82 -- |------------------------< update_routing_list_member >--------------------|
83 -- ----------------------------------------------------------------------------
84 --
85 -- {Start Of Comments}
86 /*#
87 * This API updates routing list member details.
88 *
89 * The routing list member can be set up as an approver for the routing list.
90 *
91 * <p><b>Licensing</b><br>
92 * This API is licensed for use with Human Resources.
93 *
94 * <p><b>Prerequisites</b><br>
95 * The routing list member to be updated must already exist.
96 *
97 * <p><b>Post Success</b><br>
98 * The routing list member is successfully updated in the database.
99 *
100 * <p><b>Post Failure</b><br>
101 * The routing list member is not updated and an error is raised.
102 * @param p_validate If true, then validation alone will be performed and the
103 * database will remain unchanged. If false and all validation checks pass,
104 * then the database will be modified.
105 * @param p_role_id {@rep:casecolumn PQH_ROUTING_LIST_MEMBERS.ROLE_ID}
106 * @param p_routing_list_id {@rep:casecolumn
107 * PQH_ROUTING_LIST_MEMBERS.ROUTING_LIST_ID}
108 * @param p_routing_list_member_id Identifies the routing list member to be
109 * modified.
110 * @param p_seq_no Sequential number order of members within routing list.
111 * @param p_approver_flag Identifies if the routing list member is an approver
112 * or not for this associated routing list. Valid values are defined by
113 * 'YES_NO' lookup type.
114 * @param p_enable_flag Identifies if the routing list member is
115 * enabled/disabled. Valid values are defined by 'YES_NO' lookup type.
116 * @param p_object_version_number Pass in the current version number of the
117 * routing list member to be updated. When the API completes if p_validate is
118 * false, will be set to the new version number of the updated routing list
119 * member. If p_validate is true will be set to the same value which was passed
120 * in.
121 * @param p_user_id User identifier.
122 * @param p_effective_date Reference date for validating lookup values are
123 * applicable during the start to end active date range. This date does not
124 * determine when the changes take effect.
125 * @rep:displayname Update Routing List Member
126 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
127 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
128 * @rep:scope public
129 * @rep:lifecycle active
130 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
131 */
132 --
133 -- {End Of Comments}
134 --
135 procedure update_routing_list_member
136 (
137 p_validate in boolean default false
138 ,p_role_id in number default hr_api.g_number
139 ,p_routing_list_id in number default hr_api.g_number
140 ,p_routing_list_member_id in number
141 ,p_seq_no in number default hr_api.g_number
142 ,p_approver_flag in varchar2 default hr_api.g_varchar2
143 ,p_enable_flag in varchar2 default hr_api.g_varchar2
144 ,p_object_version_number in out nocopy number
145 ,p_user_id in number default hr_api.g_number
146 ,p_effective_date in date
147 );
148 --
149 -- ----------------------------------------------------------------------------
150 -- |------------------------< delete_routing_list_member >--------------------|
151 -- ----------------------------------------------------------------------------
152 --
153 -- {Start Of Comments}
154 /*#
155 * This API deletes a routing list member.
156 *
157 * If the routing list member cannot be deleted because previous routing
158 * history exists for it, then it can be disabled.
159 *
160 * <p><b>Licensing</b><br>
161 * This API is licensed for use with Human Resources.
162 *
163 * <p><b>Prerequisites</b><br>
164 * The routing list member to be deleted must already exist. The routing list
165 * member cannot be deleted if a transaction has been routed to the routing
166 * list containing the member and the transaction is pending approval.
167 *
168 * <p><b>Post Success</b><br>
169 * The routing list member is successfully deleted from the database.
170 *
171 * <p><b>Post Failure</b><br>
172 * The routing list member is not deleted and an error is raised.
173 * @param p_validate If true, then validation alone will be performed and the
174 * database will remain unchanged. If false and all validation checks pass,
175 * then the database will be modified.
176 * @param p_routing_list_member_id Identifies the routing list member to be
177 * deleted.
178 * @param p_object_version_number Current version number of the routing list
179 * member to be deleted.
180 * @param p_effective_date Reference date for validating lookup values are
181 * applicable during the start to end active date range. This date does not
182 * determine when the changes take effect.
183 * @rep:displayname Delete Routing List Member
184 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
185 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
186 * @rep:scope public
187 * @rep:lifecycle active
188 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
189 */
190 --
191 -- {End Of Comments}
192 --
193 procedure delete_routing_list_member
194 (
195 p_validate in boolean default false
196 ,p_routing_list_member_id in number
197 ,p_object_version_number in out nocopy number
198 ,p_effective_date in date
199 );
200 --
201 --
202 end PQH_ROUTING_LIST_MEMBERS_api;
[Home] [Help]