1 PACKAGE per_pos_structure_version_api AS
2 /* $Header: pepsvapi.pkh 120.2 2005/10/22 01:25:03 aroussel noship $ */
3 /*#
4 * This package contains APIs that create and maintain Position Hierarchy
5 * Versions.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Position Hierarchy Version
9 */
10 g_package VARCHAR2(33) := ' per_pos_structure_version_api.';
11 --
12 --------------------------------------------------------------------------------
13 g_dummy number(1); -- Dummy for cursor returns which are not needed
14 g_business_group_id number(15); -- For validating translation;
15 g_legislation_code varchar2(150); -- For validating translation;
16 --------------------------------------------------------------------------------
17 --
18 -- ----------------------------------------------------------------------------
19 -- |-----------------------< create_pos_structure_version >-------------------|
20 -- ----------------------------------------------------------------------------
21 --
22 -- {Start Of Comments}
23 /*#
24 * This API creates a position hierarchy version.
25 *
26 * It creates an position hierarchy version for a given position hierarchy. The
27 * process initializes the version number to 1.
28 *
29 * <p><b>Licensing</b><br>
30 * This API is licensed for use with Human Resources.
31 *
32 * <p><b>Prerequisites</b><br>
33 * Position hierarchy should exist.
34 *
35 * <p><b>Post Success</b><br>
36 * A version of position hierarchy will be created.
37 *
38 * <p><b>Post Failure</b><br>
39 * Position hierarchy version will not get created and error will be returned.
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_effective_date Reference date for validating lookup values are
44 * applicable during the start to end active date range. This date does not
45 * determine when the changes take effect.
46 * @param p_position_structure_id Uniquely identifies the position hierarchy
47 * for which the process creates a version.
48 * @param p_date_from The date on which this position hierarchy version takes
49 * effect.
50 * @param p_version_number The version number of the position hierarchy.
51 * @param p_copy_structure_version_id Uniquely identifies a previously existing
52 * position hierarchy version (if any) the process copies as the basis for the
53 * created version.
54 * @param p_date_to The date the created version of the position hierarchy is
55 * no longer in effect.
56 * @param p_request_id When the API is executed from a concurrent program set
57 * to the concurrent request identifier.
58 * @param p_program_application_id When the API is executed from a concurrent
59 * program set to the program's Application.
60 * @param p_program_id When the API is executed from a concurrent program set
61 * to the program's identifier.
62 * @param p_program_update_date When the API is executed from a concurrent
63 * program set to when the program was ran.
64 * @param p_pos_structure_version_id If p_validate is false, then this uniquely
65 * identifies the created position hierarchy version. If p_validate is true,
66 * then set to null.
67 * @param p_object_version_number If p_validate is false, then set to the
68 * version number of the created Position Hierarchy Version. If p_validate is
69 * true, then the value will be null.
70 * @param p_gap_warning The process sets to 'true' if there is a gap between
71 * the effective date ranges of position hierarchy versions.
72 * @rep:displayname Create Position Hierarchy Version
73 * @rep:category BUSINESS_ENTITY PER_POSITION_HIERARCHY
74 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
75 * @rep:scope public
76 * @rep:lifecycle active
77 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
78 */
79 --
80 -- {End Of Comments}
81 --
82 PROCEDURE create_pos_structure_version
83 (p_validate in boolean default false
84 ,p_effective_date in date
85 ,p_position_structure_id in number
86 ,p_date_from in date
87 ,p_version_number in number
88 ,p_copy_structure_version_id in number default null
89 ,p_date_to in date default null
90 ,p_request_id in number default null
91 ,p_program_application_id in number default null
92 ,p_program_id in number default null
93 ,p_program_update_date in date default null
94 ,p_pos_structure_version_id out nocopy number
95 ,p_object_version_number out nocopy number
96 ,p_gap_warning out nocopy boolean
97 );
98 --
99 -- ----------------------------------------------------------------------------
100 -- |-----------------------< update_pos_structure_version >-------------------|
101 -- ----------------------------------------------------------------------------
102 --
103 -- {Start Of Comments}
104 /*#
105 * This API updates a position hierarchy version.
106 *
107 * This procedure will update the position hierarchy version for a given
108 * position hierarchy. The system generates a version number for each new row,
109 * which Increments by one with each update.
110 *
111 * <p><b>Licensing</b><br>
112 * This API is licensed for use with Human Resources.
113 *
114 * <p><b>Prerequisites</b><br>
115 * Position hierarchy version should exist.
116 *
117 * <p><b>Post Success</b><br>
118 * Position hierarchy version gets updated.
119 *
120 * <p><b>Post Failure</b><br>
121 * Position hierarchy version is not updated and error returned.
122 * @param p_validate If true, then validation alone will be performed and the
123 * database will remain unchanged. If false and all validation checks pass,
124 * then the database will be modified.
125 * @param p_effective_date Reference date for validating lookup values are
126 * applicable during the start to end active date range. This date does not
127 * determine when the changes take effect.
128 * @param p_date_from The date this version of the position hierarchy takes
129 * effect.
130 * @param p_version_number The version number of the position hierarchy
131 * @param p_copy_structure_version_id Uniquely identifies a previously existing
132 * position hierarchy version (if any) the process copies as the basis for the
133 * created version.
134 * @param p_date_to The date this version of the position hierarchy is no
135 * longer in effect.
136 * @param p_request_id When the API is executed from a concurrent program set
137 * to the concurrent request identifier.
138 * @param p_program_application_id When the API is executed from a concurrent
139 * program set to the program's Application.
140 * @param p_program_id When the API is executed from a concurrent program set
141 * to the program's identifier.
142 * @param p_program_update_date When the API is executed from a concurrent
143 * program set to when the program was ran.
144 * @param p_pos_structure_version_id Identifies the Position hierarchy version
145 * record to modify.
146 * @param p_object_version_number Pass in the current version number of the
147 * Position Hierarchy Version to be updated. When the API completes if
148 * p_validate is false, will be set to the new version number of the updated
149 * Position Hierarchy Version. If p_validate is true will be set to the same
150 * value which was passed in.
151 * @param p_gap_warning The process sets to 'true' if there is a gap between
152 * the effective date ranges of position hierarchy versions.
153 * @rep:displayname Update Position Hierarchy Version
154 * @rep:category BUSINESS_ENTITY PER_POSITION_HIERARCHY
155 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
156 * @rep:scope public
157 * @rep:lifecycle active
158 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
159 */
160 --
161 -- {End Of Comments}
162 --
163 PROCEDURE update_pos_structure_version
164 (p_validate in boolean default false
165 ,p_effective_date in date
166 ,p_date_from in date
167 ,p_version_number in number
168 ,p_copy_structure_version_id in number default hr_api.g_number
169 ,p_date_to in date default hr_api.g_date
170 ,p_request_id in number default hr_api.g_number
171 ,p_program_application_id in number default hr_api.g_number
172 ,p_program_id in number default hr_api.g_number
173 ,p_program_update_date in date default hr_api.g_date
174 ,p_pos_structure_version_id in number
175 ,p_object_version_number in out nocopy number
176 ,p_gap_warning out nocopy boolean);
177 --
178 -- ----------------------------------------------------------------------------
179 -- |-----------------------< delete_pos_structure_version >-------------------|
180 -- ----------------------------------------------------------------------------
181 --
182 -- {Start Of Comments}
183 /*#
184 * This API deletes a position hierarchy version.
185 *
186 * This procedure deletes an position hierarchy version for a given position
187 * hierarchy.
188 *
189 * <p><b>Licensing</b><br>
190 * This API is licensed for use with Human Resources.
191 *
192 * <p><b>Prerequisites</b><br>
193 * Position Hierarchy Version should exist.
194 *
198 * <p><b>Post Failure</b><br>
195 * <p><b>Post Success</b><br>
196 * Position Hierarchy Version deleted.
197 *
199 * Position Hierarchy Version not deleted and error raised.
200 * @param p_validate If true, then validation alone will be performed and the
201 * database will remain unchanged. If false and all validation checks pass,
202 * then the database will be modified.
203 * @param p_pos_structure_version_id Identifies the Position Hierarchy Version
204 * record to be deleted.
205 * @param p_object_version_number Current version number of the position
206 * hierarchy version to be deleted.
207 * @rep:displayname Delete Position Hierarchy Version
208 * @rep:category BUSINESS_ENTITY PER_POSITION_HIERARCHY
209 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
210 * @rep:scope public
211 * @rep:lifecycle active
212 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
213 */
214 --
215 -- {End Of Comments}
216 --
217 PROCEDURE delete_pos_structure_version
218 ( p_validate IN BOOLEAN default false
219 ,p_pos_structure_version_id IN number
220 ,p_object_version_number IN number );
221
222 --
223 --
224 END per_pos_structure_version_api;
[Home] [Help]