1 Package ghr_complaint_adrs_api as
2 /* $Header: ghcadapi.pkh 120.1 2005/10/02 01:57:04 aroussel $ */
3 /*#
4 * This package contains the procedures for creating, updating, and deleting
5 * GHR Complaints Tracking Alternate Dispute Resolution (ADR) records.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Complaint Tracking Alternate Dispute Resolution
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------------< create_compl_adr >-------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a Complaints Tracking Alternate Dispute Resolution record.
18 *
19 * This API creates a child Alternate Dispute Resolution record in table
20 * ghr_compl_adrs 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 an Alternate Dispute Resolution record in the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The API does not create the Alternate Dispute Resolution record and an error
33 * is 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_stage Alternate Dispute Resolution Stage. Valid values are defined
42 * by 'GHR_US_STAGE' lookup type.
43 * @param p_start_date {@rep:casecolumn GHR_COMPL_ADRS.START_DATE}
44 * @param p_end_date {@rep:casecolumn GHR_COMPL_ADRS.END_DATE}
45 * @param p_adr_resource Alternate Dispute Resolution Resource. Valid values
46 * are defined by 'GHR_US_ADR_RESOURCE' lookup type.
47 * @param p_technique Alternate Dispute Resolution Technique. Valid values are
48 * defined by 'GHR_US_ADR_TECHNIQUE' lookup type.
49 * @param p_outcome Alternate Dispute Resolution Outcome. Valid values are
50 * defined by 'GHR_US_ADR_OUTCOME' lookup type.
51 * @param p_adr_offered Alternate Dispute Resolution Offered to Complainant.
52 * Valid values are defined by 'GHR_US_ADR_OFFERED' lookup type.
53 * @param p_date_accepted {@rep:casecolumn GHR_COMPL_ADRS.DATE_ACCEPTED}
54 * @param p_compl_adr_id If p_validate is false, then this uniquely identifies
55 * the Alternate Dispute Resolution created. If p_validate is true, then set to
56 * null.
57 * @param p_object_version_number If p_validate is false, then set to the
58 * version number of the created Alternate Dispute Resolution. If p_validate is
59 * true, then the value will be null.
60 * @rep:displayname Create Alternate Dispute Resolution
61 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
62 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
63 * @rep:scope public
64 * @rep:lifecycle active
65 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
66 */
67 --
68 -- {End Of Comments}
69 --
70 procedure create_compl_adr
71 (p_validate in boolean default false
72 ,p_effective_date in date
73 ,p_complaint_id in number
74 ,p_stage in varchar2 default null
75 ,p_start_date in date default null
76 ,p_end_date in date default null
77 ,p_adr_resource in varchar2 default null
78 ,p_technique in varchar2 default null
79 ,p_outcome in varchar2 default null
80 ,p_adr_offered in varchar2 default null
81 ,p_date_accepted in date default null
82 ,p_compl_adr_id out nocopy number
83 ,p_object_version_number out nocopy number
84 );
85 --
86 -- ----------------------------------------------------------------------------
87 -- |-----------------------------< update_compl_adr >-------------------------|
88 -- ----------------------------------------------------------------------------
89 --
90 -- {Start Of Comments}
91 /*#
92 * This API updates a Complaints Tracking Alternate Dispute Resolution record.
93 *
94 * This API updates a child Alternate Dispute Resolution record in table
95 * ghr_compl_adrs for an existing parent Complaint.
96 *
97 * <p><b>Licensing</b><br>
98 * This API is licensed for use with Human Resources.
99 *
100 * <p><b>Prerequisites</b><br>
101 * A parent Complaint record must exist in ghr_complaints2.
102 *
103 * <p><b>Post Success</b><br>
104 * The API Updates an Alternate Dispute Resolution record in the database.
105 *
106 * <p><b>Post Failure</b><br>
107 * The API does not update the Alternate Dispute Resolution record and an error
108 * is raised.
109 * @param p_validate If true, then validation alone will be performed and the
110 * database will remain unchanged. If false and all validation checks pass,
111 * then the database will be modified.
112 * @param p_effective_date Reference date for validating lookup values are
113 * applicable during the start to end active date range. This date does not
114 * determine when the changes take effect.
115 * @param p_compl_adr_id Uniquely identifies the Alternate Dispute Resolution
116 * record to be updated.
117 * @param p_complaint_id Uniquely identifies the Parent Complaint record.
118 * @param p_stage Alternate Dispute Resolution Stage. Valid values are defined
119 * by 'GHR_US_STAGE' lookup type.
120 * @param p_start_date {@rep:casecolumn GHR_COMPL_ADRS.START_DATE}
121 * @param p_end_date {@rep:casecolumn GHR_COMPL_ADRS.END_DATE}
122 * @param p_adr_resource Alternate Dispute Resolution Resource. Valid values
123 * are defined by 'GHR_US_ADR_RESOURCE' lookup type.
124 * @param p_technique Alternate Dispute Resolution Technique. Valid values are
125 * defined by 'GHR_US_ADR_TECHNIQUE' lookup type.
126 * @param p_outcome Alternate Dispute Resolution Outcome. Valid values are
127 * defined by 'GHR_US_ADR_OUTCOME' lookup type.
128 * @param p_adr_offered Alternate Dispute Resolution Offered to Complainant.
129 * Valid values are defined by 'GHR_US_ADR_OFFERED' lookup type.
130 * @param p_date_accepted {@rep:casecolumn GHR_COMPL_ADRS.DATE_ACCEPTED}
131 * @param p_object_version_number Pass in the current version number of the
132 * Alternate Dispute Resolution to be updated. When the API completes if
133 * p_validate is false, will be set to the new version number of the updated
134 * Alternate Dispute Resolution. If p_validate is true will be set to the same
135 * value which was passed in.
136 * @rep:displayname Update Alternate Dispute Resolution
137 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
138 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
139 * @rep:scope public
140 * @rep:lifecycle active
141 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
142 */
143 --
144 -- {End Of Comments}
145 --
146 procedure update_compl_adr
147 (p_validate in boolean default false
148 ,p_effective_date in date
149 ,p_compl_adr_id in number
150 ,p_complaint_id in number default hr_api.g_number
151 ,p_stage in varchar2 default hr_api.g_varchar2
152 ,p_start_date in date default hr_api.g_date
153 ,p_end_date in date default hr_api.g_date
154 ,p_adr_resource in varchar2 default hr_api.g_varchar2
155 ,p_technique in varchar2 default hr_api.g_varchar2
156 ,p_outcome in varchar2 default hr_api.g_varchar2
157 ,p_adr_offered in varchar2 default hr_api.g_varchar2
158 ,p_date_accepted in date default hr_api.g_date
159 ,p_object_version_number in out nocopy number
160 );
161 --
162 -- ----------------------------------------------------------------------------
163 -- |-----------------------------< delete_compl_adr >-------------------------|
164 -- ----------------------------------------------------------------------------
165 --
166 -- {Start Of Comments}
167 /*#
168 * This API deletes a Complaints Tracking Alternate Dispute Resolution record.
169 *
170 * This API deletes a child Alternate Dispute Resolution record from table
171 * ghr_compl_adrs for an existing parent Complaint.
172 *
173 * <p><b>Licensing</b><br>
174 * This API is licensed for use with Human Resources.
175 *
176 * <p><b>Prerequisites</b><br>
177 * The Alternate Dispute Resolution record specified must exist.
178 *
179 * <p><b>Post Success</b><br>
180 * The API deletes the Alternate Dispute Resolution record from the database.
181 *
182 * <p><b>Post Failure</b><br>
183 * The API does not delete the Alternate Dispute Resolution record and an error
184 * is raised.
185 * @param p_validate If true, then validation alone will be performed and the
186 * database will remain unchanged. If false and all validation checks pass,
187 * then the database will be modified.
188 * @param p_compl_adr_id Uniquely identifies the Alternate Dispute Resolution
189 * record to be deleted.
190 * @param p_object_version_number Current version number of the Alternate
191 * Dispute Resolution to be deleted.
192 * @rep:displayname Delete Alternate Dispute Resolution
193 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
194 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
195 * @rep:scope public
196 * @rep:lifecycle active
197 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
198 */
199 --
200 -- {End Of Comments}
201 --
202 procedure delete_compl_adr
203 (p_validate in boolean default false
204 ,p_compl_adr_id in number
205 ,p_object_version_number in number
206 );
207
208 end ghr_complaint_adrs_api;
[Home] [Help]