DBA Data[Home] [Help]

PACKAGE: APPS.GHR_COMPLAINANT_APPEALS_API

Source


1 Package ghr_complainant_appeals_api as
2 /* $Header: ghccaapi.pkh 120.1 2005/10/02 01:57:18 aroussel $ */
3 /*#
4  * This package contains the procedures for creating, updating and deleting GHR
5  * Complaints Tracking Complainant Appeal records.
6  * @rep:scope public
7  * @rep:product per
8  * @rep:displayname Complainant Appeal
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |------------------------< create_complainant_appeal >---------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17  * This API creates Complaints Tracking Complainant Appeal records.
18  *
19  * This API creates a child Complainant Appeal record in table
20  * ghr_compl_appeals 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 Complainant Appeal record in the database.
30  *
31  * <p><b>Post Failure</b><br>
32  * The API does not create the Complainant Appeal 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 Uniquely identifies the Parent Complaint record.
41  * @param p_appeal_date {@rep:casecolumn GHR_COMPL_APPEALS.APPEAL_DATE}
42  * @param p_appealed_to Complainant Appealed To Organization. Valid values are
43  * defined by 'GHR_US_APPEAL_TO' lookup type.
44  * @param p_reason_for_appeal Complainant Reason for Appeal. Valid values are
45  * defined by 'GHR_US_APPEAL_REASON' lookup type.
46  * @param p_source_decision_date {@rep:casecolumn
47  * GHR_COMPL_APPEALS.SOURCE_DECISION_DATE}
48  * @param p_docket_num {@rep:casecolumn GHR_COMPL_APPEALS.DOCKET_NUM}
49  * @param p_org_notified_of_appeal {@rep:casecolumn
50  * GHR_COMPL_APPEALS.ORG_NOTIFIED_OF_APPEAL}
51  * @param p_agency_recvd_req_for_files {@rep:casecolumn
52  * GHR_COMPL_APPEALS.AGENCY_RECVD_REQ_FOR_FILES}
53  * @param p_files_due {@rep:casecolumn GHR_COMPL_APPEALS.FILES_DUE}
54  * @param p_files_forwd {@rep:casecolumn GHR_COMPL_APPEALS.FILES_FORWD}
55  * @param p_agcy_recvd_appellant_brief {@rep:casecolumn
56  * GHR_COMPL_APPEALS.AGCY_RECVD_APPELLANT_BRIEF}
57  * @param p_agency_brief_due {@rep:casecolumn
58  * GHR_COMPL_APPEALS.AGENCY_BRIEF_DUE}
59  * @param p_appellant_brief_forwd_org {@rep:casecolumn
60  * GHR_COMPL_APPEALS.APPELLANT_BRIEF_FORWD_ORG}
61  * @param p_org_forwd_brief_to_agency {@rep:casecolumn
62  * GHR_COMPL_APPEALS.ORG_FORWD_BRIEF_TO_AGENCY}
63  * @param p_agency_brief_forwd {@rep:casecolumn
64  * GHR_COMPL_APPEALS.AGENCY_BRIEF_FORWD}
65  * @param p_decision_date {@rep:casecolumn GHR_COMPL_APPEALS.DECISION_DATE}
66  * @param p_dec_recvd_by_agency {@rep:casecolumn
67  * GHR_COMPL_APPEALS.DEC_RECVD_BY_AGENCY}
68  * @param p_decision Complainant Appeal Decision. Valid values are defined by
69  * 'GHR_US_APPEAL_DECISION or GHR_US_MSPB_DECISION' lookup type.
70  * @param p_dec_forwd_to_org {@rep:casecolumn
71  * GHR_COMPL_APPEALS.DEC_FORWD_TO_ORG}
72  * @param p_agency_rfr_suspense {@rep:casecolumn
73  * GHR_COMPL_APPEALS.AGENCY_RFR_SUSPENSE}
74  * @param p_request_for_rfr {@rep:casecolumn GHR_COMPL_APPEALS.REQUEST_FOR_RFR}
75  * @param p_rfr_docket_num {@rep:casecolumn GHR_COMPL_APPEALS.RFR_DOCKET_NUM}
76  * @param p_rfr_requested_by Complainant Appeal Request For Reconsideration
77  * (RFR) Requested by. Valid values are defined by 'GHR_US_REQUESTOR' lookup
78  * type.
79  * @param p_agency_rfr_due {@rep:casecolumn GHR_COMPL_APPEALS.AGENCY_RFR_DUE}
80  * @param p_rfr_forwd_to_org {@rep:casecolumn
81  * GHR_COMPL_APPEALS.RFR_FORWD_TO_ORG}
82  * @param p_org_forwd_rfr_to_agency {@rep:casecolumn
83  * GHR_COMPL_APPEALS.ORG_FORWD_RFR_TO_AGENCY}
84  * @param p_agency_forwd_rfr_ofo {@rep:casecolumn
85  * GHR_COMPL_APPEALS.AGENCY_FORWD_RFR_OFO}
86  * @param p_rfr_decision Complainant Appeal Request For Reconsideration (RFR)
87  * Decision. Valid values are defined by 'GHR_US_OFO_RFR_DECISION' lookup type.
88  * @param p_rfr_decision_date {@rep:casecolumn
89  * GHR_COMPL_APPEALS.RFR_DECISION_DATE}
90  * @param p_agency_recvd_rfr_dec {@rep:casecolumn
91  * GHR_COMPL_APPEALS.AGENCY_RECVD_RFR_DEC}
92  * @param p_rfr_decision_forwd_to_org {@rep:casecolumn
93  * GHR_COMPL_APPEALS.RFR_DECISION_FORWD_TO_ORG}
94  * @param p_compl_appeal_id If p_validate is false, then this uniquely
95  * identifies the Complainant Appeal created. If p_validate is true, then set
96  * to null.
97  * @param p_object_version_number If p_validate is false, then set to the
98  * version number of the created Complainant Appeal. If p_validate is true,
99  * then the value will be null.
100  * @rep:displayname Create Complainant Appeal
101  * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
102  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
103  * @rep:scope public
104  * @rep:lifecycle active
105  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
106 */
107 --
108 -- {End Of Comments}
109 --
110 procedure create_complainant_appeal
111   (p_validate                       in     boolean  default false
112   ,p_effective_date                 in     date
113   ,p_complaint_id                   in     number
114   ,p_appeal_date                    in     date     default null
115   ,p_appealed_to                    in     varchar2 default null
116   ,p_reason_for_appeal              in     varchar2 default null
117   ,p_source_decision_date           in     date     default null
118   ,p_docket_num                     in     varchar2 default null
119   ,p_org_notified_of_appeal         in     date     default null
120   ,p_agency_recvd_req_for_files     in     date     default null
121   ,p_files_due                      in     date     default null
122   ,p_files_forwd                    in     date     default null
123   ,p_agcy_recvd_appellant_brief     in     date     default null
124   ,p_agency_brief_due               in     date     default null
125   ,p_appellant_brief_forwd_org      in     date     default null
126   ,p_org_forwd_brief_to_agency      in     date     default null
127   ,p_agency_brief_forwd             in     date     default null
128   ,p_decision_date                  in     date     default null
129   ,p_dec_recvd_by_agency            in     date     default null
130   ,p_decision                       in     varchar2 default null
131   ,p_dec_forwd_to_org               in     date     default null
132   ,p_agency_rfr_suspense            in     date     default null
133   ,p_request_for_rfr                in     date     default null
134   ,p_rfr_docket_num                 in     varchar2 default null
135   ,p_rfr_requested_by               in     varchar2 default null
136   ,p_agency_rfr_due                 in     date     default null
137   ,p_rfr_forwd_to_org               in     date     default null
138   ,p_org_forwd_rfr_to_agency        in     date     default null
139   ,p_agency_forwd_rfr_ofo           in     date     default null
140   ,p_rfr_decision                   in     varchar2 default null
141   ,p_rfr_decision_date              in     date     default null
142   ,p_agency_recvd_rfr_dec           in     date     default null
143   ,p_rfr_decision_forwd_to_org      in     date     default null
144   ,p_compl_appeal_id                out nocopy    number
145   ,p_object_version_number          out nocopy    number
146   );
147 --
148 -- ----------------------------------------------------------------------------
149 -- |------------------------< update_complainant_appeal >---------------------|
150 -- ----------------------------------------------------------------------------
151 --
152 -- {Start Of Comments}
153 /*#
154  * This API updates Complaints Tracking Complainant Appeal records.
155  *
156  * This API updates a child Complainant Appeal record in table
157  * ghr_compl_appeals for an existing parent Complaint.
158  *
159  * <p><b>Licensing</b><br>
160  * This API is licensed for use with Human Resources.
161  *
162  * <p><b>Prerequisites</b><br>
163  * A parent Complaint record must exist in ghr_complaints2.
164  *
165  * <p><b>Post Success</b><br>
166  * The API updates the Complainant Appeal record in the database.
167  *
168  * <p><b>Post Failure</b><br>
169  * The API does not update the Complainant Appeal record and an error is
170  * raised.
171  * @param p_validate If true, then validation alone will be performed and the
172  * database will remain unchanged. If false and all validation checks pass,
173  * then the database will be modified.
174  * @param p_effective_date Reference date for validating lookup values are
175  * applicable during the start to end active date range. This date does not
176  * determine when the changes take effect.
177  * @param p_compl_appeal_id Uniquely identifies the Complainant Appeal record
178  * to be updated.
179  * @param p_object_version_number Pass in the current version number of the
180  * Complainant Appeal to be updated. When the API completes if p_validate is
181  * false, will be set to the new version number of the updated Complainant
182  * Appeal. If p_validate is true will be set to the same value which was passed
183  * in.
184  * @param p_complaint_id Unique key of the Parent Complaint record.
185  * @param p_appeal_date {@rep:casecolumn GHR_COMPL_APPEALS.APPEAL_DATE}
186  * @param p_appealed_to Complainant Appealed To Organization. Valid values are
187  * defined by 'GHR_US_APPEAL_TO' lookup type.
188  * @param p_reason_for_appeal Complainant Reason for Appeal. Valid values are
189  * defined by 'GHR_US_APPEAL_REASON' lookup type.
190  * @param p_source_decision_date {@rep:casecolumn
191  * GHR_COMPL_APPEALS.SOURCE_DECISION_DATE}
192  * @param p_docket_num {@rep:casecolumn GHR_COMPL_APPEALS.DOCKET_NUM}
193  * @param p_org_notified_of_appeal {@rep:casecolumn
194  * GHR_COMPL_APPEALS.ORG_NOTIFIED_OF_APPEAL}
195  * @param p_agency_recvd_req_for_files {@rep:casecolumn
196  * GHR_COMPL_APPEALS.AGENCY_RECVD_REQ_FOR_FILES}
197  * @param p_files_due {@rep:casecolumn GHR_COMPL_APPEALS.FILES_DUE}
198  * @param p_files_forwd {@rep:casecolumn GHR_COMPL_APPEALS.FILES_FORWD}
199  * @param p_agcy_recvd_appellant_brief {@rep:casecolumn
200  * GHR_COMPL_APPEALS.AGCY_RECVD_APPELLANT_BRIEF}
201  * @param p_agency_brief_due {@rep:casecolumn
202  * GHR_COMPL_APPEALS.AGENCY_BRIEF_DUE}
203  * @param p_appellant_brief_forwd_org {@rep:casecolumn
204  * GHR_COMPL_APPEALS.APPELLANT_BRIEF_FORWD_ORG}
205  * @param p_org_forwd_brief_to_agency {@rep:casecolumn
206  * GHR_COMPL_APPEALS.ORG_FORWD_BRIEF_TO_AGENCY}
207  * @param p_agency_brief_forwd {@rep:casecolumn
208  * GHR_COMPL_APPEALS.AGENCY_BRIEF_FORWD}
209  * @param p_decision_date {@rep:casecolumn GHR_COMPL_APPEALS.DECISION_DATE}
210  * @param p_dec_recvd_by_agency {@rep:casecolumn
211  * GHR_COMPL_APPEALS.DEC_RECVD_BY_AGENCY}
212  * @param p_decision Complainant Appeal Decision. Valid values are defined by
213  * 'GHR_US_APPEAL_DECISION or GHR_US_MSPB_DECISION' lookup type.
214  * @param p_dec_forwd_to_org {@rep:casecolumn
215  * GHR_COMPL_APPEALS.DEC_FORWD_TO_ORG}
216  * @param p_agency_rfr_suspense {@rep:casecolumn
217  * GHR_COMPL_APPEALS.AGENCY_RFR_SUSPENSE}
218  * @param p_request_for_rfr {@rep:casecolumn GHR_COMPL_APPEALS.REQUEST_FOR_RFR}
219  * @param p_rfr_docket_num {@rep:casecolumn GHR_COMPL_APPEALS.RFR_DOCKET_NUM}
220  * @param p_rfr_requested_by Complainant Appeal Request For Reconsideration
221  * (RFR) Requested by. Valid values are defined by 'GHR_US_REQUESTOR' lookup
222  * type.
223  * @param p_agency_rfr_due {@rep:casecolumn GHR_COMPL_APPEALS.AGENCY_RFR_DUE}
224  * @param p_rfr_forwd_to_org {@rep:casecolumn
225  * GHR_COMPL_APPEALS.RFR_FORWD_TO_ORG}
226  * @param p_org_forwd_rfr_to_agency {@rep:casecolumn
227  * GHR_COMPL_APPEALS.ORG_FORWD_RFR_TO_AGENCY}
228  * @param p_agency_forwd_rfr_ofo {@rep:casecolumn
229  * GHR_COMPL_APPEALS.AGENCY_FORWD_RFR_OFO}
230  * @param p_rfr_decision Complainant Appeal Request For Reconsideration (RFR)
231  * Decision. Valid values are defined by 'GHR_US_OFO_RFR_DECISION' lookup type.
232  * @param p_rfr_decision_date {@rep:casecolumn
233  * GHR_COMPL_APPEALS.RFR_DECISION_DATE}
234  * @param p_agency_recvd_rfr_dec {@rep:casecolumn
235  * GHR_COMPL_APPEALS.AGENCY_RECVD_RFR_DEC}
236  * @param p_rfr_decision_forwd_to_org {@rep:casecolumn
237  * GHR_COMPL_APPEALS.RFR_DECISION_FORWD_TO_ORG}
238  * @rep:displayname Update Complainant Appeal
239  * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
240  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
241  * @rep:scope public
242  * @rep:lifecycle active
243  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
244 */
245 --
246 -- {End Of Comments}
247 --
248 procedure update_complainant_appeal
249   (p_validate                     in     boolean   default false
250   ,p_effective_date               in     date
251   ,p_compl_appeal_id              in     number
252   ,p_object_version_number        in out nocopy number
253   ,p_complaint_id                 in     number   default hr_api.g_number
254   ,p_appeal_date                  in     date     default hr_api.g_date
255   ,p_appealed_to                  in     varchar2 default hr_api.g_varchar2
256   ,p_reason_for_appeal            in     varchar2 default hr_api.g_varchar2
257   ,p_source_decision_date         in     date     default hr_api.g_date
258   ,p_docket_num                   in     varchar2 default hr_api.g_varchar2
259   ,p_org_notified_of_appeal       in     date     default hr_api.g_date
260   ,p_agency_recvd_req_for_files   in     date     default hr_api.g_date
261   ,p_files_due                    in     date     default hr_api.g_date
262   ,p_files_forwd                  in     date     default hr_api.g_date
263   ,p_agcy_recvd_appellant_brief   in     date     default hr_api.g_date
264   ,p_agency_brief_due             in     date     default hr_api.g_date
265   ,p_appellant_brief_forwd_org    in     date     default hr_api.g_date
266   ,p_org_forwd_brief_to_agency    in     date     default hr_api.g_date
267   ,p_agency_brief_forwd           in     date     default hr_api.g_date
268   ,p_decision_date                in     date     default hr_api.g_date
269   ,p_dec_recvd_by_agency          in     date     default hr_api.g_date
270   ,p_decision                     in     varchar2 default hr_api.g_varchar2
271   ,p_dec_forwd_to_org             in     date     default hr_api.g_date
272   ,p_agency_rfr_suspense          in     date     default hr_api.g_date
273   ,p_request_for_rfr              in     date     default hr_api.g_date
274   ,p_rfr_docket_num               in     varchar2 default hr_api.g_varchar2
275   ,p_rfr_requested_by             in     varchar2 default hr_api.g_varchar2
276   ,p_agency_rfr_due               in     date     default hr_api.g_date
277   ,p_rfr_forwd_to_org             in     date     default hr_api.g_date
278   ,p_org_forwd_rfr_to_agency      in     date     default hr_api.g_date
279   ,p_agency_forwd_rfr_ofo         in     date     default hr_api.g_date
280   ,p_rfr_decision                 in     varchar2 default hr_api.g_varchar2
281   ,p_rfr_decision_date            in     date     default hr_api.g_date
282   ,p_agency_recvd_rfr_dec         in     date     default hr_api.g_date
283   ,p_rfr_decision_forwd_to_org    in     date     default hr_api.g_date
284   );
285 --
286 -- ----------------------------------------------------------------------------
287 -- |------------------------< delete_complainant_appeal >---------------------|
288 -- ----------------------------------------------------------------------------
289 --
290 -- {Start Of Comments}
291 /*#
292  * This API deletes Complaints Tracking Complainant Appeal records.
293  *
294  * This API deletes a child Complainant Appeal record from table
295  * ghr_compl_appeals for an existing parent Complaint.
296  *
297  * <p><b>Licensing</b><br>
298  * This API is licensed for use with Human Resources.
299  *
300  * <p><b>Prerequisites</b><br>
301  * The API deletes the Complainant Appeal record from the database.
302  *
303  * <p><b>Post Success</b><br>
304  * The complainant's appeal record is deleted.
305  *
306  * <p><b>Post Failure</b><br>
307  * The API does not delete the Complainant Appeal record and an error is
308  * raised.
309  * @param p_validate If true, then validation alone will be performed and the
310  * database will remain unchanged. If false and all validation checks pass,
311  * then the database will be modified.
312  * @param p_compl_appeal_id Uniquely identifies the Complaint Appeal record to
313  * be deleted.
314  * @param p_object_version_number Current version number of the Complainant
315  * Appeal to be deleted.
316  * @rep:displayname Delete Complainant Appeal
317  * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
318  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
319  * @rep:scope public
320  * @rep:lifecycle active
321  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
322 */
323 --
324 -- {End Of Comments}
325 --
326 procedure delete_complainant_appeal
327   (p_validate                      in     boolean  default false
328   ,p_compl_appeal_id               in     number
329   ,p_object_version_number         in     number
330   );
331 end ghr_complainant_appeals_api;