1 Package per_ri_config_location_api AS
2 /* $Header: pecnlapi.pkh 120.5 2006/05/25 07:18:26 ndorai noship $ */
3 /*#
4 * This package contains APIs for maintaining location information
5 * created using the Workbench Configuration.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Workbench Config Location
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------------< create_location >--------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API is used to create locations for Enterprise Structure Configuration.
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * NONE
24 *
25 * <p><b>Post Success</b><br>
26 * Location will be created.
27 *
28 * <p><b>Post Failure</b><br>
29 * Location will not be created and error is raised.
30 *
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_configuration_code Unique short name of the configuration.
35 * @param p_configuration_context This context value determines the type of organization
36 * context to which this location is attached to.
37 * @param p_location_code Unique short name of the location.
38 * @param p_description Description of the location.
39 * @param p_style This context value determines which Flexfield Structure to
40 * use with the Descriptive flexfield segments.
41 * @param p_address_line_1 Descriptive Flexfield Segment.
42 * @param p_address_line_2 Descriptive Flexfield Segment.
43 * @param p_address_line_3 Descriptive Flexfield Segment.
44 * @param p_town_or_city Descriptive Flexfield Segment.
45 * @param p_country Descriptive Flexfield Segment.
46 * @param p_postal_code Descriptive Flexfield Segment.
47 * @param p_region_1 Descriptive Flexfield Segment.
48 * @param p_region_2 Descriptive Flexfield Segment.
49 * @param p_region_3 Descriptive Flexfield Segment.
50 * @param p_telephone_number_1 Descriptive Flexfield Segment.
51 * @param p_telephone_number_2 Descriptive Flexfield Segment.
52 * @param p_telephone_number_3 Descriptive Flexfield Segment.
53 * @param p_loc_information13 Descriptive Flexfield Segment.
54 * @param p_loc_information14 Descriptive Flexfield Segment.
55 * @param p_loc_information15 Descriptive Flexfield Segment.
56 * @param p_loc_information16 Descriptive Flexfield Segment.
57 * @param p_loc_information17 Descriptive Flexfield Segment.
58 * @param p_loc_information18 Descriptive Flexfield Segment.
59 * @param p_loc_information19 Descriptive Flexfield Segment.
60 * @param p_loc_information20 Descriptive Flexfield Segment.
61 * @param p_language_code Specifies to which language the translation values
62 * apply. You can set to the base or any installed language. The default value
63 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
64 * value.
65 * @param p_effective_date Reference date for validating lookup values are
66 * applicable during the start to end active date range. This date does not
67 * determine when the changes take effect.
68 * @param p_object_version_number If p_validate is false, then set to the
69 * version number of the created location. If p_validate is true, then the
70 * value will be null.
71 * @param p_location_id If p_validate is false, uniquely identifies the
72 * location created. If p_validate is true set to null.
73 * @rep:displayname Create Config Workbench Location
74 * @rep:category BUSINESS_ENTITY PER_CONFIG_WORKBENCH
75 * @rep:lifecycle active
76 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
77 * @rep:scope public
78 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
79 */
80 --
81 -- {End Of Comments}
82 --
83 --
84 Procedure create_location
85 ( p_validate In Boolean Default False
86 ,p_configuration_code In Varchar2
87 ,p_configuration_context In Varchar2
88 ,p_location_code In Varchar2
89 ,p_description In Varchar2 Default Null
90 ,p_style In Varchar2 Default Null
91 ,p_address_line_1 In Varchar2 Default Null
92 ,p_address_line_2 In Varchar2 Default Null
93 ,p_address_line_3 In Varchar2 Default Null
94 ,p_town_or_city In Varchar2 Default Null
95 ,p_country In Varchar2 Default Null
96 ,p_postal_code In Varchar2 Default Null
97 ,p_region_1 In Varchar2 Default Null
98 ,p_region_2 In Varchar2 Default Null
99 ,p_region_3 In Varchar2 Default Null
100 ,p_telephone_number_1 In Varchar2 Default Null
101 ,p_telephone_number_2 In Varchar2 Default Null
102 ,p_telephone_number_3 In Varchar2 Default Null
103 ,p_loc_information13 In Varchar2 Default Null
104 ,p_loc_information14 In Varchar2 Default Null
105 ,p_loc_information15 In Varchar2 Default Null
106 ,p_loc_information16 In Varchar2 Default Null
107 ,p_loc_information17 In Varchar2 Default Null
108 ,p_loc_information18 In Varchar2 Default Null
109 ,p_loc_information19 In Varchar2 Default Null
110 ,p_loc_information20 In Varchar2 Default Null
111 ,p_language_code In Varchar2 Default hr_api.userenv_lang
112 ,p_effective_date In Date
113 ,p_object_version_number Out Nocopy Number
114 ,p_location_id Out Nocopy Number
115 ) ;
116 --
117 -- ----------------------------------------------------------------------------
118 -- |-----------------------------< update_location >--------------------------|
119 -- ----------------------------------------------------------------------------
120 --
121 -- {Start Of Comments}
122 /*#
123 * This API is used to update locations for Enterprise Structure Configuration.
124 *
125 * <p><b>Licensing</b><br>
126 * This API is licensed for use with Human Resources.
127 *
128 * <p><b>Prerequisites</b><br>
129 * NONE
130 *
131 * <p><b>Post Success</b><br>
132 * Location will be updated.
133 *
134 * <p><b>Post Failure</b><br>
135 * Location will not be updated and error is raised.
136 *
137 * @param p_validate If true, then validation alone will be performed and the
138 * database will remain unchanged. If false and all validation checks pass,
139 * then the database will be modified.
140 * @param p_location_id Uniquely identifies the location to be updated.
141 * @param p_configuration_code Unique short name of the configuration.
142 * @param p_configuration_context This context value determines the type of organization
143 * context to which this location is attached to.
144 * @param p_location_code Unique short name of the location.
145 * @param p_description Description of the location.
146 * @param p_style This context value determines which Flexfield Structure to
147 * use with the Descriptive flexfield segments.
148 * @param p_address_line_1 Descriptive flexfield segments.
149 * @param p_address_line_2 Descriptive flexfield segments.
150 * @param p_address_line_3 Descriptive flexfield segments.
151 * @param p_town_or_city Descriptive flexfield segments.
152 * @param p_country Descriptive flexfield segments.
153 * @param p_postal_code Descriptive flexfield segments.
154 * @param p_region_1 Descriptive flexfield segments.
155 * @param p_region_2 Descriptive flexfield segments.
156 * @param p_region_3 Descriptive flexfield segments.
157 * @param p_telephone_number_1 Descriptive flexfield segments.
158 * @param p_telephone_number_2 Descriptive flexfield segments.
159 * @param p_telephone_number_3 Descriptive flexfield segments.
160 * @param p_loc_information13 Descriptive flexfield segments.
161 * @param p_loc_information14 Descriptive flexfield segments.
162 * @param p_loc_information15 Descriptive flexfield segments.
163 * @param p_loc_information16 Descriptive flexfield segments.
164 * @param p_loc_information17 Descriptive flexfield segments.
165 * @param p_loc_information18 Descriptive flexfield segments.
166 * @param p_loc_information19 Descriptive flexfield segments.
167 * @param p_loc_information20 Descriptive flexfield segments.
168 * @param p_language_code Specifies to which language the translation values
169 * apply. You can set to the base or any installed language. The default value
170 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
171 * value.
172 * @param p_effective_date Reference date for validating lookup values are
173 * applicable during the start to end active date range. This date does not
174 * determine when the changes take effect.
175 * @param p_object_version_number If p_validate is false, then set to the
176 * version number of the created location. If p_validate is true, then the
177 * value will be null.
178 * @rep:displayname Update Config Workbench Location
179 * @rep:category BUSINESS_ENTITY PER_CONFIG_WORKBENCH
180 * @rep:lifecycle active
181 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
182 * @rep:scope public
183 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
184 */
185 --
186 -- {End Of Comments}
187 --
188 --
189 Procedure update_location
190 ( p_validate In Boolean Default False
191 ,p_location_id In Number
192 ,p_configuration_code In Varchar2
193 ,p_configuration_context In Varchar2
194 ,p_location_code In Varchar2
195 ,p_description In Varchar2 Default hr_api.g_varchar2
196 ,p_style In Varchar2 Default hr_api.g_varchar2
197 ,p_address_line_1 In Varchar2 Default hr_api.g_varchar2
198 ,p_address_line_2 In Varchar2 Default hr_api.g_varchar2
199 ,p_address_line_3 In Varchar2 Default hr_api.g_varchar2
200 ,p_town_or_city In Varchar2 Default hr_api.g_varchar2
201 ,p_country In Varchar2 Default hr_api.g_varchar2
202 ,p_postal_code In Varchar2 Default hr_api.g_varchar2
203 ,p_region_1 In Varchar2 Default hr_api.g_varchar2
204 ,p_region_2 In Varchar2 Default hr_api.g_varchar2
205 ,p_region_3 In Varchar2 Default hr_api.g_varchar2
206 ,p_telephone_number_1 In Varchar2 Default hr_api.g_varchar2
207 ,p_telephone_number_2 In Varchar2 Default hr_api.g_varchar2
208 ,p_telephone_number_3 In Varchar2 Default hr_api.g_varchar2
209 ,p_loc_information13 In Varchar2 Default hr_api.g_varchar2
210 ,p_loc_information14 In Varchar2 Default hr_api.g_varchar2
211 ,p_loc_information15 In Varchar2 Default hr_api.g_varchar2
212 ,p_loc_information16 In Varchar2 Default hr_api.g_varchar2
213 ,p_loc_information17 In Varchar2 Default hr_api.g_varchar2
214 ,p_loc_information18 In Varchar2 Default hr_api.g_varchar2
215 ,p_loc_information19 In Varchar2 Default hr_api.g_varchar2
216 ,p_loc_information20 In Varchar2 Default hr_api.g_varchar2
217 ,p_language_code In Varchar2 Default hr_api.userenv_lang
218 ,p_effective_date In Date
219 ,p_object_version_number In Out Nocopy Number
220 );
221 --
222 -- ----------------------------------------------------------------------------
223 -- |-----------------------------< delete_location >--------------------------|
224 -- ----------------------------------------------------------------------------
225 --
226 -- {Start Of Comments}
227 /*#
228 * This API is used to delete locations for Enterprise Structure Configuration.
229 *
230 * <p><b>Licensing</b><br>
231 * This API is licensed for use with Human Resources.
232 *
233 * <p><b>Prerequisites</b><br>
234 * NONE
235 *
236 * <p><b>Post Success</b><br>
237 * Location will be deleted.
238 *
239 * <p><b>Post Failure</b><br>
240 * Location will not be deleted and error is raised.
241 *
242 * @param p_validate If true, then validation alone will be performed and the
243 * database will remain unchanged. If false and all validation checks pass,
244 * then the database will be modified.
245 * @param p_location_id Uniquely identifies the location to be updated.
246 * @param p_object_version_number If p_validate is false, then set to the
247 * version number of the created location. If p_validate is true, then the
248 * value will be null.
249 * @rep:displayname Delete Config Workbench Location
250 * @rep:category BUSINESS_ENTITY PER_CONFIG_WORKBENCH
251 * @rep:lifecycle active
252 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
253 * @rep:scope public
254 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
255 */
256 --
257 -- {End Of Comments}
258 --
259 Procedure delete_location
260 ( p_validate In Boolean Default False
261 ,p_location_id In Number
262 ,p_object_version_number IN Number );
263
264 End per_ri_config_location_api;
265 --
[Home] [Help]