1 Package per_ri_configuration_api AUTHID CURRENT_USER AS
2 /* $Header: pecnfapi.pkh 120.2 2006/05/23 20:11:11 ndorai noship $ */
3 /*#
4 * This package contains APIs for the creation and maintenance of
5 * enterprise structure configuration.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Workbench Configuration.
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |---------------------------< create_configuration >-----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a Workbench 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 * Configuration data uniquely identified by configuration code will be
27 * created.
28 *
29 * <p><b>Post Failure</b><br>
30 * Data will not be created and an error will be raised.
31 *
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_configuration_code Unique short name of the configuration.
36 * @param p_configuration_type Type of the configuration.
37 * @param p_configuration_status Status of the configuration such as Complete, Load.
38 * @param p_configuration_name Name of the configuration for identification.
39 * @param p_configuration_description A brief description of the configuration.
40 * @param p_language_code Specifies to which language the translation values
41 * apply. You can set to the base or any installed language. The default value
42 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
43 * value.
44 * @param p_effective_date Reference date for validating lookup values are
45 * applicable during the start to end active date range. This date does not
46 * determine when the changes take effect.
47 * @param p_object_version_number Set to the version number of the created configuration.
48 * @rep:displayname Create Configuration
49 * @rep:category BUSINESS_ENTITY PER_CONFIG_WORKBENCH
50 * @rep:lifecycle active
51 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
52 * @rep:scope public
53 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
54 */
55 --
56 -- {End Of Comments}
57 --
58 --
59 Procedure create_configuration
60 ( p_validate In Boolean Default False
61 ,p_configuration_code In Varchar2
62 ,p_configuration_type In Varchar2
63 ,p_configuration_status In Varchar2
64 ,p_configuration_name In Varchar2
65 ,p_configuration_description In Varchar2
66 ,p_language_code In Varchar2 Default hr_api.userenv_lang
67 ,p_effective_date In Date
68 ,p_object_version_number Out Nocopy Number
69 ) ;
70 --
71 -- ----------------------------------------------------------------------------
72 -- |---------------------------< update_configuration >-----------------------|
73 -- ----------------------------------------------------------------------------
74 --
75 -- {Start Of Comments}
76 /*#
77 * This API updates the Workbench Configuration.
78 *
79 * <p><b>Licensing</b><br>
80 * This API is licensed for use with Human Resources.
81 *
82 * <p><b>Prerequisites</b><br>
83 * NONE
84 *
85 * <p><b>Post Success</b><br>
86 * Configuration data uniquely identified by configuration code will be
87 * updated.
88 *
89 * <p><b>Post Failure</b><br>
90 * Data will not be updated and an error will be raised.
91 *
92 * @param p_validate If true, then validation alone will be performed and the
93 * database will remain unchanged. If false and all validation checks pass,
94 * then the database will be modified.
95 * @param p_configuration_code Unique short name of the configuration.
96 * @param p_configuration_type Type of the configuration.
97 * @param p_configuration_status Status of the configuration such as Complete, Load.
98 * @param p_configuration_name Name of the configuration.
99 * @param p_configuration_description Brief description of the configuration.
100 * @param p_language_code Specifies to which language the translation values
101 * apply. You can set to the base or any installed language. The default value
102 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
103 * value.
104 * @param p_effective_date Reference date for validating lookup values are
105 * applicable during the start to end active date range. This date does not
106 * determine when the changes take effect.
107 * @param p_object_version_number Set to the version number of the created configuration.
108 * @rep:displayname Update Configuration
109 * @rep:category BUSINESS_ENTITY PER_CONFIG_WORKBENCH
110 * @rep:lifecycle active
111 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
112 * @rep:scope public
113 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
114 */
115 --
116 -- {End Of Comments}
117 --
118 --
119 Procedure update_configuration
120 ( p_validate In Boolean Default False
121 ,p_configuration_code In Varchar2
122 ,p_configuration_type In Varchar2 Default hr_api.g_varchar2
123 ,p_configuration_status In Varchar2 Default hr_api.g_varchar2
124 ,p_configuration_name In Varchar2 Default hr_api.g_varchar2
125 ,p_configuration_description In Varchar2 Default hr_api.g_varchar2
126 ,p_language_code In Varchar2 Default hr_api.userenv_lang
127 ,p_effective_date In Date
128 ,p_object_version_number In Out Nocopy Number
129 );
130 --
131 -- ----------------------------------------------------------------------------
132 -- |---------------------------< delete_configuration >-----------------------|
133 -- ----------------------------------------------------------------------------
134 --
135 -- {Start Of Comments}
136 /*#
137 * This API deletes the Workbench Configuration records.
138 *
139 * <p><b>Licensing</b><br>
140 * This API is licensed for use with Human Resources.
141 *
142 * <p><b>Prerequisites</b><br>
143 * NONE
144 *
145 * <p><b>Post Success</b><br>
146 * Configuration data uniquely identified by configuration code will be
147 * deleted.
148 *
149 * <p><b>Post Failure</b><br>
150 * Record will not be deleted and an error will be raised.
151 *
152 * @param p_validate If true, then validation alone will be performed and the
153 * database will remain unchanged. If false and all validation checks pass,
154 * then the database will be modified.
155 * @param p_configuration_code Unique short name of the configuration.
156 * @param p_object_version_number Set to the version number of the created configuration.
157 * @rep:displayname Delete Configuration
158 * @rep:category BUSINESS_ENTITY PER_CONFIG_WORKBENCH
159 * @rep:lifecycle active
160 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
161 * @rep:scope public
162 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
163 */
164 --
165 -- {End Of Comments}
166 --
167 Procedure delete_configuration
168 ( p_validate In Boolean Default False
169 ,p_configuration_code In Varchar2
170 ,p_object_version_number In Number );
171
172 End per_ri_configuration_api;
173 --
[Home] [Help]