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