1 Package PAY_RUN_TYPE_ORG_METHOD_API as
2 /* $Header: pyromapi.pkh 120.1 2005/10/02 02:34:08 aroussel $ */
3 /*#
4 * This package contains the Run Type Organization Method API.
5 * @rep:scope public
6 * @rep:product pay
7 * @rep:displayname Run Type Organization Method
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_run_type_org_method >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API inserts a Run Type Organization Method record.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Payroll.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The run type and the organization payment method should exist for the same
24 * business group as this record.
25 *
26 * <p><b>Post Success</b><br>
27 * The run type organization payment method will be successfully inserted into
28 * the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The API does not create the run type organization payment method and raises
32 * an error.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Determines when the DateTrack operation comes into
37 * force.
38 * @param p_run_type_id The identifier of the run type using the payment
39 * method.
40 * @param p_org_payment_method_id The identifier of the payment method
41 * referenced by the run type.
42 * @param p_priority Must be between 1 and 99
43 * @param p_percentage Must be between 1 and 100 in decimal format to 2.d.p
44 * Cannot be null if amount is null and must be null if amount is not null.
45 * @param p_amount Must be >= 0. Must be of correct money format for payment
46 * method. Cannot be null if percentage is null and must be null if percentage
47 * is not null.
48 * @param p_business_group_id {@rep:casecolumn
49 * PAY_RUN_TYPE_ORG_METHODS_F.BUSINESS_GROUP_ID}
50 * @param p_legislation_code {@rep:casecolumn
51 * PAY_RUN_TYPE_ORG_METHODS_F.LEGISLATION_CODE}
52 * @param p_run_type_org_method_id If p_validate is false, this uniquely
53 * identifies the run type organization payment method created. If p_validate
54 * is set to true, this parameter will be null.
55 * @param p_object_version_number If p_validate is false, then set to the
56 * version number of the created run type organization payment. If p_validate
57 * is true, then the value will be null.
58 * @param p_effective_start_date If p_validate is false, then set to the
59 * earliest effective start date for the created run type organization payment.
60 * If p_validate is true, then set to null.
61 * @param p_effective_end_date If p_validate is false, then set to the
62 * effective end date for the created run type organization payment. If
63 * p_validate is true, then set to null.
64 * @rep:displayname Create Run Type Organization Method
65 * @rep:category BUSINESS_ENTITY PAY_RUN_TYPE
66 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
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_run_type_org_method
75 (p_validate in boolean default false
76 ,p_effective_date in date
77 ,p_run_type_id in number
78 ,p_org_payment_method_id in number
79 ,p_priority in number
80 ,p_percentage in number default null
81 ,p_amount in number default null
82 ,p_business_group_id in number default null
83 ,p_legislation_code in varchar2 default null
84 ,p_run_type_org_method_id out nocopy number
85 ,p_object_version_number out nocopy number
86 ,p_effective_start_date out nocopy date
87 ,p_effective_end_date out nocopy date
88 );
89 --
90 -- ----------------------------------------------------------------------------
91 -- |------------------------< update_run_type_org_method >--------------------|
92 -- ----------------------------------------------------------------------------
93 --
94 -- {Start Of Comments}
95 /*#
96 * This API updates the run type organization payment method record.
97 *
98 *
99 * <p><b>Licensing</b><br>
100 * This API is licensed for use with Payroll.
101 *
102 * <p><b>Prerequisites</b><br>
103 * The run type organization method to be updated should exist.
104 *
105 * <p><b>Post Success</b><br>
106 * The run type organization payment method will be successfully updated in the
107 * database.
108 *
109 * <p><b>Post Failure</b><br>
110 * The API does not update the run type organization payment method and raises
111 * an error.
112 * @param p_validate If true, then validation alone will be performed and the
113 * database will remain unchanged. If false and all validation checks pass,
114 * then the database will be modified.
115 * @param p_effective_date Determines when the DateTrack operation comes into
116 * force.
117 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
118 * updating the record. You must set to either UPDATE, CORRECTION,
119 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
120 * particular record depend on the dates of previous record changes and the
121 * effective date of this change.
122 * @param p_run_type_org_method_id Unique Identifier of the run type
123 * organization payment method being updated.
124 * @param p_object_version_number Pass in the current version number of the run
125 * type organization payment method to be updated. When the API completes if
126 * p_validate is false, will be set to the new version number of the updated
127 * run type organization payment method. If p_validate is true will be set to
128 * the same value which was passed in.
129 * @param p_priority Must be between 1 and 99
130 * @param p_percentage Must be between 1 and 100 in decimal format to 2.d.p
131 * Cannot be null if amount is null and must be null if amount is not null.
132 * @param p_amount Must be >= 0. Must be of correct money format for payment
133 * method. Cannot be null if percentage is null and must be null if percentage
134 * is not null.
135 * @param p_business_group_id {@rep:casecolumn
136 * PAY_RUN_TYPE_ORG_METHODS_F.BUSINESS_GROUP_ID}
137 * @param p_legislation_code {@rep:casecolumn
138 * PAY_RUN_TYPE_ORG_METHODS_F.LEGISLATION_CODE}
139 * @param p_effective_start_date If p_validate is false, then set to the
140 * effective start date on the updated run type org row which now exists as of
141 * the effective date. If p_validate is true, then set to null.
142 * @param p_effective_end_date If p_validate is false, then set to the
143 * effective end date on the updated run type org row which now exists as of
144 * the effective date. If p_validate is true, then set to null.
145 * @rep:displayname Update Run Type Organization Method
146 * @rep:category BUSINESS_ENTITY PAY_RUN_TYPE
147 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
148 * @rep:scope public
149 * @rep:lifecycle active
150 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
151 */
152 --
153 -- {End Of Comments}
154 --
155 procedure update_run_type_org_method
156 (p_validate in boolean default false
157 ,p_effective_date in date
158 ,p_datetrack_update_mode in varchar2
159 ,p_run_type_org_method_id in number
160 ,p_object_version_number in out nocopy number
161 ,p_priority in number default hr_api.g_number
162 ,p_percentage in number default hr_api.g_number
163 ,p_amount in number default hr_api.g_number
164 ,p_business_group_id in number default hr_api.g_number
165 ,p_legislation_code in varchar2 default hr_api.g_varchar2
166 ,p_effective_start_date out nocopy date
167 ,p_effective_end_date out nocopy date
168 );
169 --
170 -- ----------------------------------------------------------------------------
171 -- |------------------------< delete_run_type_org_method >--------------------|
172 -- ----------------------------------------------------------------------------
173 --
174 -- {Start Of Comments}
175 /*#
176 * This API deletes a run type organization payment method record.
177 *
178 *
179 * <p><b>Licensing</b><br>
180 * This API is licensed for use with Payroll.
181 *
182 * <p><b>Prerequisites</b><br>
183 * The run type organization method to be deleted should exist.
184 *
185 * <p><b>Post Success</b><br>
186 * The run type organization payment method will be successfully deleted from
187 * the database.
188 *
189 * <p><b>Post Failure</b><br>
190 * The API does not delete the run type organization payment method and raises
191 * an error.
192 * @param p_validate If true, then validation alone will be performed and the
193 * database will remain unchanged. If false and all validation checks pass,
194 * then the database will be modified.
195 * @param p_effective_date Determines when the DateTrack operation comes into
196 * force.
197 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
198 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
199 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
200 * on the dates of previous record changes and the effective date of this
201 * change.
202 * @param p_run_type_org_method_id Unique Identifier of the run type
203 * organization payment method being deleted.
204 * @param p_object_version_number Pass in the current version number of the run
205 * type org to be deleted. When the API completes if p_validate is false, will
206 * be set to the new version number of the deleted run type org. If p_validate
207 * is true will be set to the same value which was passed in.
208 * @param p_business_group_id {@rep:casecolumn
209 * PAY_RUN_TYPE_ORG_METHODS_F.BUSINESS_GROUP_ID}
210 * @param p_legislation_code {@rep:casecolumn
211 * PAY_RUN_TYPE_ORG_METHODS_F.LEGISLATION_CODE}
212 * @param p_effective_start_date If p_validate is false, then set to the
213 * effective start date for the deleted run type org row which now exists as of
214 * the effective date. If p_validate is true or all row instances have been
215 * deleted then set to null.
216 * @param p_effective_end_date If p_validate is false, then set to the
217 * effective end date for the deleted run type org row which now exists as of
218 * the effective date. If p_validate is true or all row instances have been
219 * deleted then set to null.
220 * @rep:displayname Delete Run Type Organization Method
221 * @rep:category BUSINESS_ENTITY PAY_RUN_TYPE
222 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
223 * @rep:scope public
224 * @rep:lifecycle active
225 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
226 */
227 --
228 -- {End Of Comments}
229 --
230 procedure delete_run_type_org_method
231 (p_validate in boolean default false
232 ,p_effective_date in date
233 ,p_datetrack_delete_mode in varchar2
234 ,p_run_type_org_method_id in number
235 ,p_object_version_number in out nocopy number
236 ,p_business_group_id in number default null
237 ,p_legislation_code in varchar2 default null
238 ,p_effective_start_date out nocopy date
239 ,p_effective_end_date out nocopy date
240 );
241 --
242 end PAY_RUN_TYPE_ORG_METHOD_API
243 ;
[Home] [Help]