1 Package pay_wci_rates_api as
2 /* $Header: pypwrapi.pkh 120.1 2005/10/02 02:33:57 aroussel $ */
3 /*#
4 * This package contains WCI rates APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Worker Compensation Rate
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_wci_rate >--------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates Workers compensation rate for an existing WCI account.
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 Workers compensation account should already exist
24 *
25 * <p><b>Post Success</b><br>
26 * The Workers compensation rate will be created
27 *
28 * <p><b>Post Failure</b><br>
29 * The Workers compensation rate will not be created
30 * @param p_validate If true, then validation alone will be performed and the
31 * database will remain unchanged. If false and all validation checks pass,
32 * then the database will be modified.
33 * @param p_account_id Account id for the Workers compensation account for
34 * which the rate to be created
35 * @param p_code Code of the Workers compensation rate to be created
36 * @param p_rate Rate of the Workers compensation rate to be created
37 * @param p_description Description of the Workers compensation rate to be
38 * created
39 * @param p_comments Comment text
40 * @param p_rate_id The rate_id of the Workers compensation rate created
41 * @param p_object_version_number If p_validate is false, then set to the
42 * version number of the created WCI rate. If p_validate is true, then the
43 * value will be null
44 * @rep:displayname Create Worker Compensation Rate
45 * @rep:category BUSINESS_ENTITY PAY_WORKERS_COMPENSATION
46 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
47 * @rep:scope public
48 * @rep:lifecycle active
49 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
50 */
51 --
52 -- {End Of Comments}
53 --
54 procedure create_wci_rate
55 (p_validate in boolean default false
56 ,p_account_id in number
57 ,p_code in varchar2
58 ,p_rate in number default null
59 ,p_description in varchar2 default null
60 ,p_comments in varchar2 default null
61 ,p_rate_id out nocopy number
62 ,p_object_version_number out nocopy number
63 );
64 --
65 -- ----------------------------------------------------------------------------
66 -- |-----------------------------< update_wci_rate >--------------------------|
67 -- ----------------------------------------------------------------------------
68 --
69 -- {Start Of Comments}
70 /*#
71 * This API updates an existing Workers compensation rate.
72 *
73 *
74 * <p><b>Licensing</b><br>
75 * This API is licensed for use with Human Resources.
76 *
77 * <p><b>Prerequisites</b><br>
78 * The Workers compensation rate whould already exist for the business group
79 *
80 * <p><b>Post Success</b><br>
81 * The Workers compensation rate will be updated
82 *
83 * <p><b>Post Failure</b><br>
84 * The Workers compensation rate will not be updated
85 * @param p_validate If true, then validation alone will be performed and the
86 * database will remain unchanged. If false and all validation checks pass,
87 * then the database will be modified.
88 * @param p_rate_id The rate_id for the Workers compensation rate to be updated
89 * @param p_object_version_number Pass in the current version number of the
90 * Workers compensation rate to be updated. When the API completes if
91 * p_validate is false, will be set to the new version number of the updated
92 * Workers compensation rate. If p_validate is true will be set to the same
93 * value which was passed in
94 * @param p_code {@rep:casecolumn PAY_WCI_RATES.CODE}
95 * @param p_rate {@rep:casecolumn PAY_WCI_RATES.RATE}
96 * @param p_description Description of the Workers compensation rate to be
97 * updated
98 * @param p_comments Comment text
99 * @rep:displayname Update Worker Compensation Rate
100 * @rep:category BUSINESS_ENTITY PAY_WORKERS_COMPENSATION
101 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
102 * @rep:scope public
103 * @rep:lifecycle active
104 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
105 */
106 --
107 -- {End Of Comments}
108 --
109 procedure update_wci_rate
110 (p_validate in boolean default false
111 ,p_rate_id in number
112 ,p_object_version_number in out nocopy number
113 ,p_code in varchar2 default hr_api.g_varchar2
114 ,p_rate in number default hr_api.g_number
115 ,p_description in varchar2 default hr_api.g_varchar2
116 ,p_comments in varchar2 default hr_api.g_varchar2
117 );
118 --
119 -- ----------------------------------------------------------------------------
120 -- |-----------------------------< delete_wci_rate >--------------------------|
121 -- ----------------------------------------------------------------------------
122 --
123 -- {Start Of Comments}
124 /*#
125 * This API deletes a Workers compensation rate.
126 *
127 *
128 * <p><b>Licensing</b><br>
129 * This API is licensed for use with Human Resources.
130 *
131 * <p><b>Prerequisites</b><br>
132 * The rate_id should alredy exist
133 *
134 * <p><b>Post Success</b><br>
135 * The Workers compensation rate will be deleted
136 *
137 * <p><b>Post Failure</b><br>
138 * The WCI rate will not be deleted
139 * @param p_validate If true, then validation alone will be performed and the
140 * database will remain unchanged. If false and all validation checks pass,
141 * then the database will be modified.
142 * @param p_object_version_number Current version number of the Workers
143 * compensation rate to be deleted
144 * @param p_rate_id Rate_id for which the occupation is being deleted
145 * @rep:displayname Delete Worker Compensation Rate
146 * @rep:category BUSINESS_ENTITY PAY_WORKERS_COMPENSATION
147 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
148 * @rep:scope public
149 * @rep:lifecycle active
150 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
151 */
152 --
153 -- {End Of Comments}
154 --
155 procedure delete_wci_rate
156 (p_validate in boolean default false
157 ,p_object_version_number in number
158 ,p_rate_id in number
159 );
160 --
161 end pay_wci_rates_api;
[Home] [Help]