1 Package ghr_complaints_ca_headers_api as
2 /* $Header: ghcahapi.pkh 120.1 2005/10/02 01:57:09 aroussel $ */
3 /*#
4 * This package contains the procedures for creating, updating, and deleting
5 * GHR Complaint Tracking, Corrective Action Header records.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Complaint Corrective Action Header
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------------< create_ca_header >-------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates Complaint Tracking Corrective Action Header records.
18 *
19 * This API creates a child Corrective Action Header record in table
20 * ghr_compl_ca_headers for an existing parent Complaint.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * A parent Complaint record must exist in ghr_complaints2.
27 *
28 * <p><b>Post Success</b><br>
29 * The API Creates the Corrective Action Header record in the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The API does not create the Corrective Action Header record and an error is
33 * raised.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Reference date for validating lookup values are
38 * applicable during the start to end active date range. This date does not
39 * determine when the changes take effect.
40 * @param p_complaint_id Unique key of the Parent Complaint record.
41 * @param p_ca_source Complaint Corrective Action Header, Corrective Action
42 * Source. Valid values are defined by 'GHR_US_COMPLAINT_SOURCE' lookup type.
43 * @param p_last_compliance_report {@rep:casecolumn
44 * GHR_COMPL_CA_HEADERS.LAST_COMPLIANCE_REPORT}
45 * @param p_compliance_closed {@rep:casecolumn
46 * GHR_COMPL_CA_HEADERS.COMPLIANCE_CLOSED}
47 * @param p_compl_docket_number {@rep:casecolumn
48 * GHR_COMPL_CA_HEADERS.COMPL_DOCKET_NUMBER}
49 * @param p_appeal_docket_number {@rep:casecolumn
50 * GHR_COMPL_CA_HEADERS.APPEAL_DOCKET_NUMBER}
51 * @param p_pfe_docket_number {@rep:casecolumn
52 * GHR_COMPL_CA_HEADERS.PFE_DOCKET_NUMBER}
53 * @param p_pfe_received {@rep:casecolumn GHR_COMPL_CA_HEADERS.PFE_RECEIVED}
54 * @param p_agency_brief_pfe_due {@rep:casecolumn
55 * GHR_COMPL_CA_HEADERS.AGENCY_BRIEF_PFE_DUE}
56 * @param p_agency_brief_pfe_date {@rep:casecolumn
57 * GHR_COMPL_CA_HEADERS.AGENCY_BRIEF_PFE_DATE}
58 * @param p_decision_pfe_date {@rep:casecolumn
59 * GHR_COMPL_CA_HEADERS.DECISION_PFE_DATE}
60 * @param p_decision_pfe {@rep:casecolumn GHR_COMPL_CA_HEADERS.DECISION_PFE}
61 * @param p_agency_recvd_pfe_decision {@rep:casecolumn
62 * GHR_COMPL_CA_HEADERS.AGENCY_RECVD_PFE_DECISION}
63 * @param p_agency_pfe_brief_forwd {@rep:casecolumn
64 * GHR_COMPL_CA_HEADERS.AGENCY_PFE_BRIEF_FORWD}
65 * @param p_agency_notified_noncom {@rep:casecolumn
66 * GHR_COMPL_CA_HEADERS.AGENCY_NOTIFIED_NONCOM}
67 * @param p_comrep_noncom_req Complaint Corrective Action Header, Complainant
68 * Representative Request. Valid values are defined by 'GHR_US_REQUEST' lookup
69 * type.
70 * @param p_eeo_off_req_data_from_org {@rep:casecolumn
71 * GHR_COMPL_CA_HEADERS.EEO_OFF_REQ_DATA_FROM_ORG}
72 * @param p_org_forwd_data_to_eeo_off {@rep:casecolumn
73 * GHR_COMPL_CA_HEADERS.ORG_FORWD_DATA_TO_EEO_OFF}
74 * @param p_dec_implemented {@rep:casecolumn
75 * GHR_COMPL_CA_HEADERS.DEC_IMPLEMENTED}
76 * @param p_complaint_reinstated {@rep:casecolumn
77 * GHR_COMPL_CA_HEADERS.COMPLAINT_REINSTATED}
78 * @param p_stage_complaint_reinstated Complaint Corrective Action Header,
79 * Stage Complaint Reinstated. Valid values are defined by 'GHR_US_STAGE'
80 * lookup type.
81 * @param p_compl_ca_header_id If p_validate is false, then this uniquely
82 * identifies the Corrective Action Header created. If p_validate is true, then
83 * set to null.
84 * @param p_object_version_number If p_validate is false, then set to the
85 * version number of the created Corrective Action Header. If p_validate is
86 * true, then the value will be null.
87 * @rep:displayname Create Corrective Action Header
88 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
89 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
90 * @rep:scope public
91 * @rep:lifecycle active
92 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
93 */
94 --
95 -- {End Of Comments}
96 --
97 procedure create_ca_header
98 (p_validate in boolean default false
99 ,p_effective_date in date
100 ,p_complaint_id in number default null
101 ,p_ca_source in varchar2 default null
102 ,p_last_compliance_report in date default null
103 ,p_compliance_closed in date default null
104 ,p_compl_docket_number in varchar2 default null
105 ,p_appeal_docket_number in varchar2 default null
106 ,p_pfe_docket_number in varchar2 default null
107 ,p_pfe_received in date default null
108 ,p_agency_brief_pfe_due in date default null
109 ,p_agency_brief_pfe_date in date default null
110 ,p_decision_pfe_date in date default null
111 ,p_decision_pfe in varchar2 default null
112 ,p_agency_recvd_pfe_decision in date default null
113 ,p_agency_pfe_brief_forwd in date default null
114 ,p_agency_notified_noncom in date default null
115 ,p_comrep_noncom_req in varchar2 default null
116 ,p_eeo_off_req_data_from_org in date default null
117 ,p_org_forwd_data_to_eeo_off in date default null
118 ,p_dec_implemented in date default null
119 ,p_complaint_reinstated in date default null
120 ,p_stage_complaint_reinstated in varchar2 default null
121 ,p_compl_ca_header_id out nocopy number
122 ,p_object_version_number out nocopy number
123 );
124 --
125 -- ----------------------------------------------------------------------------
126 -- |-----------------------------< update_ca_header >-------------------------|
127 -- ----------------------------------------------------------------------------
128 --
129 -- {Start Of Comments}
130 /*#
131 * This API updates the Complaint Tracking, Corrective Action Header records.
132 *
133 * This API updates a child Corrective Action Header record in table
134 * ghr_compl_ca_headers for an existing parent Complaint.
135 *
136 * <p><b>Licensing</b><br>
137 * This API is licensed for use with Human Resources.
138 *
139 * <p><b>Prerequisites</b><br>
140 * A parent Complaint record must exist in ghr_complaints2.
141 *
142 * <p><b>Post Success</b><br>
143 * The API updates the Corrective Action Header record in the database.
144 *
145 * <p><b>Post Failure</b><br>
146 * The API does not update the Corrective Action Header record and an error is
147 * raised.
148 * @param p_validate If true, then validation alone will be performed and the
149 * database will remain unchanged. If false and all validation checks pass,
150 * then the database will be modified.
151 * @param p_effective_date Reference date for validating lookup values are
152 * applicable during the start to end active date range. This date does not
153 * determine when the changes take effect.
154 * @param p_compl_ca_header_id Uniquely identifies the Parent Corrective Action
155 * Header record.
156 * @param p_object_version_number Pass in the current version number of the
157 * Corrective Action Header to be updated. When the API completes if p_validate
158 * is false, will be set to the new version number of the updated Corrective
159 * Action Header. If p_validate is true will be set to the same value which was
160 * passed in.
161 * @param p_complaint_id Uniquely identifies the Parent Complaint record.
162 * @param p_ca_source Complaint Corrective Action Header, Corrective Action
163 * Source. Valid values are defined by 'GHR_US_COMPLAINT_SOURCE' lookup type.
164 * @param p_last_compliance_report {@rep:casecolumn
165 * GHR_COMPL_CA_HEADERS.LAST_COMPLIANCE_REPORT}
166 * @param p_compliance_closed {@rep:casecolumn
167 * GHR_COMPL_CA_HEADERS.COMPLIANCE_CLOSED}
168 * @param p_compl_docket_number {@rep:casecolumn
169 * GHR_COMPL_CA_HEADERS.COMPL_DOCKET_NUMBER}
170 * @param p_appeal_docket_number {@rep:casecolumn
171 * GHR_COMPL_CA_HEADERS.APPEAL_DOCKET_NUMBER}
172 * @param p_pfe_docket_number {@rep:casecolumn
173 * GHR_COMPL_CA_HEADERS.PFE_DOCKET_NUMBER}
174 * @param p_pfe_received {@rep:casecolumn GHR_COMPL_CA_HEADERS.PFE_RECEIVED}
175 * @param p_agency_brief_pfe_due {@rep:casecolumn
176 * GHR_COMPL_CA_HEADERS.AGENCY_BRIEF_PFE_DUE}
177 * @param p_agency_brief_pfe_date {@rep:casecolumn
178 * GHR_COMPL_CA_HEADERS.AGENCY_BRIEF_PFE_DATE}
179 * @param p_decision_pfe_date {@rep:casecolumn
180 * GHR_COMPL_CA_HEADERS.DECISION_PFE_DATE}
181 * @param p_decision_pfe {@rep:casecolumn GHR_COMPL_CA_HEADERS.DECISION_PFE}
182 * @param p_agency_recvd_pfe_decision {@rep:casecolumn
183 * GHR_COMPL_CA_HEADERS.AGENCY_RECVD_PFE_DECISION}
184 * @param p_agency_pfe_brief_forwd {@rep:casecolumn
185 * GHR_COMPL_CA_HEADERS.AGENCY_PFE_BRIEF_FORWD}
186 * @param p_agency_notified_noncom {@rep:casecolumn
187 * GHR_COMPL_CA_HEADERS.AGENCY_NOTIFIED_NONCOM}
188 * @param p_comrep_noncom_req Complaint Corrective Action Header, Complainant
189 * Representative Request. Valid values are defined by 'GHR_US_REQUEST' lookup
190 * type.
191 * @param p_eeo_off_req_data_from_org {@rep:casecolumn
192 * GHR_COMPL_CA_HEADERS.EEO_OFF_REQ_DATA_FROM_ORG}
193 * @param p_org_forwd_data_to_eeo_off {@rep:casecolumn
194 * GHR_COMPL_CA_HEADERS.ORG_FORWD_DATA_TO_EEO_OFF}
195 * @param p_dec_implemented {@rep:casecolumn
196 * GHR_COMPL_CA_HEADERS.DEC_IMPLEMENTED}
197 * @param p_complaint_reinstated {@rep:casecolumn
198 * GHR_COMPL_CA_HEADERS.COMPLAINT_REINSTATED}
199 * @param p_stage_complaint_reinstated Complaint Corrective Action Header,
200 * Stage Complaint Reinstated. Valid values are defined by 'GHR_US_STAGE'
201 * lookup type.
202 * @rep:displayname Update Corrective Action Header
203 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
204 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
205 * @rep:scope public
206 * @rep:lifecycle active
207 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
208 */
209 --
210 -- {End Of Comments}
211 --
212 procedure update_ca_header
213 (p_validate in boolean default false
214 ,p_effective_date in date
215 ,p_compl_ca_header_id in number
216 ,p_object_version_number in out nocopy number
217 ,p_complaint_id in number default hr_api.g_number
218 ,p_ca_source in varchar2 default hr_api.g_varchar2
219 ,p_last_compliance_report in date default hr_api.g_date
220 ,p_compliance_closed in date default hr_api.g_date
221 ,p_compl_docket_number in varchar2 default hr_api.g_varchar2
222 ,p_appeal_docket_number in varchar2 default hr_api.g_varchar2
223 ,p_pfe_docket_number in varchar2 default hr_api.g_varchar2
224 ,p_pfe_received in date default hr_api.g_date
225 ,p_agency_brief_pfe_due in date default hr_api.g_date
226 ,p_agency_brief_pfe_date in date default hr_api.g_date
227 ,p_decision_pfe_date in date default hr_api.g_date
228 ,p_decision_pfe in varchar2 default hr_api.g_varchar2
229 ,p_agency_recvd_pfe_decision in date default hr_api.g_date
230 ,p_agency_pfe_brief_forwd in date default hr_api.g_date
231 ,p_agency_notified_noncom in date default hr_api.g_date
232 ,p_comrep_noncom_req in varchar2 default hr_api.g_varchar2
233 ,p_eeo_off_req_data_from_org in date default hr_api.g_date
234 ,p_org_forwd_data_to_eeo_off in date default hr_api.g_date
235 ,p_dec_implemented in date default hr_api.g_date
236 ,p_complaint_reinstated in date default hr_api.g_date
237 ,p_stage_complaint_reinstated in varchar2 default hr_api.g_varchar2
238 );
239 --
240 -- ----------------------------------------------------------------------------
241 -- |-----------------------------< delete_ca_header >-------------------------|
242 -- ----------------------------------------------------------------------------
243 --
244 -- {Start Of Comments}
245 /*#
246 * This API deletes Complaint Tracking Corrective Action Header records.
247 *
248 * This API deletes a child Corrective Action Header record from table
249 * ghr_compl_ca_headers for an existing parent Complaint.
250 *
251 * <p><b>Licensing</b><br>
252 * This API is licensed for use with Human Resources.
253 *
254 * <p><b>Prerequisites</b><br>
255 * The Corrective Action Header record specified must exist.
256 *
257 * <p><b>Post Success</b><br>
258 * The API deletes the Corrective Action Header record from the database.
259 *
260 * <p><b>Post Failure</b><br>
261 * The API does not delete the Corrective Action Header record and an error is
262 * raised.
263 * @param p_validate If true, then validation alone will be performed and the
264 * database will remain unchanged. If false and all validation checks pass,
265 * then the database will be modified.
266 * @param p_compl_ca_header_id Uniquely identifies the Corrective Action Header
267 * record to be deleted.
268 * @param p_object_version_number Current version number of the Corrective
269 * Action Header to be deleted.
270 * @rep:displayname Delete Corrective Action Header
271 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
272 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
273 * @rep:scope public
274 * @rep:lifecycle active
275 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
276 */
277 --
278 -- {End Of Comments}
279 --
280 procedure delete_ca_header
281 (p_validate in boolean default false
282 ,p_compl_ca_header_id in number
283 ,p_object_version_number in number
284 );
285
286 end ghr_complaints_ca_headers_api;
[Home] [Help]