1 Package ghr_compl_agency_costs_api as
2 /* $Header: ghcstapi.pkh 120.3 2006/10/11 14:13:52 utokachi noship $ */
3 /*#
4 * This package contains the procedures for creating, updating
5 * and deleting GHR Complaints Tracking Agency Cost records.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Complaint Agency Costs
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |--------------------------<create_agency_costs> >--------------------------|
13 -- ----------------------------------------------------------------------------
14 -- {Start Of Comments}
15 /*#
16 * This API creates a Complaints Tracking Agency Cost record.
17 *
18 * This API creates a child Agency Cost record for a Complaint
19 * in table ghr_compl_agency_costs.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The Complaint must exist on the effective date.
26 *
27 * <p><b>Post Success</b><br>
28 * The API creates a Complaint Agency Cost record in the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The API does not create the Complaint Agency Cost record
32 * and an error is raised.
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_effective_date Reference date for validating lookup values are
37 * applicable during the start to end active date range. This date does not
38 * determine when the changes take effect.
39 * @param p_complaint_id Uniquely identifies the Complaint.
40 * @param p_phase Complaint Agency Cost Phase. Valid values
41 * are defined by 'GHR_US_PRE_COST_PHASES' lookup type.
42 * @param p_stage Complaint Agency Cost Stage. Valid values
43 * are defined by 'GHR_US_STAGE' lookup type.
44 * @param p_category Complaint Agency Cost Category. Valid values are derived
45 * by the 'GHR_US_STAGE' lookup type code value selected in
46 * Complaint Agency Cost Stage.
47 * @param p_amount Complaint Agency Cost amount.
48 * @param p_cost_date Complaint Agency Cost Date.
49 * @param p_description Complaint Agency Cost Description.
50 * @param p_compl_agency_cost_id If p_validate is false, then this uniquely
51 * identifies the Complaint Agency Cost created. If p_validate is true,
52 * then set to null.
53 * @param p_object_version_number If p_validate is false, then set to the
54 * version number of the created Complaint Agency Cost. If p_validate is true,
55 * then the value will be null.
56 * @rep:displayname Create Complaint Agency Cost
57 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
58 * @rep:lifecycle active
59 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
60 * @rep:scope public
61 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
62 */
63
64 --
65 -- Description:
66 --
67 -- This api creates a Complaints Agency Cost records in the ghr_compl_agency_costs table.
68 --
69 -- Prerequisites:
70 --
71 --
72 -- In Parameters:
73 -- Name Reqd Type Description
74 --
75 --
76 -- Post Success:
77 -- The api will set the following out parameters:
78 --
79 -- p_compl_agency_cost_id number
80 -- p_object_version_number number
81 --
82 -- Post Failure:
83 -- The api will not create the Complaint Agency Cost record and raises an error.
84 --
85 --
86 --
87 -- Access Status:
88 -- Public.
89 --
90 -- {End Of Comments}
91 --
92 procedure create_agency_costs
93 (p_validate in boolean default false
94 ,p_effective_date in date
95 ,p_complaint_id in number
96 ,p_phase in varchar2 default null
97 ,p_stage in varchar2 default null
98 ,p_category in varchar2 default null
99 ,p_amount in number default null
100 ,p_cost_date in date default null
101 ,p_description in varchar2 default null
102 ,p_compl_agency_cost_id out nocopy number
103 ,p_object_version_number out nocopy number
104 );
105 --
106
107
108 -- ----------------------------------------------------------------------------
109 -- |--------------------------<update_agency_costs> >--------------------------|
110 -- ----------------------------------------------------------------------------
111 -- {Start Of Comments}
112 /*#
113 * This API updates a Complaints Tracking Agency Cost record.
114 *
115 * This API updates a child Agency Cost record in table
116 * ghr_compl_agency_costs for an existing parent Complaint.
117 *
118 * <p><b>Licensing</b><br>
119 * This API is licensed for use with Human Resources.
120 *
121 * <p><b>Prerequisites</b><br>
122 * The Complaint must exist on the effective date.
123 *
124 * <p><b>Post Success</b><br>
125 * The API updates the Complaint Agency Cost record in the database.
126 *
127 * <p><b>Post Failure</b><br>
128 * The API does not update the Complaint Agency Cost record
129 * and an error is raised.
130 * @param p_validate If true, then validation alone will be performed and the
131 * database will remain unchanged. If false and all validation checks pass,
132 * then the database will be modified.
133 * @param p_effective_date Reference date for validating lookup values are
134 * applicable during the start to end active date range. This date does not
135 * determine when the changes take effect.
136 * @param p_compl_agency_cost_id Uniquely identifies the Complaint Agency Cost
137 * record to be updated.
138 * @param p_complaint_id Uniquely identifies the Complaint.
139 * @param p_phase Complaint Agency Cost Phase. Valid values
140 * are defined by 'GHR_US_PRE_COST_PHASES' lookup type.
141 * @param p_stage Complaint Agency Cost Stage. Valid values
142 * are defined by 'GHR_US_STAGE' lookup type.
143 * @param p_category Complaint Agency Cost Category. Valid values are derived
144 * by the 'GHR_US_STAGE' lookup type code value selected in Cost Stage.
145 * @param p_amount Complaint Agency Cost amount.
146 * @param p_cost_date Complaint Agency Cost Date.
147 * @param p_description Complaint Agency Cost Description.
148 * @param p_object_version_number Pass in the current version number of the
149 * Agency Cost to be updated. When the API completes if p_validate is false,
150 * will be set to the new version number of the updated Agency Cost.
151 * If p_validate is true will be set to the same value which was passed in.
152 * @rep:displayname Update Complaint Agency Cost
153 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
154 * @rep:lifecycle active
155 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
156 * @rep:scope public
157 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
158 */
159
160 --
161 -- Description:
162 --
163 -- This api updates a Complaint Agency Cost record in the ghr_compl_agency_costs table.
164 --
165 -- Prerequisites:
166 --
167 --
168 -- In Parameters:
169 -- Name Reqd Type Description
170 --
171 --
172 -- Post Success:
173 -- The api will set the following out parameters:
174 --
175 -- p_object_version_number number
176 --
177 -- Post Failure:
178 -- The api will not update the Complaint Agency Cost record and raises an error
179 --
180 --
181 --
182 -- Access Status:
183 -- Public.
184 --
185 -- {End Of Comments}
186 --
187 procedure update_agency_costs
188 (p_validate in boolean default false
189 ,p_effective_date in date
190 ,p_compl_agency_cost_id in number
191 ,p_complaint_id in number default hr_api.g_number
192 ,p_phase in varchar2 default hr_api.g_varchar2
193 ,p_stage in varchar2 default hr_api.g_varchar2
194 ,p_category in varchar2 default hr_api.g_varchar2
195 ,p_amount in number default hr_api.g_number
196 ,p_cost_date in date default hr_api.g_date
197 ,p_description in varchar2 default hr_api.g_varchar2
198 ,p_object_version_number in out nocopy number
199 );
200
201 -- ----------------------------------------------------------------------------
202 -- |--------------------------<delete_agency_costs> >--------------------------|
203 -- ----------------------------------------------------------------------------
204 -- {Start Of Comments}
205 /*#
206 * This API deletes a Complaints Tracking Agency Cost record.
207 *
208 * This API deletes a child Agency Cost record from table ghr_compl_agency_costs
209 * for an existing parent Complaint.
210 *
211 * <p><b>Licensing</b><br>
212 * This API is licensed for use with Human Resources.
213 *
214 * <p><b>Prerequisites</b><br>
215 * The Complaint record specified must exist.
216 *
217 * <p><b>Post Success</b><br>
218 * The API deletes the Complaint Agency Cost record in the database.
219 *
220 * <p><b>Post Failure</b><br>
221 * The API does not delete the Complaint Agency Cost record
222 * and an error is raised.
223 * @param p_validate If true, then validation alone will be performed and the
224 * database will remain unchanged. If false and all validation checks pass,
225 * then the database will be modified.
226 * @param p_compl_agency_cost_id Uniquely identifies the Complaint Agency Cost
227 * record to be deleted.
228 * @param p_object_version_number Current version number of the
229 * Complaint Agency Cost to be deleted.
230 * @rep:displayname Delete Complaint Agency Cost
231 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
232 * @rep:lifecycle active
233 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
234 * @rep:scope public
235 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
236 */
237
238 --
239 -- Description:
240 --
241 -- This api deletes a Complaints Agency Costs record in the ghr_compl_agency_costs table.
242 --
243 -- Prerequisites:
244 --
245 --
246 -- In Parameters:
247 -- Name Reqd Type Description
248 --
249 --
250 -- Post Success:
251 -- The complaints Agency Costs record is deleted.
252 --
253 --
254 -- Post Failure:
255 -- The api will not delete the complaints Agency Costs record and raises an error.
256 --
257 --
258 --
259 -- Access Status:
260 -- Public.
261 --
262 -- {End Of Comments}
263 --
264 procedure delete_agency_costs
265 (p_validate in boolean default false
266 ,p_compl_agency_cost_id in number
267 ,p_object_version_number in number
268 );
269
270 end ghr_compl_agency_costs_api;
[Home] [Help]