1 Package PAY_LINK_INPUT_VALUES_api AUTHID CURRENT_USER as
2 /* $Header: pylivapi.pkh 120.1 2005/10/02 02:32:02 aroussel $ */
3 /*#
4 * This package contains link input value APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Link Input Value
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_liv_internal >----------------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 --
15 -- Description:
16 -- This Business Support Process is used to create a new link input value
17 -- as of effective date.
18 -- A Link Input Value will be created whenever an Element Link is created
19 -- or a New Input Value is created (with an existing Element Link).
20 --
21 -- Prerequisites:
22 -- An Element Link must be set up for a valid Element with Input Values.
23 --
24 -- In Parameters:
25 -- Name Reqd Type Description
26 -- p_effective_date Y date Effective start date for the
27 -- link input value.
28 -- p_element_link_id Y number Element Link Value Identifier
29 -- p_input_value_id Y number Input Value Identifier
30 -- p_costed_flag Y varchar2 Indicates whether an Input
31 -- Value is costed.
32 -- p_default_value varchar2 Default for the Input Value
33 -- on Entry.
34 -- p_max_value varchar2 Maximum value allowed on
35 -- Entry.
36 -- p_min_value varchar2 Minimum value allowed on
37 -- Entry.
38 -- p_warning_or_error varchar2 Indicates whether a warning or
39 -- error message is generated if
40 -- the input value is not valid
41 -- for formula validation.
42 --
43 -- Post Success:
44 -- When the Link Input Value is created the following OUT parameters are set.
45 --
46 -- Name Type Description
47 -- p_link_input_value_id number Primary Key
48 -- If p_validate is true then this
49 -- will be set to null.
50 -- p_effective_start_date date Effective Start Date
51 -- If p_validate is true then this
52 -- will be set to null.
53 -- p_effective_end_date date Effective End Date
54 -- If p_validate is true then this
55 -- will be set to null.
56 -- p_object_version_number date Object Version Number
57 -- If p_validate is true then this
58 -- will be set to null.
59 -- p_pay_basis_warning boolean Will be True, if the Input Value
60 -- is a Pay Basis for the Element.
61 --
62 -- Post Failure:
63 -- Error Messages are raised if any business rule is violated and the link
64 -- input value is not created.
65 --
66 -- Access Status:
67 -- Internal Development Use Only.
68 --
69 -- {End Of Comments}
70 --
71 --
72 procedure CREATE_LIV_INTERNAL
73 (p_effective_date in date
74 ,p_element_link_id in number
75 ,p_input_value_id in number
76 ,p_costed_flag in varchar2
77 ,p_default_value in varchar2 default null
78 ,p_max_value in varchar2 default null
79 ,p_min_value in varchar2 default null
80 ,p_warning_or_error in varchar2 default null
81 ,p_link_input_value_id out nocopy number
82 ,p_effective_start_date out nocopy date
83 ,p_effective_end_date out nocopy date
84 ,p_object_version_number out nocopy number
85 ,p_pay_basis_warning out nocopy boolean
86 );
87 --
88 -- ----------------------------------------------------------------------------
89 -- |-------------------------< update_link_input_values >---------------------|
90 -- ----------------------------------------------------------------------------
91 --
92 -- {Start Of Comments}
93 /*#
94 * This API is used to update an input value for an element link.
95 *
99 * <p><b>Licensing</b><br>
96 * The role of this process is to perform a validated, date-effective update of
97 * an existing row in the pay_link_input_values_f table of the HR schema.
98 *
100 * This API is licensed for use with Human Resources.
101 *
102 * <p><b>Prerequisites</b><br>
103 * The link input value as identified by the in parameter p_link_input_value_id
104 * and the in out parameter p_object_version_id must already exist.
105 *
106 * <p><b>Post Success</b><br>
107 * The link input value will have been successfully updated in the database.
108 *
109 * <p><b>Post Failure</b><br>
110 * The link input value will not be updated and an error will be raised.
111 * @param p_validate If true, then validation alone will be performed and the
112 * database will remain unchanged. If false and all validation checks pass,
113 * then the database will be modified.
114 * @param p_effective_date Determines when the DateTrack operation comes into
115 * force.
116 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
117 * updating the record. You must set to either UPDATE, CORRECTION,
118 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
119 * particular record depend on the dates of previous record changes and the
120 * effective date of this change.
121 * @param p_link_input_value_id {@rep:casecolumn
122 * PAY_LINK_INPUT_VALUES_F.LINK_INPUT_VALUE_ID}
123 * @param p_object_version_number Pass in the current version number of the
124 * link input value to be updated. When the API completes if p_validate is
125 * false, will be set to the new version number of the updated link input
126 * value. If p_validate is true will be set to the same value which was passed
127 * in.
128 * @param p_costed_flag {@rep:casecolumn PAY_LINK_INPUT_VALUES_F.COSTED_FLAG}
129 * @param p_default_value {@rep:casecolumn
130 * PAY_LINK_INPUT_VALUES_F.DEFAULT_VALUE}
131 * @param p_max_value {@rep:casecolumn PAY_LINK_INPUT_VALUES_F.MAX_VALUE}
132 * @param p_min_value {@rep:casecolumn PAY_LINK_INPUT_VALUES_F.MIN_VALUE}
133 * @param p_warning_or_error {@rep:casecolumn
134 * PAY_LINK_INPUT_VALUES_F.WARNING_OR_ERROR}
135 * @param p_effective_start_date If p_validate is false, then set to the
136 * effective start date on the updated link input value row which now exists as
137 * of the effective date. If p_validate is true, then set to null.
138 * @param p_effective_end_date If p_validate is false, then set to the
139 * effective end date on the updated link input value row which now exists as
140 * of the effective date. If p_validate is true, then set to null.
141 * @param p_pay_basis_warning If set to true, then this input value is used in
142 * a salary basis for the element.
143 * @param p_default_range_warning If set to true, then the default value is
144 * outside the allowable range for this input value.
145 * @param p_default_formula_warning If set to true, then formula validation for
146 * this input value's default value has failed.
147 * @param p_assignment_id_warning If set to true, then this input value's
148 * formula requires an ASSIGNMENT_ID input, which cannot be set at this level.
149 * @param p_formula_message If formula validation fails, then set to a
150 * user-defined error message for the formula, if one exists. Otherwise, set to
151 * null
152 * @rep:displayname Update Input Value for Element Link
153 * @rep:category BUSINESS_ENTITY PAY_ELEMENT_LINK
154 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
155 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
156 * @rep:scope public
157 * @rep:lifecycle active
158 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
159 */
160 --
161 -- {End Of Comments}
162 --
163 procedure UPDATE_LINK_INPUT_VALUES
164 (p_validate in boolean default false
165 ,p_effective_date in date
166 ,p_datetrack_update_mode in varchar2
167 ,p_link_input_value_id in number
168 ,p_object_version_number in out nocopy number
169 ,p_costed_flag in varchar2 default hr_api.g_varchar2
170 ,p_default_value in varchar2 default hr_api.g_varchar2
171 ,p_max_value in varchar2 default hr_api.g_varchar2
172 ,p_min_value in varchar2 default hr_api.g_varchar2
173 ,p_warning_or_error in varchar2 default hr_api.g_varchar2
174 ,p_effective_start_date out nocopy date
175 ,p_effective_end_date out nocopy date
176 ,p_pay_basis_warning out nocopy boolean
177 ,p_default_range_warning out nocopy boolean
178 ,p_default_formula_warning out nocopy boolean
179 ,p_assignment_id_warning out nocopy boolean
180 ,p_formula_message out nocopy varchar2
181 );
182 --
183 -- ----------------------------------------------------------------------------
184 -- |-------------------------< delete_link_input_values >---------------------|
185 -- ----------------------------------------------------------------------------
186 --
187 -- {Start Of Comments}
188 /*#
189 * This API deletes an input value for an element link.
190 *
191 * The role of this process is to perform a validated, date-effective delete of
192 * an existing row from the pay_link_input_values_f table of the HR schema.
193 *
194 * <p><b>Licensing</b><br>
195 * This API is licensed for use with Human Resources.
196 *
197 * <p><b>Prerequisites</b><br>
198 * The link input value as identified by the in parameter p_link_input_value_id
199 * and the in out parameter p_object_version_id must already exist.
200 *
201 * <p><b>Post Success</b><br>
202 * The link input value will have been successfully removed from the database.
203 *
204 * <p><b>Post Failure</b><br>
205 * The link input value will not be deleted and an error will be raised.
209 * @param p_effective_date Determines when the DateTrack operation comes into
206 * @param p_validate If true, then validation alone will be performed and the
207 * database will remain unchanged. If false and all validation checks pass,
208 * then the database will be modified.
210 * force.
211 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
212 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
213 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
214 * on the dates of previous record changes and the effective date of this
215 * change.
216 * @param p_link_input_value_id {@rep:casecolumn
217 * PAY_LINK_INPUT_VALUES_F.LINK_INPUT_VALUE_ID}
218 * @param p_effective_start_date If p_validate is false, then set to the
219 * effective start date for the deleted link input value row which now exists
220 * as of the effective date. If p_validate is true or all row instances have
221 * been deleted then set to null.
222 * @param p_effective_end_date If p_validate is false, then set to the
223 * effective end date for the deleted link input value row which now exists as
224 * of the effective date. If p_validate is true or all row instances have been
225 * deleted then set to null.
226 * @param p_object_version_number Pass in the current version number of the
227 * link input value to be deleted. When the API completes if p_validate is
228 * false, will be set to the new version number of the deleted link input
229 * value. If p_validate is true will be set to the same value which was passed
230 * in.
231 * @rep:displayname Delete Input Value for Element Link
232 * @rep:category BUSINESS_ENTITY PAY_ELEMENT_LINK
233 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
234 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
235 * @rep:scope public
236 * @rep:lifecycle active
237 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
238 */
239 --
240 -- {End Of Comments}
241 --
242 procedure DELETE_LINK_INPUT_VALUES
243 (p_validate in boolean default false
244 ,p_effective_date in date
245 ,p_datetrack_delete_mode in varchar2
246 ,p_link_input_value_id in number
247 ,p_effective_start_date out nocopy date
248 ,p_effective_end_date out nocopy date
249 ,p_object_version_number in out nocopy number
250 );
251 --
252
253 end PAY_LINK_INPUT_VALUES_API;
[Home] [Help]