1 Package ghr_complaint_incidents_api AUTHID CURRENT_USER as
2 /* $Header: ghcinapi.pkh 120.1 2005/10/02 01:57:31 aroussel $ */
3 /*#
4 * This package contains the procedures for creating, updating and deleting GHR
5 * Complaints Tracking Complaint Incident records.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Complaint Incident
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |--------------------------< create_compl_incident >-----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a Complaint Tracking Complaint Incident record.
18 *
19 * This API creates a child Incident record in table ghr_compl_incidents for an
20 * existing parent Claim.
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 Claim record must exist in ghr_compl_claims.
27 *
28 * <p><b>Post Success</b><br>
29 * The API creates the Incident record in the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The API does not Create the Incident record 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_compl_claim_id Uniquely identifies the Parent Claim record.
40 * @param p_incident_date {@rep:casecolumn GHR_COMPL_INCIDENTS.INCIDENT_DATE}
41 * @param p_description {@rep:casecolumn GHR_COMPL_INCIDENTS.DESCRIPTION}
42 * @param p_date_amended {@rep:casecolumn GHR_COMPL_INCIDENTS.DATE_AMENDED}
43 * @param p_date_acknowledged {@rep:casecolumn
44 * GHR_COMPL_INCIDENTS.DATE_ACKNOWLEDGED}
45 * @param p_compl_incident_id If p_validate is false, then this uniquely
46 * identifies the Incident created. If p_validate is true, then set to null.
47 * @param p_object_version_number If p_validate is false, then set to the
48 * version number of the created Incident. If p_validate is true, then the
49 * value will be null.
50 * @rep:displayname Create Complaint Incident
51 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
52 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
53 * @rep:scope public
54 * @rep:lifecycle active
55 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
56 */
57 --
58 -- {End Of Comments}
59 --
60 procedure create_compl_incident
61 (p_validate in boolean default false
62 ,p_effective_date in date
63 ,p_compl_claim_id in number
64 ,p_incident_date in date default null
65 ,p_description in varchar2 default null
66 ,p_date_amended in date default null
67 ,p_date_acknowledged in date default null
68 ,p_compl_incident_id out nocopy number
69 ,p_object_version_number out nocopy number
70 );
71 --
72 -- ----------------------------------------------------------------------------
73 -- |--------------------------< update_compl_incident >-----------------------|
74 -- ----------------------------------------------------------------------------
75 --
76 -- {Start Of Comments}
77 /*#
78 * This API updates a Complaint Tracking Complaint Incident record.
79 *
80 * This API updates a child Incident record in table ghr_compl_incidents for an
81 * existing parent Claim.
82 *
83 * <p><b>Licensing</b><br>
84 * This API is licensed for use with Human Resources.
85 *
86 * <p><b>Prerequisites</b><br>
87 * A parent Claim record must exist in ghr_compl_claims.
88 *
89 * <p><b>Post Success</b><br>
90 * The API updates the Incident record in the database.
91 *
92 * <p><b>Post Failure</b><br>
93 * The API does not update the Incident record and an error is raised.
94 * @param p_validate If true, then validation alone will be performed and the
95 * database will remain unchanged. If false and all validation checks pass,
96 * then the database will be modified.
97 * @param p_effective_date Reference date for validating lookup values are
98 * applicable during the start to end active date range. This date does not
99 * determine when the changes take effect.
100 * @param p_compl_incident_id Uniquely identifies the Incident record being
101 * updated.
102 * @param p_compl_claim_id Uniquely identifies the Parent Claim record.
103 * @param p_incident_date {@rep:casecolumn GHR_COMPL_INCIDENTS.INCIDENT_DATE}
104 * @param p_description {@rep:casecolumn GHR_COMPL_INCIDENTS.DESCRIPTION}
105 * @param p_date_amended {@rep:casecolumn GHR_COMPL_INCIDENTS.DATE_AMENDED}
106 * @param p_date_acknowledged {@rep:casecolumn
107 * GHR_COMPL_INCIDENTS.DATE_ACKNOWLEDGED}
108 * @param p_object_version_number Pass in the current version number of the
109 * Incident to be updated. When the API completes if p_validate is false, will
110 * be set to the new version number of the updated Incident. If p_validate is
111 * true will be set to the same value which was passed in.
112 * @rep:displayname Update Complaint Incident
113 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
114 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
115 * @rep:scope public
116 * @rep:lifecycle active
117 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
118 */
119 --
120 -- {End Of Comments}
121 --
122 procedure update_compl_incident
123 (p_validate in boolean default false
124 ,p_effective_date in date
125 ,p_compl_incident_id in number
126 ,p_compl_claim_id in number default hr_api.g_number
127 ,p_incident_date in date default hr_api.g_date
128 ,p_description in varchar2 default hr_api.g_varchar2
129 ,p_date_amended in date default hr_api.g_date
130 ,p_date_acknowledged in date default hr_api.g_date
131 ,p_object_version_number in out nocopy number
132 );
133 --
134 -- ----------------------------------------------------------------------------
135 -- |--------------------------< delete_compl_incident >-----------------------|
136 -- ----------------------------------------------------------------------------
137 --
138 -- {Start Of Comments}
139 /*#
140 * This API deletes a Complaint Tracking Complaint Incident record.
141 *
142 * This API deletes a child Incident record in table ghr_compl_incidents for an
143 * existing parent Claim.
144 *
145 * <p><b>Licensing</b><br>
146 * This API is licensed for use with Human Resources.
147 *
148 * <p><b>Prerequisites</b><br>
149 * The Incident record specified must exist.
150 *
151 * <p><b>Post Success</b><br>
152 * The API deletes the Incident record from the database.
153 *
154 * <p><b>Post Failure</b><br>
155 * The API does not delete the Incident record and an error is raised.
156 * @param p_validate If true, then validation alone will be performed and the
157 * database will remain unchanged. If false and all validation checks pass,
158 * then the database will be modified.
159 * @param p_compl_incident_id Uniquely identifies the Incident record being
160 * deleted.
161 * @param p_object_version_number Current version number of the Incident to be
162 * deleted.
163 * @rep:displayname Delete Complaint Incident
164 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
165 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
166 * @rep:scope public
167 * @rep:lifecycle active
168 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
169 */
170 --
171 -- {End Of Comments}
172 --
173 procedure delete_compl_incident
174 (p_validate in boolean default false
175 ,p_compl_incident_id in number
176 ,p_object_version_number in number
177 );
178 --
179 end ghr_complaint_incidents_api;
[Home] [Help]