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