1 Package ghr_complaints_ca_details_api as
2 /* $Header: ghcdtapi.pkh 120.1 2005/10/02 01:57:27 aroussel $ */
3 /*#
4 * This package contains the procedures for creating, updating, and deleting
5 * GHR Complaint Tracking Corrective Action Detail records.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Complaint Corrective Action Detail
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------------< create_ca_detail >-------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a Complaint Tracking Corrective Action Detail record.
18 *
19 * This API creates a child Corrective Action Detail record in table
20 * ghr_compl_ca_details for an existing parent Corrective Action Header.
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 Corrective Action Header record must exist in
27 * ghr_compl_headers.
28 *
29 * <p><b>Post Success</b><br>
30 * The API creates the Corrective Action Detail record in the database.
31 *
32 * <p><b>Post Failure</b><br>
33 * The API does not create the Corrective Action Detail record and an error is
34 * raised.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Reference date for validating lookup values are
39 * applicable during the start to end active date range. This date does not
40 * determine when the changes take effect.
41 * @param p_compl_ca_header_id Uniquely identifies the Parent Complaint
42 * Corrective Action Header record.
43 * @param p_amount {@rep:casecolumn GHR_COMPL_CA_DETAILS.AMOUNT}
44 * @param p_order_date {@rep:casecolumn GHR_COMPL_CA_DETAILS.ORDER_DATE}
45 * @param p_due_date {@rep:casecolumn GHR_COMPL_CA_DETAILS.DUE_DATE}
46 * @param p_request_date {@rep:casecolumn GHR_COMPL_CA_DETAILS.REQUEST_DATE}
47 * @param p_complete_date {@rep:casecolumn GHR_COMPL_CA_DETAILS.COMPLETE_DATE}
48 * @param p_category Complaint Corrective Action Detail Category. Valid values
49 * are defined by 'GHR_US_CA_CATEGORIES' lookup type.
50 * @param p_phase Complaint Corrective Action Detail Phase. Valid values are
51 * defined by 'GHR_US_CA_PHASES' lookup type.
52 * @param p_action_type Complaint Corrective Action Detail Type. Valid values
53 * are defined by 'GHR_US_CA_ACTION_TYPE' lookup type.
54 * @param p_payment_type Complaint Corrective Action Detail Payment Type. Valid
55 * values are defined by 'GHR_US_CA_PAYMENT_TYPE' lookup type.
56 * @param p_description {@rep:casecolumn GHR_COMPL_CA_DETAILS.DESCRIPTION}
57 * @param p_compl_ca_detail_id If p_validate is false, then this uniquely
58 * identifies the Corrective Action Detail created. If p_validate is true, then
59 * set to null.
60 * @param p_object_version_number If p_validate is false, then set to the
61 * version number of the created Corrective Action Detail. If p_validate is
62 * true, then the value will be null.
63 * @rep:displayname Create Corrective Action Detail
64 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
65 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
66 * @rep:scope public
67 * @rep:lifecycle active
68 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
69 */
70 --
71 -- {End Of Comments}
72 --
73 procedure create_ca_detail
74 (p_validate in boolean default false
75 ,p_effective_date in date
76 ,p_compl_ca_header_id in number default null
77 --,p_action in varchar2 default null
78 ,p_amount in number default null
79 ,p_order_date in date default null
80 ,p_due_date in date default null
81 ,p_request_date in date default null
82 ,p_complete_date in date default null
83 ,p_category in varchar2 default null
84 --,p_type in varchar2 default null
85 ,p_phase in varchar2 default null
86 ,p_action_type in varchar2 default null
87 ,p_payment_type in varchar2 default null
88 ,p_description in varchar2 default null
89 ,p_compl_ca_detail_id out nocopy number
90 ,p_object_version_number out nocopy number
91 );
92 --
93 -- ----------------------------------------------------------------------------
94 -- |-----------------------------< update_ca_detail >-------------------------|
95 -- ----------------------------------------------------------------------------
96 --
97 -- {Start Of Comments}
98 /*#
99 * This API updates the Complaint Tracking Corrective Action Detail records.
100 *
101 * This API updates a child Corrective Action Detail record in table
102 * ghr_compl_ca_details for an existing parent Corrective Action Header.
103 *
104 * <p><b>Licensing</b><br>
105 * This API is licensed for use with Human Resources.
106 *
107 * <p><b>Prerequisites</b><br>
108 * A parent Complaint Header record must exist in ghr_compl_headers.
109 *
110 * <p><b>Post Success</b><br>
111 * The API updates the Corrective Action Detail record in the database.
112 *
113 * <p><b>Post Failure</b><br>
114 * The API does not update the Corrective Action Detail record and an error is
115 * raised.
116 * @param p_validate If true, then validation alone will be performed and the
117 * database will remain unchanged. If false and all validation checks pass,
118 * then the database will be modified.
119 * @param p_effective_date Reference date for validating lookup values are
120 * applicable during the start to end active date range. This date does not
121 * determine when the changes take effect.
122 * @param p_compl_ca_detail_id Uniquely identifies the Complaint Detail record
123 * to be updated.
124 * @param p_object_version_number Pass in the current version number of the
125 * Corrective Action Detail to be updated. When the API completes if p_validate
126 * is false, will be set to the new version number of the updated Corrective
127 * Action Detail. If p_validate is true will be set to the same value which was
128 * passed in.
129 * @param p_compl_ca_header_id Uniquely identifies the Parent Complaint Header
130 * record.
131 * @param p_amount {@rep:casecolumn GHR_COMPL_CA_DETAILS.AMOUNT}
132 * @param p_order_date {@rep:casecolumn GHR_COMPL_CA_DETAILS.ORDER_DATE}
133 * @param p_due_date {@rep:casecolumn GHR_COMPL_CA_DETAILS.DUE_DATE}
134 * @param p_request_date {@rep:casecolumn GHR_COMPL_CA_DETAILS.REQUEST_DATE}
135 * @param p_complete_date {@rep:casecolumn GHR_COMPL_CA_DETAILS.COMPLETE_DATE}
136 * @param p_category Complaint Corrective Action Detail Category. Valid values
137 * are defined by 'GHR_US_CA_CATEGORIES' lookup type.
138 * @param p_phase Complaint Corrective Action Detail Phase. Valid values are
139 * defined by 'GHR_US_CA_PHASES' lookup type.
140 * @param p_action_type Complaint Corrective Action Detail Action Type. Valid
141 * values are defined by 'GHR_US_CA_ACTION_TYPE' lookup type.
142 * @param p_payment_type Complaint Corrective Action Detail Payment Type. Valid
143 * values are defined by 'GHR_US_CA_PAYMENT_TYPE' lookup type.
144 * @param p_description {@rep:casecolumn GHR_COMPL_CA_DETAILS.DESCRIPTION}
145 * @rep:displayname Update Corrective Action Detail
146 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
147 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
148 * @rep:scope public
149 * @rep:lifecycle active
150 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
151 */
152 --
153 -- {End Of Comments}
154 --
155 procedure update_ca_detail
156 (p_validate in boolean default false
157 ,p_effective_date in date
158 ,p_compl_ca_detail_id in number
159 ,p_object_version_number in out nocopy number
160 ,p_compl_ca_header_id in number default hr_api.g_number
161 --,p_action in varchar2 default hr_api.g_varchar2
162 ,p_amount in number default hr_api.g_number
163 ,p_order_date in date default hr_api.g_date
164 ,p_due_date in date default hr_api.g_date
165 ,p_request_date in date default hr_api.g_date
166 ,p_complete_date in date default hr_api.g_date
167 ,p_category in varchar2 default hr_api.g_varchar2
168 --,p_type in varchar2 default hr_api.g_varchar2
169 ,p_phase in varchar2 default hr_api.g_varchar2
170 ,p_action_type in varchar2 default hr_api.g_varchar2
171 ,p_payment_type in varchar2 default hr_api.g_varchar2
172 ,p_description in varchar2 default hr_api.g_varchar2
173 );
174 --
175 -- ----------------------------------------------------------------------------
176 -- |-----------------------------< delete_ca_detail >-------------------------|
177 -- ----------------------------------------------------------------------------
178 --
179 -- {Start Of Comments}
180 /*#
181 * This API deletes the Complaint Tracking Corrective Action Detail records.
182 *
183 * This API deletes a child Corrective Action Detail record from table
184 * ghr_compl_ca_details for an existing parent Corrective Action Header.
185 *
186 * <p><b>Licensing</b><br>
187 * This API is licensed for use with Human Resources.
188 *
189 * <p><b>Prerequisites</b><br>
190 * The Corrective Action Detail record specified must exist.
191 *
192 * <p><b>Post Success</b><br>
193 * The API deletes the Corrective Action Detail record from the database.
194 *
195 * <p><b>Post Failure</b><br>
196 * The API does not delete the Corrective Action Detail record and an error is
197 * raised.
198 * @param p_validate If true, then validation alone will be performed and the
199 * database will remain unchanged. If false and all validation checks pass,
200 * then the database will be modified.
201 * @param p_compl_ca_detail_id Uniquely identifies the Complaint Corrective
202 * Action Detail record to be deleted.
203 * @param p_object_version_number Current version number of the Corrective
204 * Action Detail to be deleted.
205 * @rep:displayname Delete Corrective Action Detail
206 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
207 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
208 * @rep:scope public
209 * @rep:lifecycle active
210 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
211 */
212 --
213 -- {End Of Comments}
214 --
215 procedure delete_ca_detail
216 (p_validate in boolean default false
217 ,p_compl_ca_detail_id in number
218 ,p_object_version_number in number
219 );
220
221 end ghr_complaints_ca_details_api;
[Home] [Help]