1 Package pay_wci_accounts_api as
2 /* $Header: pypwaapi.pkh 120.1 2005/10/02 02:33:47 aroussel $ */
3 /*#
4 * This Package contains Workers Compensation Account APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Worker Compensation Account for Canada
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_wci_account >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates Workers Compensation Account for a Business Group for a
17 * location.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Human Resources.
22 *
23 * <p><b>Prerequisites</b><br>
24 * The business group and the location_id for which the account is being
25 * created , should exist.
26 *
27 * <p><b>Post Success</b><br>
28 * It will create a Workers compensation account for that business group
29 *
30 * <p><b>Post Failure</b><br>
31 * It will not create a Workers compensation account for that business group
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_effective_date Determines when the DateTrack operation comes into
36 * force.
37 * @param p_business_group_id Business Group Id for which the Workers
38 * compensation account number is created
39 * @param p_carrier_id Carrier ID
40 * @param p_account_number Workers compensation Account number
41 * @param p_name Name of the Workers compensation account
42 * @param p_location_id Location ID for which the Workers compensation account
43 * number is created
44 * @param p_comments Comment text
45 * @param p_account_id The Account_id created for the Workers compensation
46 * account.
47 * @param p_object_version_number If p_validate is false, then set to the
48 * version number of the created Workers compensation account. If p_validate is
49 * true, then the value will be null.
50 * @rep:displayname Create Worker Compensation Account
51 * @rep:category BUSINESS_ENTITY PAY_WORKERS_COMPENSATION
52 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
53 * @rep:scope public
54 * @rep:lifecycle active
55 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
56 */
57 --
58 -- {End Of Comments}
59 --
60 procedure create_wci_account
61 (p_validate in boolean default false
62 ,p_effective_date in date
63 ,p_business_group_id in number
64 ,p_carrier_id in number
65 ,p_account_number in varchar2
66 ,p_name in varchar2 default null
67 ,p_location_id in number default null
68 ,p_comments in varchar2 default null
69 ,p_account_id out nocopy number
70 ,p_object_version_number out nocopy number
71 );
72 --
73 -- ----------------------------------------------------------------------------
74 -- |----------------------------< update_wci_account >------------------------|
75 -- ----------------------------------------------------------------------------
76 --
77 -- {Start Of Comments}
78 /*#
79 * This API updates Workers Compensation Account for a Business Group and
80 * location.
81 *
82 *
83 * <p><b>Licensing</b><br>
84 * This API is licensed for use with Human Resources.
85 *
86 * <p><b>Prerequisites</b><br>
87 * The Workers compensation account should exist
88 *
89 * <p><b>Post Success</b><br>
90 * The Workers compensation account will be updated
91 *
92 * <p><b>Post Failure</b><br>
93 * The Workers compensation account will not be updated
94 * @param p_validate If true, then validation alone will be performed and the
95 * database will remain unchanged. If false and all validation checks pass,
96 * then the database will be modified.
97 * @param p_effective_date Determines when the DateTrack operation comes into
98 * force.
99 * @param p_account_id The account_id of the WCI account which is being updated
100 * @param p_object_version_number Pass in the current version number of the
101 * Workers compensation account to be updated. When the API completes if
102 * p_validate is false, will be set to the new version number of the updated
103 * Workers compensation account. If p_validate is true will be set to the same
104 * value which was passed in.
105 * @param p_name The new name of the WCI account which is being updated
106 * @param p_account_number The new Account Number of the account which is being
107 * updated
108 * @param p_location_id The new location ID of the account which is being
109 * updated
110 * @param p_comments Comment text
111 * @rep:displayname Update Worker Compensation Account
112 * @rep:category BUSINESS_ENTITY PAY_WORKERS_COMPENSATION
113 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
114 * @rep:scope public
115 * @rep:lifecycle active
116 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
117 */
118 --
119 -- {End Of Comments}
120 --
121 procedure update_wci_account
122 (p_validate in boolean default false
123 ,p_effective_date in date
124 ,p_account_id in number
125 ,p_object_version_number in out nocopy number
126 ,p_name in varchar2 default hr_api.g_varchar2
127 ,p_account_number in varchar2 default hr_api.g_varchar2
128 ,p_location_id in number default hr_api.g_number
129 ,p_comments in varchar2 default hr_api.g_varchar2
130 );
131 --
132 -- ----------------------------------------------------------------------------
133 -- |----------------------------< delete_wci_account >------------------------|
134 -- ----------------------------------------------------------------------------
135 --
136 -- {Start Of Comments}
137 /*#
138 * This API deletes an existing Workers compensation account.
139 *
140 *
141 * <p><b>Licensing</b><br>
142 * This API is licensed for use with Human Resources.
143 *
144 * <p><b>Prerequisites</b><br>
145 * The Workers compensation account to be deleted exists
146 *
147 * <p><b>Post Success</b><br>
148 * The Workers compensation account will be deleted
149 *
150 * <p><b>Post Failure</b><br>
151 * The Workers compensation account will not be deleted
152 * @param p_validate If true, then validation alone will be performed and the
153 * database will remain unchanged. If false and all validation checks pass,
154 * then the database will be modified.
155 * @param p_account_id Account ID of the Workers compensation account to be
156 * deleted
157 * @param p_object_version_number Current version number of the Workers
158 * compensation account to be deleted.
159 * @rep:displayname Delete Worker Compensation Account
160 * @rep:category BUSINESS_ENTITY PAY_WORKERS_COMPENSATION
161 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
162 * @rep:scope public
163 * @rep:lifecycle active
164 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
165 */
166 --
167 -- {End Of Comments}
168 --
169 procedure delete_wci_account
170 (p_validate in boolean default false
171 ,p_account_id in number
172 ,p_object_version_number in number
173 );
174 --
175 end pay_wci_accounts_api;
[Home] [Help]