1 Package PAY_TIME_DEFINITION_API AUTHID CURRENT_USER as
2 /* $Header: pytdfapi.pkh 120.2 2006/07/13 13:28:18 pgongada noship $ */
3 /*#
4 * This package is used to Create, Update and Delete the Time Definitions.
5 * @rep:scope public
6 * @rep:product pay
7 * @rep:displayname Time Definitions
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_time_definition >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API is used to Create Time Definitions.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Oracle Payroll
21 *
22 * <p><b>Prerequisites</b><br>
23 * The specified business group, legislation code should exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The Time Definition will be successfully created and all the out parameters
27 * will be set.
28 *
29 * <p><b>Post Failure</b><br>
30 * Time Definition will not be created and appropriate error message
31 * will be raised.
32 *
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 Effective date is used for business rule validation.
37 * @param p_short_name Internal name for the Time Definition.
38 * @param p_definition_name User name for the Time Definition.
39 * @param p_period_type Represents the period type for Static and Point in time
40 * definitions.
41 * @param p_period_unit Represents the number of period units in Point in time
42 * definitions.
43 * @param p_day_adjustment When used in Point in Time Definitions represents
44 * the number of days to adjust the date. It is Null for others.
45 * @param p_dynamic_code Represents the Dynamic code.
46 * @param p_business_group_id Business group for the Time Definitions.
47 * @param p_legislation_code Legislation code for the seeded Time Definition.
48 * @param p_definition_type Represents the type of Time Definition.
49 * @param p_number_of_years Represents the number of years the Time Definition
50 * spans.
51 * @param p_start_date Represents the start date for the Time Definition.
52 * @param p_period_time_definition_id Used only in Static Period time
53 * definition. Represents the Point In Time Definition used in generating
54 * the periods for static period Time Definition.
55 * @param p_creator_id Represents the creator for the Time Definition.
56 * @param p_creator_type Represents the creator type of the Time Definition.
57 * @param p_time_definition_id If p_validate is false, this uniquely identifies
58 * the Time Definition.If true, this will be set to NULL.
59 * @param p_object_version_number If p_validate is false, then set to the
60 * version number of the created Time Definition. If p_validate is true, then
61 * the value will be null.
62 * @rep:displayname Create Time Definition
63 * @rep:category BUSINESS_ENTITY PAY_TIME_DEFINITION
64 * @rep:lifecycle active
65 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
66 * @rep:scope public
67 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
68 */
69 --
70 -- {End Of Comments}
71 --
72 procedure create_time_definition
73 (p_validate in boolean default false
74 ,p_effective_date in date
75 ,p_short_name in varchar2
76 ,p_definition_name in varchar2
77 ,p_period_type in varchar2 default null
78 ,p_period_unit in varchar2 default null
79 ,p_day_adjustment in varchar2 default null
80 ,p_dynamic_code in varchar2 default null
81 ,p_business_group_id in number default null
82 ,p_legislation_code in varchar2 default null
83 ,p_definition_type in varchar2 default 'P'
84 ,p_number_of_years in number default null
85 ,p_start_date in date default null
86 ,p_period_time_definition_id in number default null
87 ,p_creator_id in number default null
88 ,p_creator_type in varchar2 default null
89 ,p_time_definition_id out nocopy number
90 ,p_object_version_number out nocopy number
91 );
92 --
93 -- ----------------------------------------------------------------------------
94 -- |--------------------------< update_time_definition >----------------------|
95 -- ----------------------------------------------------------------------------
96 --
97 -- {Start Of Comments}
98 /*#
99 * This API updates a Time Definition.
100 *
101 *
102 * <p><b>Licensing</b><br>
103 * This API is licensed for use with Oracle Payroll.
104 *
105 * <p><b>Prerequisites</b><br>
106 * The Time Definition must exist.
107 *
108 * <p><b>Post Success</b><br>
109 * The Time Definition will be successfully updated and the out parameters
110 * will be set.
111 *
112 * <p><b>Post Failure</b><br>
113 * The Time Definition will not be updated and appropriate error message
114 * will be raised.
115 *
116 * @param p_validate If true, then validation alone will be performed and the
117 * database will remain unchanged. If false and all validation checks pass,
118 * then the database will be modified.
119 * @param p_effective_date Effective date is used for business rule validation.
120 * @param p_time_definition_id Represents the Time Definition to be updated.
121 * @param p_definition_name User name for the Time Definition.
122 * @param p_period_type Represents the period type for Static and Point in time
123 * definitions.
124 * @param p_period_unit Represents the number of period units in Point in time
125 * definitions.
126 * @param p_day_adjustment When used in Point in Time Definitions represents
127 * the number of days to adjust the date. It is Null for others.
128 * @param p_dynamic_code Represents the Dynamic code.
129 * @param p_number_of_years Represents the number of years the Time Definition
130 * spans.
131 * @param p_start_date Represents the start date for the Time Definition.
132 * @param p_period_time_definition_id Used only in Static Period time
133 * definition. Represents the Point In Time Definition used in generating
134 * the periods for static period Time Definition.
135 * @param p_creator_id Represents the creator for the Time Definition.
136 * @param p_creator_type Represents the creator type of the Time Definition.
137 * @param p_object_version_number If p_validate is false, then set to the
138 * version number of the updated Time Definition. If p_validate is true, then
139 * the value will not change.
140 * @rep:displayname Update Time Definitions
141 * @rep:category BUSINESS_ENTITY PAY_TIME_DEFINITION
142 * @rep:lifecycle active
143 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
144 * @rep:scope public
145 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
146 */
147 --
148 -- {End Of Comments}
149 --
150 procedure update_time_definition
151 (p_validate in boolean default false
152 ,p_effective_date in date
153 ,p_time_definition_id in number
154 ,p_definition_name in varchar2 default hr_api.g_varchar2
155 ,p_period_type in varchar2 default hr_api.g_varchar2
156 ,p_period_unit in varchar2 default hr_api.g_varchar2
157 ,p_day_adjustment in varchar2 default hr_api.g_varchar2
158 ,p_dynamic_code in varchar2 default hr_api.g_varchar2
159 ,p_number_of_years in number default hr_api.g_number
160 ,p_start_date in date default hr_api.g_date
161 ,p_period_time_definition_id in number default hr_api.g_number
162 ,p_creator_id in number default hr_api.g_number
163 ,p_creator_type in varchar2 default hr_api.g_varchar2
164 ,p_object_version_number in out nocopy number
165 );
166 -- ----------------------------------------------------------------------------
167 -- |--------------------------< delete_time_definition >----------------------|
168 -- ----------------------------------------------------------------------------
169 --
170 -- {Start Of Comments}
171 /*#
172 * This API deletes a Time Definition.
173 *
174 *
175 * <p><b>Licensing</b><br>
176 * This API is licensed for use with Oracle Payroll.
177 *
178 * <p><b>Prerequisites</b><br>
179 * The Time Definition must exist.
180 *
181 * <p><b>Post Success</b><br>
182 * The Time Definition will be deleted.
183 *
184 * <p><b>Post Failure</b><br>
185 * The Time Definition will not be deleted and appropriate error message
186 * will be raised.
187 *
188 * @param p_validate If true, then validation alone will be performed and the
189 * database will remain unchanged. If false and all validation checks pass,
190 * then the database will be modified.
191 * @param p_effective_date Effective date id used for business rule validation.
192 * @param p_time_definition_id Represents the Time Definition to be deleted.
193 * @param p_object_version_number Represents the version number of the time
194 * definition to be deleted.
195 * @rep:displayname Delete Time Definitions
196 * @rep:category BUSINESS_ENTITY PAY_TIME_DEFINITION
197 * @rep:lifecycle active
198 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
199 * @rep:scope public
200 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
201 */
202 --
203 -- {End Of Comments}
204 --
205 procedure delete_time_definition
206 (p_validate in boolean default false
207 ,p_effective_date in date
208 ,p_time_definition_id in number
209 ,p_object_version_number in number
210 );
211 --
212 end PAY_TIME_DEFINITION_API;
[Home] [Help]