1 Package hr_cagr_parameter_api as
2 /* $Header: pecpaapi.pkh 120.1 2005/10/02 02:13:43 aroussel $ */
3 /*#
4 * This package contains APIs which maintain collective agreement parameters.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Collective Agreement Parameter
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_cagr_parameter >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a collective agreement parameter.
17 *
18 * Each parameter record holds meta data that describes a specific piece of
19 * data stored on the HRMS system, providing it with a name, a data type and
20 * unit of measure. This information is used by the collective agreement
21 * process to populate eligible entitlement results for a specific entitlement
22 * item to the relevant field on the HRMS system.
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * The collective agreement API to which this API parameter belongs must exist.
29 *
30 * <p><b>Post Success</b><br>
31 * The collective agreement API parameter is created.
32 *
33 * <p><b>Post Failure</b><br>
34 * The collective agreement API parameter is not created and an error is
35 * raised.
36 * @param p_validate If true, then validation alone will be performed and the
37 * database will remain unchanged. If false and all validation checks pass,
38 * then the database will be modified.
39 * @param p_effective_date Reference date for validating lookup values are
40 * applicable during the start to end active date range. This date does not
41 * determine when the changes take effect.
42 * @param p_cagr_api_id Uniquely identifies the collective agreement API to
43 * which this parameter belongs.
44 * @param p_display_name The display name of the API parameter.
45 * @param p_parameter_name The system name of the API parameter.
46 * @param p_column_type The data type of the API parameter. Valid values are
47 * defined by the 'CAGR_PARAM_TYPES' lookup type.
48 * @param p_column_size The maximum permitted size data supported by the API
49 * parameter.
50 * @param p_uom_parameter The name of the parameter that supplies the
51 * associated unit of measure value for this parameter.
52 * @param p_uom_lookup The name of the lookup type providing the unit of
53 * measure values for the p_uom_parameter.
54 * @param p_default_uom The unit of measure if there is not an associated unit
55 * of measure (p_uom_parameter) parameter. Valid values are defined by the
56 * 'UNITS' lookup type.
57 * @param p_hidden Indicates whether the API parameter is visible or hidden.
58 * Valid values are defined by the 'YES_NO' lookup type.
59 * @param p_cagr_api_param_id If p_validate is false, then this uniquely
60 * identifies the collective agreement API parameter created. If p_validate is
61 * true, then set to null.
62 * @param p_object_version_number If p_validate is false, then set to the
63 * version number of the created collective agreement API parameter. If
64 * p_validate is true, then the value will be null.
65 * @rep:displayname Create Collective Agreement Parameter
66 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
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_cagr_parameter
75 (
76 p_validate in boolean default false
77 ,p_effective_date in date
78 ,p_cagr_api_id in number
79 ,p_display_name in varchar2
80 ,p_parameter_name in varchar2
81 ,p_column_type in varchar2
82 ,p_column_size in number
83 ,p_uom_parameter in varchar2 default null
84 ,p_uom_lookup in varchar2 default null
85 ,p_default_uom in varchar2 default null
86 ,p_hidden in varchar2
87 ,p_cagr_api_param_id out nocopy number
88 ,p_object_version_number out nocopy number
89 );
90 --
91 -- ----------------------------------------------------------------------------
92 -- |--------------------------< update_cagr_parameter >-----------------------|
93 -- ----------------------------------------------------------------------------
94 --
95 -- {Start Of Comments}
96 /*#
97 * This API updates a collective agreement parameter.
98 *
99 * This API updates a collective agreement parameter. Each parameter record is
100 * meta data describing a specific piece of data stored on the HRMS system,
101 * providing it with a name, a data type and unit of measure. This information
102 * is used by the collective agreement process to populate eligible entitlement
103 * results for a specific entitlement item to the relevant field on the HRMS
104 * system.
105 *
106 * <p><b>Licensing</b><br>
107 * This API is licensed for use with Human Resources.
108 *
109 * <p><b>Prerequisites</b><br>
110 * The API parameter to be updated must exist. The collective agreement API to
111 * which this API parameter belongs must exist.
112 *
113 * <p><b>Post Success</b><br>
114 * The collective agreement API parameter is updated.
115 *
116 * <p><b>Post Failure</b><br>
117 * The collective agreement API parameter is not updated and an error is
118 * raised.
119 * @param p_validate If true, then validation alone will be performed and the
120 * database will remain unchanged. If false and all validation checks pass,
121 * then the database will be modified.
122 * @param p_effective_date Reference date for validating lookup values are
123 * applicable during the start to end active date range. This date does not
124 * determine when the changes take effect.
125 * @param p_cagr_api_param_id Uniquely identifies the collective agreement API
126 * parameter to be updated.
127 * @param p_cagr_api_id Uniquely identifies the collective agreement API to
128 * which this parameter belongs.
129 * @param p_display_name The display name of the API parameter.
130 * @param p_parameter_name The system name of the API parameter.
131 * @param p_column_type The data type of the API parameter. Valid values are
132 * defined by the 'CAGR_PARAM_TYPES' lookup type.
133 * @param p_column_size The maximum permitted size data supported by the API
134 * parameter.
135 * @param p_uom_parameter This name of the parameter that supplies the
136 * associated unit of measure value for this parameter.
137 * @param p_uom_lookup The name of the lookup type providing the unit of
138 * measure values for the p_uom_parameter.
139 * @param p_default_uom The unit of measure if there is not an associated unit
140 * of measure (p_uom_parameter) parameter. Valid values are defined by the
141 * 'UNITS' lookup type.
142 * @param p_hidden Indicates whether the API parameter is visible or hidden.
143 * Valid values are defined by the 'YES_NO' lookup type.
144 * @param p_object_version_number Pass in the current version number of the
145 * collective agreement API parameter to be updated. When the API completes if
146 * p_validate is false, will be set to the new version number of the updated
147 * collective agreement API parameter. If p_validate is true will be set to the
148 * same value which was passed in.
149 * @rep:displayname Update Collective Agreement Parameter
150 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
151 * @rep:scope public
152 * @rep:lifecycle active
153 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
154 */
155 --
156 -- {End Of Comments}
157 --
158 procedure update_cagr_parameter
159 (
160 p_validate in boolean default false
161 ,p_effective_date in date
162 ,p_cagr_api_param_id in number default hr_api.g_number
163 ,p_cagr_api_id in number default hr_api.g_number
164 ,p_display_name in varchar2 default hr_api.g_varchar2
165 ,p_parameter_name in varchar2 default hr_api.g_varchar2
166 ,p_column_type in varchar2 default hr_api.g_varchar2
167 ,p_column_size in number default hr_api.g_number
168 ,p_uom_parameter in varchar2 default hr_api.g_varchar2
169 ,p_uom_lookup in varchar2 default hr_api.g_varchar2
170 ,p_default_uom in varchar2 default hr_api.g_varchar2
171 ,p_hidden in varchar2 default hr_api.g_varchar2
172 ,p_object_version_number in out nocopy number
173 );
174 --
175 -- ----------------------------------------------------------------------------
176 -- |--------------------------< delete_cagr_parameter >-----------------------|
177 -- ----------------------------------------------------------------------------
178 --
179 -- {Start Of Comments}
180 /*#
181 * This API deletes a collective agreement parameter.
182 *
183 * Each parameter record holds meta data that describes a specific piece of
184 * data stored on the HRMS system, providing it with a name, a data type and
185 * unit of measure. This information is used by the collective agreement
186 * process to populate eligible entitlement results for a specific entitlement
187 * item to the relevant field on the HRMS system.
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 * The API parameter to be deleted must exist.
194 *
195 * <p><b>Post Success</b><br>
196 * The collective agreement API parameter is deleted.
197 *
198 * <p><b>Post Failure</b><br>
199 * The collective agreement API parameter is not deleted and an error is
200 * raised.
201 * @param p_cagr_api_param_id Uniquely identifies the collective agreement API
202 * parameter to be deleted.
203 * @param p_validate If true, then validation alone will be performed and the
204 * database will remain unchanged. If false and all validation checks pass,
205 * then the database will be modified.
206 * @param p_object_version_number Current version number of the collective
207 * agreement API parameter to be deleted.
208 * @rep:displayname Delete Collective Agreement Parameter
209 * @rep:category BUSINESS_ENTITY PER_COLLECTIVE_AGREEMENT
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_cagr_parameter
218 (
219 p_cagr_api_param_id in number
220 ,p_validate in boolean default false
221 ,p_object_version_number in out nocopy number
222 );
223 --
224 end hr_cagr_parameter_api;
[Home] [Help]