1 Package pay_run_type_usage_api as
2 /* $Header: pyrtuapi.pkh 120.1 2005/10/02 02:34:14 aroussel $ */
3 /*#
4 * This package contains APIs for Run Type Usages.
5 * @rep:scope public
6 * @rep:product pay
7 * @rep:displayname Run Type Usage
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_run_type_usage >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates new run type usages.
17 *
18 * The created run_type_usages should be based on the existing run types.
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Payroll.
22 *
23 * <p><b>Prerequisites</b><br>
24 * Parent run_type_id with run_method of 'C' must exist, along with another
25 * run_type_id which will be the child_run_type_id on the usage.
26 *
27 * <p><b>Post Success</b><br>
28 * The Run Type Usages has been successfully created.
29 *
30 * <p><b>Post Failure</b><br>
31 * The API does not create the run type usage and raises an error.
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_effective_date Determines when the DateTrack operation comes into
36 * force.
37 * @param p_parent_run_type_id The parent run type is, will have run_method of
38 * 'C'.
39 * @param p_child_run_type_id The child run type id, no restriction on run
40 * method.
41 * @param p_sequence Specifies the usage order
42 * @param p_business_group_id Business Group of the Record
43 * @param p_legislation_code Legislation Code
44 * @param p_run_type_usage_id If p_validate is false, this uniquely identifies
45 * the run type usage created. If p_validate is set to true, this parameter
46 * will be null.
47 * @param p_effective_start_date If p_validate is false, then set to the
48 * earliest effective start date for the created Run Type Usages. If p_validate
49 * is true, then set to null.
50 * @param p_effective_end_date If p_validate is false, then set to the
51 * effective end date for the created Run Type Usages. If p_validate is true,
52 * then set to null.
53 * @param p_object_version_number If p_validate is false, then set to the
54 * version number of the created Run Type Usages. If p_validate is true, then
55 * the value will be null.
56 * @rep:displayname Create Run Type Usage
57 * @rep:category BUSINESS_ENTITY PAY_RUN_TYPE
58 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
59 * @rep:scope public
60 * @rep:lifecycle active
61 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
62 */
63 --
64 -- {End Of Comments}
65 --
66 procedure create_run_type_usage
67 (p_validate in boolean default false
68 ,p_effective_date in date
69 ,p_parent_run_type_id in number
70 ,p_child_run_type_id in number
71 ,p_sequence in number
72 ,p_business_group_id in number default null
73 ,p_legislation_code in varchar2 default null
74 ,p_run_type_usage_id out nocopy number
75 ,p_effective_start_date out nocopy date
76 ,p_effective_end_date out nocopy date
77 ,p_object_version_number out nocopy number
78 );
79 --
80 -- ----------------------------------------------------------------------------
81 -- |--------------------------< update_run_type_usage >-----------------------|
82 -- ----------------------------------------------------------------------------
83 --
84 -- {Start Of Comments}
85 /*#
86 * This API updates Run Type Usage.
87 *
88 *
89 * <p><b>Licensing</b><br>
90 * This API is licensed for use with Payroll.
91 *
92 * <p><b>Prerequisites</b><br>
93 * The run type usage as identified by the in parameters p_run_type_usage_id
94 * and p_object_version_number must already exist.
95 *
96 * <p><b>Post Success</b><br>
97 * The Run Type Usage has been successfully updated.
98 *
99 * <p><b>Post Failure</b><br>
100 * The API does not update the run type usage and raises an error.
101 * @param p_validate If true, then validation alone will be performed and the
102 * database will remain unchanged. If false and all validation checks pass,
103 * then the database will be modified.
104 * @param p_effective_date Determines when the DateTrack operation comes into
105 * force.
106 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
107 * updating the record. You must set to either UPDATE, CORRECTION,
108 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
109 * particular record depend on the dates of previous record changes and the
110 * effective date of this change.
111 * @param p_run_type_usage_id Identifier of the usage being updated
112 * @param p_object_version_number Pass in the current version number of the Run
113 * Type Usage to be updated. When the API completes if p_validate is false,
114 * will be set to the new version number of the updated Run Type Usage. If
115 * p_validate is true will be set to the same value which was passed in.
116 * @param p_sequence Specifies the usage order
117 * @param p_business_group_id Business Group of the Record
118 * @param p_legislation_code Legislation Code
119 * @param p_effective_start_date If p_validate is false, then set to the
120 * effective start date on the updated Run Type Usage row which now exists as
121 * of the effective date. If p_validate is true, then set to null.
122 * @param p_effective_end_date If p_validate is false, then set to the
123 * effective end date on the updated Run Type Usage row which now exists as of
124 * the effective date. If p_validate is true, then set to null.
125 * @rep:displayname Update Run Type Usage
126 * @rep:category BUSINESS_ENTITY PAY_RUN_TYPE
127 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
128 * @rep:scope public
129 * @rep:lifecycle active
130 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
131 */
132 --
133 -- {End Of Comments}
134 --
135 procedure update_run_type_usage
136 (p_validate in boolean default false
137 ,p_effective_date in date
138 ,p_datetrack_update_mode in varchar2
139 ,p_run_type_usage_id in number
140 ,p_object_version_number in out nocopy number
141 ,p_sequence in number default hr_api.g_number
142 ,p_business_group_id in number default hr_api.g_number
143 ,p_legislation_code in varchar2 default hr_api.g_varchar2
144 ,p_effective_start_date out nocopy date
145 ,p_effective_end_date out nocopy date
146 );
147 --
148 -- ----------------------------------------------------------------------------
149 -- |--------------------------< delete_run_type_usage >-----------------------|
150 -- ----------------------------------------------------------------------------
151 --
152 -- {Start Of Comments}
153 /*#
154 * This API deletes Run Type Usage.
155 *
156 *
157 * <p><b>Licensing</b><br>
158 * This API is licensed for use with Payroll.
159 *
160 * <p><b>Prerequisites</b><br>
161 * The run type usage as identified by the in parameters p_run_type_usage_id
162 * and p_object_version_number must already exist.
163 *
164 * <p><b>Post Success</b><br>
165 * The Run Type Usage has been successfully deleted.
166 *
167 * <p><b>Post Failure</b><br>
168 * The API does not delete the run type usage and raises an error.
169 * @param p_validate If true, then validation alone will be performed and the
170 * database will remain unchanged. If false and all validation checks pass,
171 * then the database will be modified.
172 * @param p_effective_date Determines when the DateTrack operation comes into
173 * force.
174 * @param p_datetrack_delete_mode Indicates which DateTrack mode to use when
175 * deleting the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
176 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
177 * on the dates of previous record changes and the effective date of this
178 * change.
179 * @param p_run_type_usage_id Identifier of the run type usage being deleted.
180 * @param p_object_version_number Pass in the current version number of the run
181 * type usage to be deleted. When the API completes if p_validate is false,
182 * will be set to the new version number of the deleted run type usage. If
183 * p_validate is true will be set to the same value which was passed in.
184 * @param p_business_group_id Business Group of the Record
185 * @param p_legislation_code Legislation Code
186 * @param p_effective_start_date If p_validate is false, then set to the
187 * effective start date for the deleted Run Type Usage row which now exists as
188 * of the effective date. If p_validate is true or all row instances have been
189 * deleted then set to null.
190 * @param p_effective_end_date If p_validate is false, then set to the
191 * effective end date for the deleted Run Type Usage row which now exists as of
192 * the effective date. If p_validate is true or all row instances have been
193 * deleted then set to null.
194 * @rep:displayname Delete Run Type Usage
195 * @rep:category BUSINESS_ENTITY PAY_RUN_TYPE
196 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
197 * @rep:scope public
198 * @rep:lifecycle active
199 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
200 */
201 --
202 -- {End Of Comments}
203 --
204 procedure delete_run_type_usage
205 (p_validate in boolean default false
206 ,p_effective_date in date
207 ,p_datetrack_delete_mode in varchar2
208 ,p_run_type_usage_id in number
209 ,p_object_version_number in out nocopy number
210 ,p_business_group_id in number default hr_api.g_number
211 ,p_legislation_code in varchar2 default hr_api.g_varchar2
212 ,p_effective_start_date out nocopy date
213 ,p_effective_end_date out nocopy date
214 );
215 --
216 end pay_run_type_usage_api;
[Home] [Help]