DBA Data[Home] [Help]

PACKAGE: APPS.PER_RI_CONFIG_INFORMATION_API

Source


1 Package per_ri_config_information_api AS
2 /* $Header: pecniapi.pkh 120.5 2006/05/23 20:07:51 ndorai noship $ */
3 /*#
4  * This package contains APIs that maintain enterprise structure configuration
5  * information.
6  * @rep:scope public
7  * @rep:product per
8  * @rep:displayname Enterprise Structure Configuration
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |------------------------< create_config_information >---------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17  * This API creates a Configuration Information.
18  *
19  * Configuration Information is used for setting up the HRMS Application which
20  * the Workstructures components such as Organization, Jobs, Positions.
21  *
22  * <p><b>Licensing</b><br>
23  * This API is licensed for use with Human Resources.
24  *
25  * <p><b>Prerequisites</b><br>
26  * NONE
27  *
28  * <p><b>Post Success</b><br>
29  * Configuration data to setup HCM Workstructures setup data will be created.
30  *
31  * <p><b>Post Failure</b><br>
32  * Configuration setup data will not be created and an error will be raised.
33  *
34  * @param p_validate If true, then validation alone will be performed and the
35  * database will remain unchanged. If false and all validation checks pass,
36  * then the database will be modified.
37  * @param p_configuration_code Unique short name of the configuration.
38  * @param p_config_information_category This context value determines which flexfield
39  * structure to use with the descriptive flexfield segments.
40  * @param p_config_sequence Sequence Number to display the data in an order in UI.
41  * @param p_config_information1  Descriptive Flexfield Segment.
42  * @param p_config_information2  Descriptive Flexfield Segment.
43  * @param p_config_information3  Descriptive Flexfield Segment.
44  * @param p_config_information4  Descriptive Flexfield Segment.
45  * @param p_config_information5  Descriptive Flexfield Segment.
46  * @param p_config_information6  Descriptive Flexfield Segment.
47  * @param p_config_information7  Descriptive Flexfield Segment.
48  * @param p_config_information8  Descriptive Flexfield Segment.
49  * @param p_config_information9  Descriptive Flexfield Segment.
50  * @param p_config_information10 Descriptive Flexfield Segment.
51  * @param p_config_information11 Descriptive Flexfield Segment.
52  * @param p_config_information12 Descriptive Flexfield Segment.
53  * @param p_config_information13 Descriptive Flexfield Segment.
54  * @param p_config_information14 Descriptive Flexfield Segment.
55  * @param p_config_information15 Descriptive Flexfield Segment.
56  * @param p_config_information16 Descriptive Flexfield Segment.
57  * @param p_config_information17 Descriptive Flexfield Segment.
58  * @param p_config_information18 Descriptive Flexfield Segment.
59  * @param p_config_information19 Descriptive Flexfield Segment.
60  * @param p_config_information20 Descriptive Flexfield Segment.
61  * @param p_config_information21 Descriptive Flexfield Segment.
62  * @param p_config_information22 Descriptive Flexfield Segment.
63  * @param p_config_information23 Descriptive Flexfield Segment.
64  * @param p_config_information24 Descriptive Flexfield Segment.
65  * @param p_config_information25 Descriptive Flexfield Segment.
66  * @param p_config_information26 Descriptive Flexfield Segment.
67  * @param p_config_information27 Descriptive Flexfield Segment.
68  * @param p_config_information28 Descriptive Flexfield Segment.
69  * @param p_config_information29 Descriptive Flexfield Segment.
70  * @param p_config_information30 Descriptive Flexfield Segment.
71  * @param p_language_code Specifies to which language the translation values
72  * apply. You can set to the base or any installed language. The default value
73  * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
74  * value.
75  * @param p_effective_date Reference date for validating lookup values are
76  * applicable during the start to end active date range. This date does not
77  * determine when the changes take effect.
78  * @param p_config_information_id Uniquely identifies the configuration created.
79  * @param p_object_version_number Set to the version number of the created configuration.
80  * @rep:displayname Create Configuration Information
81  * @rep:category BUSINESS_ENTITY PER_CONFIG_WORKBENCH
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_config_information
92   (   p_validate                       In  Boolean   Default False
93      ,p_configuration_code             In  Varchar2
94      ,p_config_information_category    In  Varchar2
95      ,p_config_sequence                In  Number
96      ,p_config_information1            In  Varchar2  Default Null
97      ,p_config_information2            In  Varchar2  Default Null
98      ,p_config_information3            In  Varchar2  Default Null
99      ,p_config_information4            In  Varchar2  Default Null
100      ,p_config_information5            In  Varchar2  Default Null
101      ,p_config_information6            In  Varchar2  Default Null
102      ,p_config_information7            In  Varchar2  Default Null
103      ,p_config_information8            In  Varchar2  Default Null
104      ,p_config_information9            In  Varchar2  Default Null
105      ,p_config_information10           In  Varchar2  Default Null
106      ,p_config_information11           In  Varchar2  Default Null
107      ,p_config_information12           In  Varchar2  Default Null
108      ,p_config_information13           In  Varchar2  Default Null
109      ,p_config_information14           In  Varchar2  Default Null
110      ,p_config_information15           In  Varchar2  Default Null
111      ,p_config_information16           In  Varchar2  Default Null
112      ,p_config_information17           In  Varchar2  Default Null
113      ,p_config_information18           In  Varchar2  Default Null
114      ,p_config_information19           In  Varchar2  Default Null
115      ,p_config_information20           In  Varchar2  Default Null
116      ,p_config_information21           In  Varchar2  Default Null
117      ,p_config_information22           In  Varchar2  Default Null
118      ,p_config_information23           In  Varchar2  Default Null
119      ,p_config_information24           In  Varchar2  Default Null
120      ,p_config_information25           In  Varchar2  Default Null
121      ,p_config_information26           In  Varchar2  Default Null
122      ,p_config_information27           In  Varchar2  Default Null
123      ,p_config_information28           In  Varchar2  Default Null
124      ,p_config_information29           In  Varchar2  Default Null
125      ,p_config_information30           In  Varchar2  Default Null
126      ,p_language_code                  In  Varchar2  Default hr_api.userenv_lang
127      ,p_effective_date                 In  Date
128      ,p_config_information_id          Out Nocopy Number
129      ,p_object_version_number          Out Nocopy Number
130   ) ;
131 --
132 -- ----------------------------------------------------------------------------
133 -- |------------------------< update_config_information >---------------------|
134 -- ----------------------------------------------------------------------------
135 --
136 -- {Start Of Comments}
137 /*#
138  * This API updates a Configuration Information.
139  *
140  * Configuration Information is used for setting up the HRMS Application which
141  * the Workstructures components such as Organization, Jobs, Positions.
142  *
143  * <p><b>Licensing</b><br>
144  * This API is licensed for use with Human Resources.
145  *
146  * <p><b>Prerequisites</b><br>
147  * NONE
148  *
149  * <p><b>Post Success</b><br>
150  * Configuration data to setup HCM Workstructures setup data will be updated.
151  *
152  * <p><b>Post Failure</b><br>
153  * Configuration setup data will not be updated and an error will be raised.
154  *
155  * @param p_validate If true, then validation alone will be performed and the
156  * database will remain unchanged. If false and all validation checks pass,
157  * then the database will be modified.
158  * @param p_config_information_id Uniquely identifies the configuration created.
159  * @param p_configuration_code Unique short name of the configuration.
160  * @param p_config_information_category This context value determines which flexfield
161  * structure to use with the descriptive flexfield segments.
162  * @param p_config_sequence Sequence Number to display the data in an order in UI.
163  * @param p_config_information1  Descriptive Flexfield Segment.
164  * @param p_config_information2  Descriptive Flexfield Segment.
165  * @param p_config_information3  Descriptive Flexfield Segment.
166  * @param p_config_information4  Descriptive Flexfield Segment.
167  * @param p_config_information5  Descriptive Flexfield Segment.
168  * @param p_config_information6  Descriptive Flexfield Segment.
169  * @param p_config_information7  Descriptive Flexfield Segment.
170  * @param p_config_information8  Descriptive Flexfield Segment.
171  * @param p_config_information9  Descriptive Flexfield Segment.
172  * @param p_config_information10 Descriptive Flexfield Segment.
173  * @param p_config_information11 Descriptive Flexfield Segment.
174  * @param p_config_information12 Descriptive Flexfield Segment.
175  * @param p_config_information13 Descriptive Flexfield Segment.
176  * @param p_config_information14 Descriptive Flexfield Segment.
177  * @param p_config_information15 Descriptive Flexfield Segment.
178  * @param p_config_information16 Descriptive Flexfield Segment.
179  * @param p_config_information17 Descriptive Flexfield Segment.
180  * @param p_config_information18 Descriptive Flexfield Segment.
181  * @param p_config_information19 Descriptive Flexfield Segment.
182  * @param p_config_information20 Descriptive Flexfield Segment.
183  * @param p_config_information21 Descriptive Flexfield Segment.
184  * @param p_config_information22 Descriptive Flexfield Segment.
185  * @param p_config_information23 Descriptive Flexfield Segment.
186  * @param p_config_information24 Descriptive Flexfield Segment.
187  * @param p_config_information25 Descriptive Flexfield Segment.
188  * @param p_config_information26 Descriptive Flexfield Segment.
189  * @param p_config_information27 Descriptive Flexfield Segment.
190  * @param p_config_information28 Descriptive Flexfield Segment.
191  * @param p_config_information29 Descriptive Flexfield Segment.
192  * @param p_config_information30 Descriptive Flexfield Segment.
193  * @param p_language_code Specifies to which language the translation values
194  * apply. You can set to the base or any installed language. The default value
195  * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
196  * value.
197  * @param p_effective_date Reference date for validating lookup values are
198  * applicable during the start to end active date range. This date does not
199  * determine when the changes take effect.
200  * @param p_object_version_number Set to the version number of the created configuration.
201  * @rep:displayname Update Configuration Information
202  * @rep:category BUSINESS_ENTITY PER_CONFIG_WORKBENCH
203  * @rep:lifecycle active
204  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
205  * @rep:scope public
206  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
207 */
208 --
209 -- {End Of Comments}
210 --
211 --
212 Procedure update_config_information
213     ( p_validate                       In  Boolean   Default False
214      ,p_config_information_id          In  Number
215      ,p_configuration_code             In  Varchar2
216      ,p_config_information_category    In  Varchar2
217      ,p_config_sequence                In  Number    Default hr_api.g_number
218      ,p_config_information1            In  Varchar2  Default hr_api.g_varchar2
219      ,p_config_information2            In  Varchar2  Default hr_api.g_varchar2
220      ,p_config_information3            In  Varchar2  Default hr_api.g_varchar2
221      ,p_config_information4            In  Varchar2  Default hr_api.g_varchar2
222      ,p_config_information5            In  Varchar2  Default hr_api.g_varchar2
223      ,p_config_information6            In  Varchar2  Default hr_api.g_varchar2
224      ,p_config_information7            In  Varchar2  Default hr_api.g_varchar2
225      ,p_config_information8            In  Varchar2  Default hr_api.g_varchar2
226      ,p_config_information9            In  Varchar2  Default hr_api.g_varchar2
227      ,p_config_information10           In  Varchar2  Default hr_api.g_varchar2
228      ,p_config_information11           In  Varchar2  Default hr_api.g_varchar2
229      ,p_config_information12           In  Varchar2  Default hr_api.g_varchar2
230      ,p_config_information13           In  Varchar2  Default hr_api.g_varchar2
231      ,p_config_information14           In  Varchar2  Default hr_api.g_varchar2
232      ,p_config_information15           In  Varchar2  Default hr_api.g_varchar2
233      ,p_config_information16           In  Varchar2  Default hr_api.g_varchar2
234      ,p_config_information17           In  Varchar2  Default hr_api.g_varchar2
235      ,p_config_information18           In  Varchar2  Default hr_api.g_varchar2
236      ,p_config_information19           In  Varchar2  Default hr_api.g_varchar2
237      ,p_config_information20           In  Varchar2  Default hr_api.g_varchar2
238      ,p_config_information21           In  Varchar2  Default hr_api.g_varchar2
239      ,p_config_information22           In  Varchar2  Default hr_api.g_varchar2
240      ,p_config_information23           In  Varchar2  Default hr_api.g_varchar2
241      ,p_config_information24           In  Varchar2  Default hr_api.g_varchar2
242      ,p_config_information25           In  Varchar2  Default hr_api.g_varchar2
243      ,p_config_information26           In  Varchar2  Default hr_api.g_varchar2
244      ,p_config_information27           In  Varchar2  Default hr_api.g_varchar2
245      ,p_config_information28           In  Varchar2  Default hr_api.g_varchar2
246      ,p_config_information29           In  Varchar2  Default hr_api.g_varchar2
247      ,p_config_information30           In  Varchar2  Default hr_api.g_varchar2
248      ,p_language_code                  In  Varchar2  Default hr_api.userenv_lang
249      ,p_effective_date                 In  Date
250      ,p_object_version_number          In Out Nocopy Number
251   );
252 --
253 --
254 -- ----------------------------------------------------------------------------
255 -- |------------------------< delete_config_information >---------------------|
256 -- ----------------------------------------------------------------------------
257 --
258 -- {Start Of Comments}
259 /*#
260  * This API deletes a Configuration Information.
261  *
262  * Configuration Information is used for setting up the HRMS Application which
263  * the Workstructures components such as Organization, Jobs, Positions.
264  *
265  * <p><b>Licensing</b><br>
266  * This API is licensed for use with Human Resources.
267  *
268  * <p><b>Prerequisites</b><br>
269  * NONE
270  *
271  * <p><b>Post Success</b><br>
272  * Configuration data to setup HCM Workstructures setup data will be deleted.
273  *
274  * <p><b>Post Failure</b><br>
275  * Configuration data will not be deleted and an error will be raised.
276  *
277  * @param p_validate If true, then validation alone will be performed and the
278  * database will remain unchanged. If false and all validation checks pass,
279  * then the database will be modified.
280  * @param p_config_information_id Uniquely identifies the configuration created.
281  * @param p_object_version_number Set to the version number of the created configuration.
282  * @rep:displayname Delete Configuration Information
283  * @rep:category BUSINESS_ENTITY PER_CONFIG_WORKBENCH
284  * @rep:lifecycle active
285  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
286  * @rep:scope public
287  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
288 */
289 --
290 -- {End Of Comments}
291 --
292 Procedure delete_config_information
293    (  p_validate                     In Boolean Default False
294      ,p_config_information_id        In Number
295      ,p_object_version_number        IN Number );
296 
297 End per_ri_config_information_api;
298 --