1 Package hr_hierarchy_element_api as
2 /* $Header: peoseapi.pkh 120.1 2005/10/02 02:19:08 aroussel $ */
3 /*#
4 * This package contains APIs that create and maintain hierarchy elements.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Organization Hierarchy Element
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_hierarchy_element >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an organization hierarchy element record.
17 *
18 * If a child element of the same name already exists in the hierarchy, the
19 * process deletes it and creates the child element the process specifies. If
20 * the organization hierarchy restricts the user's security profile, the
21 * process adds new organizations to 'PER_ORGANIZATION_LIST'. Note: This is the
22 * new recommended overloaded procedure for 'create_hierarchy_element'. The
23 * parameters p_date_from, p_security_profile_id, p_view_all_orgs,
24 * p_end_of_time, p_hr_installed, p_pa_installed are now obsolete.
25 *
26 * <p><b>Licensing</b><br>
27 * This API is licensed for use with Human Resources and HR Foundation.
28 *
29 * <p><b>Prerequisites</b><br>
30 * Parent and child organizations should exist.
31 *
32 * <p><b>Post Success</b><br>
33 * Organization hierarchy element is created.
34 *
35 * <p><b>Post Failure</b><br>
36 * Organization hierarchy element is not created and error is returned.
37 * @param p_validate If true, then validation alone will be performed and the
38 * database will remain unchanged. If false and all validation checks pass,
39 * then the database will be modified.
40 * @param p_organization_id_parent Uniquely identifies the parent organization
41 * associated with the organization hierarchy element.
42 * @param p_org_structure_version_id Uniquely identifies the organization
43 * hierarchy version.
44 * @param p_organization_id_child Uniqely identifies the child organization
45 * associated with the organization hierarchy element.
46 * @param p_business_group_id Uniquely identifies the business group associated
47 * with the organization hierarchy.
48 * @param p_effective_date Reference date for validating lookup values are
49 * applicable during the start to end active date range. This date does not
50 * determine when the changes take effect.
51 * @param p_pos_control_enabled_flag Flag that specifies if position control is
52 * enabled.
53 * @param p_inactive_org_warning Warning parameter is set to TRUE if the
54 * organization, identified by p_organization_id_child, does not exist for the
55 * duration of the structure version, identified by p_org_structure_version_id.
56 * Otherwise it is set to FALSE.
57 * @param p_org_structure_element_id If p_validate is false, then this uniquely
58 * identifies the organization hierarchy element created. If p_validate is
59 * true, then set to null.
60 * @param p_object_version_number If p_validate is false, then set to the
61 * version number of the created Organization Hierarchy Element. If p_validate
62 * is true, then the value will be null.
63 * @rep:displayname Create Organization Hierarchy Element
64 * @rep:category BUSINESS_ENTITY PER_ORGANIZATION_HIERARCHY
65 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
66 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
67 * @rep:scope public
68 * @rep:lifecycle active
69 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
70 */
71 --
72 -- {End Of Comments}
73 --
74 procedure create_hierarchy_element
75 (p_validate in boolean default false
76 ,p_effective_date in DATE
77 ,p_organization_id_parent in number
78 ,p_org_structure_version_id in number
79 ,p_organization_id_child in number
80 ,p_business_group_id in number default null
81 ,p_pos_control_enabled_flag in varchar2
82 ,p_inactive_org_warning out nocopy boolean
83 ,p_org_structure_element_id out nocopy number
84 ,p_object_version_number out nocopy number
85 );
86 --
87 -- ----------------------------------------------------------------------------
88 -- |-------------------------< create_hierarchy_element >---------------------|
89 -- ----------------------------------------------------------------------------
90 --
91 -- This version of the API is now out-of-date however it has been provided to
92 -- you for backward compatibility support and will be removed in the future.
93 -- Oracle recommends you to modify existing calling programs in advance of the
94 -- support being withdrawn thus avoiding any potential disruption.
95 --
96 procedure create_hierarchy_element
97 (p_validate in boolean default false
98 ,p_organization_id_parent in number
99 ,p_org_structure_version_id in number
100 ,p_organization_id_child in number
101 ,p_business_group_id in number default null
102 ,p_effective_date in DATE
103 ,p_date_from in DATE
104 ,p_security_profile_id in NUMBER
105 ,p_view_all_orgs in VARCHAR2
106 ,p_end_of_time in DATE
107 ,p_hr_installed in VARCHAR2
108 ,p_pa_installed in VARCHAR2
109 ,p_pos_control_enabled_flag in varchar2
110 ,p_warning_raised IN OUT NOCOPY VARCHAR2
111 ,p_org_structure_element_id out nocopy number
112 ,p_object_version_number out nocopy number
113 );
114 --
115 -- ----------------------------------------------------------------------------
116 -- |-------------------------< update_hierarchy_element >---------------------|
117 -- ----------------------------------------------------------------------------
118 --
119 -- {Start Of Comments}
120 /*#
121 * This API updates an organization hierarchy element record.
122 *
123 * This API updates a parent to a new child or a child to a new parent.
124 *
125 * <p><b>Licensing</b><br>
126 * This API is licensed for use with Human Resources and HR Foundation.
127 *
128 * <p><b>Prerequisites</b><br>
129 * Organization hierarchy element should exist.
130 *
131 * <p><b>Post Success</b><br>
132 * Organization hierarchy element is updated.
133 *
134 * <p><b>Post Failure</b><br>
135 * Organization hierarchy element is not updated and error is returned.
136 * @param p_validate If true, then validation alone will be performed and the
137 * database will remain unchanged. If false and all validation checks pass,
138 * then the database will be modified.
139 * @param p_effective_date Reference date for validating lookup values are
140 * applicable during the start to end active date range. This date does not
141 * determine when the changes take effect.
142 * @param p_org_structure_element_id Uniquely identifies the organization
143 * hierarchy element record to modify.
144 * @param p_organization_id_parent Uniquely identifies the parent organization
145 * associated with the organization hierarchy element.
146 * @param p_organization_id_child Uniquely identifies the child organization
147 * associated with the organization hierarchy element.
148 * @param p_pos_control_enabled_flag Flag that specifies if position control is
149 * enabled.
150 * @param p_object_version_number Pass in the current version number of the
151 * organization hierarchy element to be updated. When the API completes if
152 * p_validate is false, will be set to the new version number of the updated
153 * organization hierarchy element. If p_validate is true will be set to the
154 * same value which was passed in.
155 * @rep:displayname Update Organization Hierarchy Element
156 * @rep:category BUSINESS_ENTITY PER_ORGANIZATION_HIERARCHY
157 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
158 * @rep:scope public
159 * @rep:lifecycle active
160 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
161 */
162 --
163 -- {End Of Comments}
164 --
165 procedure update_hierarchy_element
166 (p_validate in boolean default false
167 ,p_effective_date in date
168 ,p_org_structure_element_id in number
169 ,p_organization_id_parent in number default hr_api.g_number
170 ,p_organization_id_child in number default hr_api.g_number
171 ,p_pos_control_enabled_flag in varchar2 default hr_api.g_varchar2
172 ,p_object_version_number in out nocopy number
173 );
174 --
175 -- ----------------------------------------------------------------------------
176 -- |-------------------------< delete_hierarchy_element >---------------------|
177 -- ----------------------------------------------------------------------------
178 --
179 -- {Start Of Comments}
180 /*#
181 * This API deletes organization hierarchy element.
182 *
183 * Note: This is the new recommended overloaded procedure for
184 * 'delete_hierarchy_element'. HRMS will desupport the obsoleted procedure in a
185 * future release. HRMS has obsoleted the parameters p_hr_installed,
186 * p_pa_installed, and removed the parameter p_exists_in_hierarchy.
187 *
188 * <p><b>Licensing</b><br>
189 * This API is licensed for use with Human Resources and HR Foundation.
190 *
191 * <p><b>Prerequisites</b><br>
192 * Organization hierarchy element should exist.
193 *
194 * <p><b>Post Success</b><br>
195 * Organization hierarchy element is deleted.
196 *
197 * <p><b>Post Failure</b><br>
198 * Organization hierarchy element is not deleted and error is returned.
199 * @param p_validate If true, then validation alone will be performed and the
200 * database will remain unchanged. If false and all validation checks pass,
201 * then the database will be modified.
202 * @param p_org_structure_element_id Uniquely identifies the organization
203 * hierarchy element record to delete.
204 * @param p_object_version_number Current version number of the Organization
205 * Hierarchy Element record to be deleted.
206 * @rep:displayname Delete Organization Hierarchy Element
207 * @rep:category BUSINESS_ENTITY PER_ORGANIZATION_HIERARCHY
208 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
209 * @rep:scope public
210 * @rep:lifecycle active
211 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
212 */
213 --
214 -- {End Of Comments}
215 --
216 procedure delete_hierarchy_element
217 (p_validate in boolean default false
218 ,p_org_structure_element_id in number
219 ,p_object_version_number in number
220 );
221 --
222 -- ----------------------------------------------------------------------------
223 -- |-------------------------< delete_hierarchy_element >---------------------|
224 -- ----------------------------------------------------------------------------
225 --
226 -- This version of the API is now out-of-date however it has been provided to
227 -- you for backward compatibility support and will be removed in the future.
228 -- Oracle recommends you to modify existing calling programs in advance of the
229 -- support being withdrawn thus avoiding any potential disruption.
230 --
231 procedure delete_hierarchy_element
232 (p_validate in boolean default false
233 ,p_org_structure_element_id in number
234 ,p_object_version_number in number
235 ,p_hr_installed in VARCHAR2
236 ,p_pa_installed in VARCHAR2
237 ,p_exists_in_hierarchy in out nocopy VARCHAR2
238 );
239 --
240 end hr_hierarchy_element_api;
[Home] [Help]