1 Package hr_valid_grade_api as
2 /* $Header: pevgrapi.pkh 120.1 2005/10/02 02:24:59 aroussel $ */
3 /*#
4 * This package contains APIs that create and maintain valid grades.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Valid Grade
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_valid_grade >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new valid grade for a given job or position.
17 *
18 * A component of an employee assignment that defines their level and can be
19 * used to control the value of their salary and other compensation elements.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with HR Foundation.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The grade, identified by p_grade_id, must exist as of date_from and must not
26 * end before date_to. Either the job_id or position_id must be passed into the
27 * API. Both values cannot be provided for the same valid grade. When the
28 * job_id is specified it must exist as of date_from, must not end before
29 * date_to and must be in the same business group as the grade. When the
30 * position_id is specified it must exist as of date_from, must not end before
31 * date_to, and must be in the same business group as the grade. The
32 * combination of grade, job and position must not already exist as a valid
33 * grade.
34 *
35 * <p><b>Post Success</b><br>
36 * Valid grade record is created for the job or position.
37 *
38 * <p><b>Post Failure</b><br>
39 * The API does not create the valid grade and raises an error.
40 * @param p_validate If true, then validation alone will be performed and the
41 * database will remain unchanged. If false and all validation checks pass,
42 * then the database will be modified.
43 * @param p_grade_id Uniquely identifies the grade.
44 * @param p_date_from The date on which the valid grade takes effect
45 * @param p_effective_date Reference date for validating lookup values are
46 * applicable during the start to end active date range. This date does not
47 * determine when the changes take effect.
48 * @param p_comments Comment Text
49 * @param p_date_to The date on which the valid grade is no longer in effect.
50 * @param p_job_id Uniquely identifies the job.
51 * @param p_position_id Uniquely identifies the position.
52 * @param p_attribute_category This context value determines which flexfield
53 * structure to use with the descriptive flexfield segments.
54 * @param p_attribute1 Descriptive flexfield segment.
55 * @param p_attribute2 Descriptive flexfield segment.
56 * @param p_attribute3 Descriptive flexfield segment.
57 * @param p_attribute4 Descriptive flexfield segment.
58 * @param p_attribute5 Descriptive flexfield segment.
59 * @param p_attribute6 Descriptive flexfield segment.
60 * @param p_attribute7 Descriptive flexfield segment.
61 * @param p_attribute8 Descriptive flexfield segment.
62 * @param p_attribute9 Descriptive flexfield segment.
63 * @param p_attribute10 Descriptive flexfield segment.
64 * @param p_attribute11 Descriptive flexfield segment.
65 * @param p_attribute12 Descriptive flexfield segment.
66 * @param p_attribute13 Descriptive flexfield segment.
67 * @param p_attribute14 Descriptive flexfield segment.
68 * @param p_attribute15 Descriptive flexfield segment.
69 * @param p_attribute16 Descriptive flexfield segment.
70 * @param p_attribute17 Descriptive flexfield segment.
71 * @param p_attribute18 Descriptive flexfield segment.
72 * @param p_attribute19 Descriptive flexfield segment.
73 * @param p_attribute20 Descriptive flexfield segment.
74 * @param p_valid_grade_id If p_validate is false, uniquely identifies the
75 * valid grade created. If p_validate is true, set to null.
76 * @param p_object_version_number If p_validate is false, then set to the
77 * version number of the created Valid Grade. If p_validate is true, then the
78 * value will be null.
79 * @rep:displayname Create Valid Grade
80 * @rep:category BUSINESS_ENTITY PER_JOB
81 * @rep:category BUSINESS_ENTITY PER_POSITION
82 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
83 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
84 * @rep:scope public
85 * @rep:lifecycle active
86 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
87 */
88 --
89 -- {End Of Comments}
90 --
91 procedure create_valid_grade
92 (p_validate in boolean default false
93 ,p_grade_id in number
94 ,p_date_from in date
95 ,p_effective_date in date --Added for bug# 1760707
96 ,p_comments in varchar2 default null
97 ,p_date_to in date default null
98 ,p_job_id in number default null
99 ,p_position_id in number default null
100 ,p_attribute_category in varchar2 default null
101 ,p_attribute1 in varchar2 default null
102 ,p_attribute2 in varchar2 default null
103 ,p_attribute3 in varchar2 default null
104 ,p_attribute4 in varchar2 default null
105 ,p_attribute5 in varchar2 default null
106 ,p_attribute6 in varchar2 default null
107 ,p_attribute7 in varchar2 default null
108 ,p_attribute8 in varchar2 default null
109 ,p_attribute9 in varchar2 default null
110 ,p_attribute10 in varchar2 default null
111 ,p_attribute11 in varchar2 default null
112 ,p_attribute12 in varchar2 default null
113 ,p_attribute13 in varchar2 default null
114 ,p_attribute14 in varchar2 default null
115 ,p_attribute15 in varchar2 default null
116 ,p_attribute16 in varchar2 default null
117 ,p_attribute17 in varchar2 default null
118 ,p_attribute18 in varchar2 default null
119 ,p_attribute19 in varchar2 default null
120 ,p_attribute20 in varchar2 default null
121 ,p_valid_grade_id out nocopy number
122 ,p_object_version_number out nocopy number
123 );
124 --
125 --
126 end hr_valid_grade_api;
127 --
[Home] [Help]