DBA Data[Home] [Help]

PACKAGE: APPS.PAY_PMED_ACCOUNTS_API

Source


1 Package pay_pmed_accounts_api AUTHID CURRENT_USER as
2 /* $Header: pypmaapi.pkh 120.1 2005/10/02 02:32:53 aroussel $ */
3 /*#
4  * This package contains Proincial Medical Accounts APIs.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Provincial Medical Account
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_pmed_accounts >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates Provincial medical Account for an organization.
17  *
18  *
19  * <p><b>Licensing</b><br>
20  * This API is licensed for use with Human Resources.
21  *
22  * <p><b>Prerequisites</b><br>
23  * The organization must exist under a Canadian business group.
24  *
25  * <p><b>Restricted Usage Notes</b><br>
26  * The organization must be under a Canadian business group.
27  *
28  * <p><b>Post Success</b><br>
29  * It will create a Provincial Medical account number for that organization.
30  *
31  * <p><b>Post Failure</b><br>
32  * It will not create a PMED account number for that organization.
33  * @param p_validate If true, then validation alone will be performed and the
34  * database will remain unchanged. If false and all validation checks pass,
35  * then the database will be modified.
36  * @param p_organization_id Organization Id for which the Provincial Medical
37  * account number is created
38  * @param p_source_id Source ID for which the Provincial Medical account number
39  * is created
40  * @param p_account_number Provincial Medical Account Number that is to
41  * becreated by this API
42  * @param p_enabled If 'Y' then the Provincial Medical Account Number is
43  * enabled and will be used in other processes. If 'N' it is disabled and will
44  * not be used in other processes
45  * @param p_description Description of the Provincial Medical Account Number
46  * @param p_business_group_id Business Group of Record
47  * @param p_attribute_category This context value determines which flexfield
48  * structure to use with the descriptive flexfield segments.
49  * @param p_attribute1 Descriptive flexfield segment.
50  * @param p_attribute2 Descriptive flexfield segment.
51  * @param p_attribute3 Descriptive flexfield segment.
52  * @param p_attribute4 Descriptive flexfield segment.
53  * @param p_attribute5 Descriptive flexfield segment.
54  * @param p_attribute6 Descriptive flexfield segment.
55  * @param p_attribute7 Descriptive flexfield segment.
56  * @param p_attribute8 Descriptive flexfield segment.
57  * @param p_attribute9 Descriptive flexfield segment.
58  * @param p_attribute10 Descriptive flexfield segment.
59  * @param p_attribute11 Descriptive flexfield segment.
63  * @param p_attribute15 Descriptive flexfield segment.
60  * @param p_attribute12 Descriptive flexfield segment.
61  * @param p_attribute13 Descriptive flexfield segment.
62  * @param p_attribute14 Descriptive flexfield segment.
64  * @param p_attribute16 Descriptive flexfield segment.
65  * @param p_attribute17 Descriptive flexfield segment.
66  * @param p_attribute18 Descriptive flexfield segment.
67  * @param p_attribute19 Descriptive flexfield segment.
68  * @param p_attribute20 Descriptive flexfield segment.
69  * @param p_attribute21 Descriptive flexfield segment.
70  * @param p_attribute22 Descriptive flexfield segment.
71  * @param p_attribute23 Descriptive flexfield segment.
72  * @param p_attribute24 Descriptive flexfield segment.
73  * @param p_attribute25 Descriptive flexfield segment.
74  * @param p_attribute26 Descriptive flexfield segment.
75  * @param p_attribute27 Descriptive flexfield segment.
76  * @param p_attribute28 Descriptive flexfield segment.
77  * @param p_attribute29 Descriptive flexfield segment.
78  * @param p_attribute30 Descriptive flexfield segment.
79  * @param p_object_version_number If p_validate is false, then set to the
80  * version number of the created Provincial Medical account. If p_validate is
81  * true, then the value will be null.
82  * @rep:displayname Create Provincial Medical Account
83  * @rep:category BUSINESS_ENTITY PAY_PROVINCIAL_MEDICAL
84  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
85  * @rep:scope public
86  * @rep:lifecycle active
87  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
88 */
89 --
90 -- {End Of Comments}
91 --
92 procedure create_pmed_accounts
93 (
94    p_validate                       in            boolean    default false
95   ,p_organization_id                in            number    default null
96   ,p_source_id                      out nocopy    number
97   ,p_account_number                 in            varchar2  default null
98   ,p_enabled                        in            varchar2  default null
99   ,p_description                    in            varchar2  default null
100   ,p_business_group_id              in            number    default null
101   ,p_attribute_category             in            varchar2  default null
102   ,p_attribute1                     in            varchar2  default null
103   ,p_attribute2                     in            varchar2  default null
104   ,p_attribute3                     in            varchar2  default null
105   ,p_attribute4                     in            varchar2  default null
106   ,p_attribute5                     in            varchar2  default null
107   ,p_attribute6                     in            varchar2  default null
108   ,p_attribute7                     in            varchar2  default null
109   ,p_attribute8                     in            varchar2  default null
110   ,p_attribute9                     in            varchar2  default null
111   ,p_attribute10                    in            varchar2  default null
112   ,p_attribute11                    in            varchar2  default null
113   ,p_attribute12                    in            varchar2  default null
114   ,p_attribute13                    in            varchar2  default null
115   ,p_attribute14                    in            varchar2  default null
116   ,p_attribute15                    in            varchar2  default null
117   ,p_attribute16                    in            varchar2  default null
118   ,p_attribute17                    in            varchar2  default null
119   ,p_attribute18                    in            varchar2  default null
120   ,p_attribute19                    in            varchar2  default null
121   ,p_attribute20                    in            varchar2  default null
122   ,p_attribute21                    in            varchar2  default null
123   ,p_attribute22                    in            varchar2  default null
124   ,p_attribute23                    in            varchar2  default null
125   ,p_attribute24                    in            varchar2  default null
126   ,p_attribute25                    in            varchar2  default null
127   ,p_attribute26                    in            varchar2  default null
128   ,p_attribute27                    in            varchar2  default null
129   ,p_attribute28                    in            varchar2  default null
130   ,p_attribute29                    in            varchar2  default null
131   ,p_attribute30                    in            varchar2  default null
132   ,p_object_version_number          out nocopy    number
133  );
134 --
135 -- ----------------------------------------------------------------------------
136 -- |---------------------------< update_pmed_accounts >-----------------------|
137 -- ----------------------------------------------------------------------------
138 --
139 -- {Start Of Comments}
140 /*#
141  * Updates information about a Provincial Medical Account number for an
142  * organization.
143  *
144  *
145  * <p><b>Licensing</b><br>
146  * This API is licensed for use with Human Resources.
147  *
148  * <p><b>Prerequisites</b><br>
149  * The Provincial Medical Account number must exist for the organization
150  *
151  * <p><b>Post Success</b><br>
152  * The Provincial Medical Account number information will be updated for the
153  * organization
154  *
155  * <p><b>Post Failure</b><br>
156  * The Provincial Medical Account Number information will remain same for the
157  * organization
158  * @param p_validate If true, then validation alone will be performed and the
159  * database will remain unchanged. If false and all validation checks pass,
160  * then the database will be modified.
161  * @param p_organization_id Organization Id for which the Provincial Medical
162  * account number is updated
163  * @param p_source_id PK of record
164  * @param p_account_number The Provincial Medical Account number which is
165  * updated
166  * @param p_enabled If 'Y' then the Provincial Medical Account Number is
167  * enabled and will be used in other processes. If 'N' it is disabled and will
168  * not be used in other processes
169  * @param p_description Description of the PMED Account Number
170  * @param p_business_group_id Business Group of Record
171  * @param p_attribute_category This context value determines which flexfield
172  * structure to use with the descriptive flexfield segments.
173  * @param p_attribute1 Descriptive flexfield segment.
174  * @param p_attribute2 Descriptive flexfield segment.
175  * @param p_attribute3 Descriptive flexfield segment.
176  * @param p_attribute4 Descriptive flexfield segment.
177  * @param p_attribute5 Descriptive flexfield segment.
178  * @param p_attribute6 Descriptive flexfield segment.
179  * @param p_attribute7 Descriptive flexfield segment.
180  * @param p_attribute8 Descriptive flexfield segment.
181  * @param p_attribute9 Descriptive flexfield segment.
182  * @param p_attribute10 Descriptive flexfield segment.
183  * @param p_attribute11 Descriptive flexfield segment.
184  * @param p_attribute12 Descriptive flexfield segment.
185  * @param p_attribute13 Descriptive flexfield segment.
186  * @param p_attribute14 Descriptive flexfield segment.
187  * @param p_attribute15 Descriptive flexfield segment.
188  * @param p_attribute16 Descriptive flexfield segment.
189  * @param p_attribute17 Descriptive flexfield segment.
190  * @param p_attribute18 Descriptive flexfield segment.
191  * @param p_attribute19 Descriptive flexfield segment.
192  * @param p_attribute20 Descriptive flexfield segment.
193  * @param p_attribute21 Descriptive flexfield segment.
194  * @param p_attribute22 Descriptive flexfield segment.
195  * @param p_attribute23 Descriptive flexfield segment.
196  * @param p_attribute24 Descriptive flexfield segment.
197  * @param p_attribute25 Descriptive flexfield segment.
198  * @param p_attribute26 Descriptive flexfield segment.
199  * @param p_attribute27 Descriptive flexfield segment.
200  * @param p_attribute28 Descriptive flexfield segment.
201  * @param p_attribute29 Descriptive flexfield segment.
202  * @param p_attribute30 Descriptive flexfield segment.
203  * @param p_object_version_number Pass in the current version number of the
204  * Provincial Medical account to be updated. When the API completes if
205  * p_validate is false, will be set to the new version number of the updated
206  * Provincial Medical account. If p_validate is true will be set to the same
207  * value which was passed in.
208  * @rep:displayname Update Provincial Medical Account
209  * @rep:category BUSINESS_ENTITY PAY_PROVINCIAL_MEDICAL
210  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
211  * @rep:scope public
212  * @rep:lifecycle active
213  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
214 */
215 --
216 -- {End Of Comments}
217 --
218 procedure update_pmed_accounts
219   (
220    p_validate                       in            boolean    default false
221   ,p_organization_id                in            number    default hr_api.g_number
222   ,p_source_id                      in            number
223   ,p_account_number                 in            varchar2  default hr_api.g_varchar2
224   ,p_enabled                        in            varchar2  default hr_api.g_varchar2
225   ,p_description                    in            varchar2  default hr_api.g_varchar2
226   ,p_business_group_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   ,p_attribute21                    in            varchar2  default hr_api.g_varchar2
249   ,p_attribute22                    in            varchar2  default hr_api.g_varchar2
250   ,p_attribute23                    in            varchar2  default hr_api.g_varchar2
251   ,p_attribute24                    in            varchar2  default hr_api.g_varchar2
252   ,p_attribute25                    in            varchar2  default hr_api.g_varchar2
253   ,p_attribute26                    in            varchar2  default hr_api.g_varchar2
254   ,p_attribute27                    in            varchar2  default hr_api.g_varchar2
255   ,p_attribute28                    in            varchar2  default hr_api.g_varchar2
256   ,p_attribute29                    in            varchar2  default hr_api.g_varchar2
257   ,p_attribute30                    in            varchar2  default hr_api.g_varchar2
258   ,p_object_version_number          in out nocopy number
259   );
260 --
261 -- ----------------------------------------------------------------------------
262 -- |---------------------------< delete_pmed_accounts >-----------------------|
263 -- ----------------------------------------------------------------------------
264 --
265 -- {Start Of Comments}
266 /*#
267  * This API deletes an existing PMED Account Number for an organization.
268  *
269  *
270  * <p><b>Licensing</b><br>
271  * This API is licensed for use with Human Resources.
272  *
273  * <p><b>Prerequisites</b><br>
274  * The Provincial Medical Account number must exist for the organization
275  *
276  * <p><b>Post Success</b><br>
277  * The Provincial Medical Account Number will be deleted for the organization.
278  *
279  * <p><b>Post Failure</b><br>
280  * The Provincial Medical Account Number will not be deleted for the
281  * organization
282  * @param p_validate If true, then validation alone will be performed and the
283  * database will remain unchanged. If false and all validation checks pass,
284  * then the database will be modified.
285  * @param p_source_id PK of record
286  * @param p_object_version_number Current version number of the Provincial
287  * Medical account to be deleted.
288  * @rep:displayname Delete Provincial Medical Account
289  * @rep:category BUSINESS_ENTITY PAY_PROVINCIAL_MEDICAL
290  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
291  * @rep:scope public
292  * @rep:lifecycle active
293  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
294 */
298 procedure delete_pmed_accounts
295 --
296 -- {End Of Comments}
297 --
299   (
300    p_validate                       in                 boolean        default false
301   ,p_source_id                      in                 number
302   ,p_object_version_number          in out nocopy      number
303   );
304 --
305 -- ----------------------------------------------------------------------------
306 -- |----------------------------------< lck >---------------------------------|
307 -- ----------------------------------------------------------------------------
308 -- {Start Of Comments}
309 --
310 -- Description:
311 --
312 -- Prerequisites:
313 --
314 --
315 -- In Parameters:
316 --   Name                           Reqd Type     Description
317 --   p_source_id                 Yes  number   PK of record
318 --   p_object_version_number        Yes  number   OVN of record
319 --
320 -- Post Success:
321 --
322 --   Name                           Type     Description
323 --
324 -- Post Failure:
325 --
326 -- Access Status:
327 --   Public.
328 --
329 -- {End Of Comments}
330 --
331 procedure lck
332   (
333     p_source_id                 in number
334    ,p_object_version_number        in number
335   );
336 --
337 end pay_pmed_accounts_api;