1 Package hr_delivery_methods_api as
2 /* $Header: pepdmapi.pkh 120.1.12010000.1 2008/07/28 05:08:57 appldev ship $ */
3 /*#
4 * This package contains APIs that will maintain the delivery methods used to
5 * communicate with a person.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Delivery Method
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |--------------------------< create_delivery_method >----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a new delivery method for a person.
18 *
19 * A Delivery method is the medium by which one communicates with a person,
20 * e.g., e-mail, fax. A person can designate multiple delivery methods, one of
21 * which can be the preferred method.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * A person record must exist before a delivery method is created for them.
28 *
29 * <p><b>Post Success</b><br>
30 * A delivery method will be created for the person
31 *
32 * <p><b>Post Failure</b><br>
33 * A delivery method will not be created and an error will be raised.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Reference date for validating lookup values are
38 * applicable during the start to end active date range. This date does not
39 * determine when the changes take effect.
40 * @param p_person_id Identifies the person for whom you create the person
41 * delivery record.
42 * @param p_comm_dlvry_method The delivery method. Valid values are defined by
43 * the PER_CM_MTHD lookup type.
44 * @param p_date_start Start date for delivery method.
45 * @param p_date_end End date for delivery method.
46 * @param p_preferred_flag Must be set to 'Y' or 'N'. Valid values are based on
47 * the lookup type 'YES_NO'.
48 * @param p_request_id When the API is executed from a concurrent program set
49 * to the concurrent request identifier.
50 * @param p_program_update_date When the API is executed from a concurrent
51 * program set to when the program was ran.
52 * @param p_program_application_id When the API is executed from a concurrent
53 * program set to the program's Application.
54 * @param p_program_id When the API is executed from a concurrent program set
55 * to the program's identifier.
56 * @param p_attribute_category This context value determines which flexfield
57 * structure to use with the descriptive flexfield segments.
58 * @param p_attribute1 Descriptive flexfield segment.
59 * @param p_attribute2 Descriptive flexfield segment.
60 * @param p_attribute3 Descriptive flexfield segment.
61 * @param p_attribute4 Descriptive flexfield segment.
62 * @param p_attribute5 Descriptive flexfield segment.
63 * @param p_attribute6 Descriptive flexfield segment.
64 * @param p_attribute7 Descriptive flexfield segment.
65 * @param p_attribute8 Descriptive flexfield segment.
66 * @param p_attribute9 Descriptive flexfield segment.
67 * @param p_attribute10 Descriptive flexfield segment.
68 * @param p_attribute11 Descriptive flexfield segment.
69 * @param p_attribute12 Descriptive flexfield segment.
70 * @param p_attribute13 Descriptive flexfield segment.
71 * @param p_attribute14 Descriptive flexfield segment.
72 * @param p_attribute15 Descriptive flexfield segment.
73 * @param p_attribute16 Descriptive flexfield segment.
74 * @param p_attribute17 Descriptive flexfield segment.
75 * @param p_attribute18 Descriptive flexfield segment.
76 * @param p_attribute19 Descriptive flexfield segment.
77 * @param p_attribute20 Descriptive flexfield segment.
78 * @param p_delivery_method_id If p_validate is false then this uniquely
79 * identifies the delivery method created. If p_validate is true, then set to
80 * null.
81 * @param p_object_version_number If p_validate is false, then set to the
82 * version number of the created delivery method. If p_validate is true, then
83 * the value will be null.
84 * @rep:displayname Create Delivery Method
85 * @rep:category BUSINESS_ENTITY HR_PERSONAL_DELIVERY_METHOD
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_delivery_method
95 (
96 p_validate in boolean default false
97 ,p_effective_date in date
98 ,p_person_id in number
99 ,p_comm_dlvry_method in varchar2
100 ,p_date_start in date
101 ,p_date_end in date default hr_api.g_eot
102 ,p_preferred_flag in varchar2 default 'N'
103 ,p_request_id in number default null
104 ,p_program_update_date in date default null
105 ,p_program_application_id in number default null
106 ,p_program_id in number default null
107 ,p_attribute_category in varchar2 default null
108 ,p_attribute1 in varchar2 default null
109 ,p_attribute2 in varchar2 default null
110 ,p_attribute3 in varchar2 default null
111 ,p_attribute4 in varchar2 default null
112 ,p_attribute5 in varchar2 default null
113 ,p_attribute6 in varchar2 default null
114 ,p_attribute7 in varchar2 default null
115 ,p_attribute8 in varchar2 default null
116 ,p_attribute9 in varchar2 default null
117 ,p_attribute10 in varchar2 default null
118 ,p_attribute11 in varchar2 default null
119 ,p_attribute12 in varchar2 default null
120 ,p_attribute13 in varchar2 default null
121 ,p_attribute14 in varchar2 default null
122 ,p_attribute15 in varchar2 default null
123 ,p_attribute16 in varchar2 default null
124 ,p_attribute17 in varchar2 default null
125 ,p_attribute18 in varchar2 default null
126 ,p_attribute19 in varchar2 default null
127 ,p_attribute20 in varchar2 default null
128 ,p_delivery_method_id out nocopy number
129 ,p_object_version_number out nocopy number
130 );
131 --
132 -- ----------------------------------------------------------------------------
133 -- |--------------------------< update_delivery_method >----------------------|
134 -- ----------------------------------------------------------------------------
135 --
136 -- {Start Of Comments}
137 /*#
138 * This API updates an existing delivery method for a person.
139 *
140 * A Delivery method is the vehicle by which one communicates with a person,
141 * e.g., e-mail, fax. A person can designate multiple delivery methods, one of
142 * which can be the preferred method.
143 *
144 * <p><b>Licensing</b><br>
145 * This API is licensed for use with Human Resources.
146 *
147 * <p><b>Prerequisites</b><br>
148 * A delivery method must exist before it can be updated.
149 *
150 * <p><b>Post Success</b><br>
151 * The delivery method will be updated.
152 *
153 * <p><b>Post Failure</b><br>
154 * The delivery method will not be updated and an error will be raised.
155 * @param p_validate If true, then validation alone will be performed and the
156 * database will remain unchanged. If false and all validation checks pass,
157 * then the database will be modified.
158 * @param p_effective_date Reference date for validating lookup values are
159 * applicable during the start to end active date range. This date does not
160 * determine when the changes take effect.
161 * @param p_delivery_method_id This uniquely identifies the delivery method to
162 * be updated
163 * @param p_object_version_number Pass in the current version number of the
164 * delivery method to be updated. When the API completes if p_validate is
165 * false, will be set to the new version number of the updated delivery method.
166 * If p_validate is true will be set to the same value which was passed in.
167 * @param p_date_start Start date for delivery method.
168 * @param p_date_end End date for delivery method.
169 * @param p_comm_dlvry_method The delivery method. Valid values are defined by
170 * the PER_CM_MTHD lookup type.
171 * @param p_preferred_flag Must be set to 'Y' or 'N'. Valid values are based on
172 * the lookup type 'YES_NO'.
173 * @param p_request_id When the API is executed from a concurrent program set
174 * to the concurrent request identifier.
175 * @param p_program_update_date When the API is executed from a concurrent
176 * program set to when the program was ran.
177 * @param p_program_application_id When the API is executed from a concurrent
178 * program set to the program's Application.
179 * @param p_program_id When the API is executed from a concurrent program set
180 * to the program's identifier.
181 * @param p_attribute_category This context value determines which flexfield
182 * structure to use with the descriptive flexfield segments.
183 * @param p_attribute1 Descriptive flexfield segment.
184 * @param p_attribute2 Descriptive flexfield segment.
185 * @param p_attribute3 Descriptive flexfield segment.
186 * @param p_attribute4 Descriptive flexfield segment.
187 * @param p_attribute5 Descriptive flexfield segment.
188 * @param p_attribute6 Descriptive flexfield segment.
189 * @param p_attribute7 Descriptive flexfield segment.
190 * @param p_attribute8 Descriptive flexfield segment.
191 * @param p_attribute9 Descriptive flexfield segment.
192 * @param p_attribute10 Descriptive flexfield segment.
193 * @param p_attribute11 Descriptive flexfield segment.
194 * @param p_attribute12 Descriptive flexfield segment.
195 * @param p_attribute13 Descriptive flexfield segment.
196 * @param p_attribute14 Descriptive flexfield segment.
197 * @param p_attribute15 Descriptive flexfield segment.
198 * @param p_attribute16 Descriptive flexfield segment.
199 * @param p_attribute17 Descriptive flexfield segment.
200 * @param p_attribute18 Descriptive flexfield segment.
201 * @param p_attribute19 Descriptive flexfield segment.
202 * @param p_attribute20 Descriptive flexfield segment.
203 * @rep:displayname Update Delivery Method
204 * @rep:category BUSINESS_ENTITY HR_PERSONAL_DELIVERY_METHOD
205 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
206 * @rep:scope public
207 * @rep:lifecycle active
208 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
209 */
210 --
211 -- {End Of Comments}
212 --
213 procedure update_delivery_method
214 (
215 p_validate in boolean default false
216 ,p_effective_date in date
217 ,p_delivery_method_id in number
218 ,p_object_version_number in out nocopy number
219 ,p_date_start in date default hr_api.g_date
220 ,p_date_end in date default hr_api.g_date
221 ,p_comm_dlvry_method in varchar2 default hr_api.g_varchar2
222 ,p_preferred_flag in varchar2 default hr_api.g_varchar2
223 ,p_request_id in number default hr_api.g_number
224 ,p_program_update_date in date default hr_api.g_date
225 ,p_program_application_id in number default hr_api.g_number
226 ,p_program_id in number default hr_api.g_number
227 ,p_attribute_category in varchar2 default hr_api.g_varchar2
228 ,p_attribute1 in varchar2 default hr_api.g_varchar2
229 ,p_attribute2 in varchar2 default hr_api.g_varchar2
230 ,p_attribute3 in varchar2 default hr_api.g_varchar2
231 ,p_attribute4 in varchar2 default hr_api.g_varchar2
232 ,p_attribute5 in varchar2 default hr_api.g_varchar2
233 ,p_attribute6 in varchar2 default hr_api.g_varchar2
234 ,p_attribute7 in varchar2 default hr_api.g_varchar2
235 ,p_attribute8 in varchar2 default hr_api.g_varchar2
236 ,p_attribute9 in varchar2 default hr_api.g_varchar2
237 ,p_attribute10 in varchar2 default hr_api.g_varchar2
238 ,p_attribute11 in varchar2 default hr_api.g_varchar2
239 ,p_attribute12 in varchar2 default hr_api.g_varchar2
240 ,p_attribute13 in varchar2 default hr_api.g_varchar2
241 ,p_attribute14 in varchar2 default hr_api.g_varchar2
242 ,p_attribute15 in varchar2 default hr_api.g_varchar2
243 ,p_attribute16 in varchar2 default hr_api.g_varchar2
244 ,p_attribute17 in varchar2 default hr_api.g_varchar2
245 ,p_attribute18 in varchar2 default hr_api.g_varchar2
246 ,p_attribute19 in varchar2 default hr_api.g_varchar2
247 ,p_attribute20 in varchar2 default hr_api.g_varchar2
248 );
249 --
250 -- ----------------------------------------------------------------------------
251 -- |--------------------------< delete_delivery_method >----------------------|
252 -- ----------------------------------------------------------------------------
253 --
254 -- {Start Of Comments}
255 /*#
256 * This API deletes a delivery method.
257 *
258 * A Delivery method is the vehicle by which one communicates with a person,
259 * e.g., e-mail, fax. A person can designate multiple delivery methods, one of
260 * which can be the preferred method.
261 *
262 * <p><b>Licensing</b><br>
263 * This API is licensed for use with Human Resources.
264 *
265 * <p><b>Prerequisites</b><br>
266 * A delivery method must have been created for a person.
267 *
268 * <p><b>Post Success</b><br>
269 * The delivery method will be deleted.
270 *
271 * <p><b>Post Failure</b><br>
272 * The delivery method will not be deleted and an error will be raised.
273 * @param p_validate If true, then validation alone will be performed and the
274 * database will remain unchanged. If false and all validation checks pass,
275 * then the database will be modified.
276 * @param p_delivery_method_id This uniquely identifies the delivery method to
277 * be deleted
278 * @param p_object_version_number Current version number of the delivery method
279 * to be deleted.
280 * @rep:displayname Delete Delivery Method
281 * @rep:category BUSINESS_ENTITY HR_PERSONAL_DELIVERY_METHOD
282 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
283 * @rep:scope public
284 * @rep:lifecycle active
285 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
286 */
287 --
288 -- {End Of Comments}
289 --
290 procedure delete_delivery_method
291 (
292 p_validate in boolean default false
293 ,p_delivery_method_id in number
294 ,p_object_version_number in number
295 );
296 --
297 end hr_delivery_methods_api;
[Home] [Help]