4 * This package contains APIs that maintain grade scales.
1 Package hr_grade_scale_api AUTHID CURRENT_USER as
2 /* $Header: pepgsapi.pkh 120.1.12000000.1 2007/01/22 01:19:51 appldev noship $ */
3 /*#
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Grade Scale
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------< get_grade_scale_starting_step >---------------------|
12 -- ----------------------------------------------------------------------------
13 FUNCTION get_grade_scale_starting_step
14 (p_grade_spine_id in NUMBER
15 ,p_effective_date in DATE)
16 RETURN NUMBER;
17
18 -- ----------------------------------------------------------------------------
19 -- |-------------------------< create_grade_scale >---------------------------|
20 -- ----------------------------------------------------------------------------
21 --
22 -- {Start Of Comments}
23 /*#
24 * This API creates a new Grade Scale.
25 *
26 * This API works as follows. a) If the value passed to the optional parameter
27 * p_ceiling_point_id is null, then API creates a Grade Scale with null Ceiling
31 * Scale created.
28 * Step defined. b) If a valid point id is passed to parameter
29 * p_ceiling_point_id, then API creates a Grade Step (Ceiling Step) along with
30 * the Grade Scale. This Ceiling Step will be associated with the new Grade
32 *
33 * <p><b>Licensing</b><br>
34 * This API is licensed for use with Oracle Human Resources.
35 *
36 * <p><b>Prerequisites</b><br>
37 * When creating a grade scale in the schema grade and pay scale should exist.
38 *
39 * <p><b>Post Success</b><br>
40 * A valid grade scale is created.
41 *
42 * <p><b>Post Failure</b><br>
43 * The grade scale will not be created and an error will be raised.
44 *
45 * @param p_validate If true, then validation alone will be performed and the
46 * database will remain unchanged. If false and all validation checks pass,
47 * then the database will be modified.
48 * @param p_effective_date Determines when the DateTrack operation comes into
49 * force.
50 * @param p_business_group_id Determines for which business group the grade
51 * sclae will be created in.
52 * @param p_parent_spine_id Foreign key to PER_PARENT_SPINES
53 * @param p_grade_id Foreign key to PER_GRADES
54 * @param p_ceiling_point_id If a valid point id is passed. Then a grade step
55 * (Ceiling Step) along with the grade scale is created. This ceiling step will
56 * be associated with the new Grade Scale.Foreign key to PER_SPINAL_POINTS
57 * @param p_starting_step This value is used to increment the sequence of the
58 * grade steps and the default value is 1.
59 * @param p_request_id When the API is executed from a concurrent program set
60 * to the concurrent request identifier.
61 * @param p_program_application_id When the API is executed from a concurrent
62 * program set to the program's Application.
63 * @param p_program_id When the API is executed from a concurrent program set
64 * to the program's identifier.
65 * @param p_program_update_date When the API is executed from a concurrent
66 * program set to when the program was ran.
67 * @param p_ceiling_step_id The ceiling step associated with the new Grade
68 * Scale is passed out.
69 * @param p_grade_spine_id If p_validate is false, then this uniquely
70 * identifies the grade scale created. If p_validate is true, then set to null.
71 * @param p_effective_start_date If p_validate is false, then set to the
72 * earliest effective start date for the created grade scale. If p_validate is
73 * true, then set to null.
74 * @param p_effective_end_date If p_validate is false, then set to the
75 * effective end date for the created grade scale. If p_validate is true, then
76 * set to null.
77 * @param p_object_version_number If p_validate is false, then set to the
78 * version number of the created grade scale. If p_validate is true, then the
79 * value will be null.
80 * @rep:displayname Create Grade Scale
81 * @rep:category BUSINESS_ENTITY PER_GRADE
82 * @rep:lifecycle active
83 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
84 * @rep:scope public
85 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
86 */
87 --
88 -- {End Of Comments}
89 --
90 -- ---------------------------------------------------------------------------
91 procedure create_grade_scale
92 (p_validate in boolean default false
93 ,p_effective_date in date
94 ,p_business_group_id in number
95 ,p_parent_spine_id in number
96 ,p_grade_id in number
97 ,p_ceiling_point_id in number default null
98 ,p_starting_step in number default 1
99 ,p_request_id in number default null
100 ,p_program_application_id in number default null
101 ,p_program_id in number default null
102 ,p_program_update_date in date default null
103 ,p_ceiling_step_id out nocopy number
104 ,p_grade_spine_id out nocopy number
105 ,p_effective_start_date out nocopy date
106 ,p_effective_end_date out nocopy date
107 ,p_object_version_number out nocopy number
108 ) ;
109 --
110 -- ----------------------------------------------------------------------------
111 -- |----------------------------< update_grade_scale >-------------------------|
112 -- ----------------------------------------------------------------------------
113 -- {Start Of Comments}
114 /*#
115 * This API updates a Grade Scale.
116 *
117 * This API updates a grade scale as identified by the in parameter
118 * p_grade_spine_id and the in out parameter p_object_version_number.
119 *
120 * <p><b>Licensing</b><br>
121 * This API is licensed for use with Oracle Human Resources.
122 *
123 * <p><b>Prerequisites</b><br>
124 * The grade scale as identified by the in parameter p_grade_spine_id and the
125 * in out parameter p_object_version_number must already exist.
126 *
127 * <p><b>Post Success</b><br>
128 * The grade scale is updated.
129 *
130 * <p><b>Post Failure</b><br>
131 * The API does not update the grade scale and raises an error.
132 *
133 * @param p_validate If true, then validation alone will be performed and the
134 * database will remain unchanged. If false and all validation checks pass,
135 * then the database will be modified.
136 * @param p_effective_date Determines when the DateTrack operation comes into
137 * force.
138 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
139 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
140 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
144 * @param p_object_version_number Pass in the current version number of the
141 * depend on the dates of previous record changes and the effective date of
142 * this change.
143 * @param p_grade_spine_id Identifies the grade scale record to be modify.
145 * grade scale to be updated. When the API completes if p_validate is false,
146 * will be set to the new version number of the updated grade scale. If
147 * p_validate is true will be set to the same value which was passed in.
148 * @param p_business_group_id Business group to which the grade scale belongs.
149 * @param p_parent_spine_id Foreign key to PER_PARENT_SPINES
150 * @param p_grade_id Foreign key to PER_GRADES
151 * @param p_ceiling_step_id Foreign key to PER_SPINAL_POINTS
152 * @param p_starting_step This value is used to increment the sequence of the
153 * grade steps and the default value is 1.
154 * @param p_request_id When the API is executed from a concurrent program set
155 * to the concurrent request identifier.
156 * @param p_program_application_id When the API is executed from a concurrent
157 * program set to the program's Application.
158 * @param p_program_id When the API is executed from a concurrent program set
159 * to the program's identifier.
160 * @param p_program_update_date When the API is executed from a concurrent
161 * program set to when the program was ran.
162 * @param p_effective_start_date If p_validate is false, then set to the
163 * effective start date on the updated grade scale row which now exists as of
164 * the effective date. If p_validate is true, then set to null.
165 * @param p_effective_end_date If p_validate is false, then set to the
166 * effective end date on the updated <ENTITY> row which now exists as of
167 * the effective date. If p_validate is true, then set to null.
168 * @rep:displayname Update Grade Scale
169 * @rep:category BUSINESS_ENTITY PER_GRADE
170 * @rep:lifecycle active
171 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
172 * @rep:scope public
173 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
174 */
175 --
176 -- {End Of Comments}
177 --
178 -- ----------------------------------------------------------------------------
179 procedure update_grade_scale
180 (p_validate in boolean default false
181 ,p_effective_date in date default hr_api.g_date
182 ,p_datetrack_mode in varchar2
183 ,p_grade_spine_id in number
184 ,p_object_version_number in out nocopy number
185 ,p_business_group_id in number default hr_api.g_number
186 ,p_parent_spine_id in number default hr_api.g_number
187 ,p_grade_id in number default hr_api.g_number
188 ,p_ceiling_step_id in number default hr_api.g_number
189 ,p_starting_step in number default hr_api.g_number
190 ,p_request_id in number default hr_api.g_number
191 ,p_program_application_id in number default hr_api.g_number
192 ,p_program_id in number default hr_api.g_number
193 ,p_program_update_date in date default hr_api.g_date
194 ,p_effective_start_date out nocopy date
195 ,p_effective_end_date out nocopy date
196 ) ;
197 -- ----------------------------------------------------------------------------
198 -- |---------------------< delete_grade_scale >-------------------------------|
199 -- ----------------------------------------------------------------------------
200 --
201 -- {Start Of Comments}
202 /*#
203 * This API deletes a Grade Scale.
204 *
205 *
206 * <p><b>Licensing</b><br>
207 * This API is licensed for use with Oracle Human Resources.
208 *
209 * <p><b>Prerequisites</b><br>
210 * The grade scale as identified by the in parameter p_grade_spine_id and the
211 * in out parameter p_object_version_number must already exist.
212 *
213 * <p><b>Post Success</b><br>
214 * The grade scale is deleted.
215 *
216 * <p><b>Post Failure</b><br>
217 * The API does not delete the grade scale and raises an error.
218 *
219 * @param p_validate If true, then validation alone will be performed and the
220 * database will remain unchanged. If false and all validation checks pass,
221 * then the database will be modified.
222 * @param p_effective_date API modifies a database table with DateTrack
223 * features
224 * @param p_datetrack_mode Indicates which DateTrack mode to use when deleting
225 * the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
226 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
227 * on the dates of previous record changes and the effective date of this
228 * change.
229 * @param p_grade_spine_id Identifies the grade scale record to be deleted.
230 * @param p_object_version_number Current version number of the grade scale to
231 * be deleted.
232 * @param p_effective_start_date If p_validate is false, then set to the
233 * effective start date for the deleted <ENTITY> row which now exists as
234 * of the effective date. If p_validate is true or all row instances have been
235 * deleted then set to null.
236 * @param p_effective_end_date If p_validate is false, then set to the
237 * effective end date for the deleted <ENTITY> row which now exists as of
238 * the effective date. If p_validate is true or all row instances have been
239 * deleted then set to null.
240 * @rep:displayname Delete Grade Scale
241 * @rep:category BUSINESS_ENTITY PER_GRADE
242 * @rep:lifecycle active
243 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
244 * @rep:scope public
245 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
246 */
247 --
248 -- {End Of Comments}
249 --
250
251 procedure delete_grade_scale
252 (p_validate in boolean
253 ,p_effective_date in date
254 ,p_datetrack_mode in varchar2
255 ,p_grade_spine_id in number
256 ,p_object_version_number in out nocopy number
257 ,p_effective_start_date out nocopy date
258 ,p_effective_end_date out nocopy date
259 );
260
261 --
262 end hr_grade_scale_api;
263 --
[Home] [Help]