DBA Data[Home] [Help]

PACKAGE: APPS.HXC_TIME_ENTRY_RULE_API

Source


1 Package hxc_time_entry_rule_api as
2 /* $Header: hxcterapi.pkh 120.0 2005/05/29 05:59:23 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |------------------------< create_time_entry_rule>----------------------|
6 -- ----------------------------------------------------------------------------
7 --
8 -- {Start Of Comments}
9 --
10 -- Description:
11 --
12 -- This API creates a Time Entry Rule with a given name, approval rule
13 -- usage covering a particular date ranege. If no Date To is specified
14 -- the rule is assumed to be valid until the end of time.
15 --
16 -- Prerequisites:
17 --
18 -- None
19 --
20 -- In Parameters:
21 --   Name                           Reqd Type     Description
22 --
23 --   p_validate                     No   boolean  If TRUE then the database
24 --                                                remains unchanged. If FALSE
25 --                                                then a new time_entry_rule
26 --                                                is created. Default is FALSE.
27 --   p_time_entry_rule_id        No   number   Primary Key for entity
28 --   p_object_version_number        No   number   Object Version Number
29 --   p_name                         Yes  varchar2 Name for the time entry rule
30 --   p_business_group_id                 number   The ID of the business
31 --                                                group which is linked to
32 --                                                the time entry rule.
33 --   p_legislation_code                  varchar2 The legislation code linked
34 --                                                to the time entry rule.
35 --   p_rule_usage                   Yes  varchar2 Rule Usage Code - must be a valid
36 --                                                value from HR_LOOKUPS for the type
37 --                                                'APPROVAL_RULE_USAGE'
38 --   p_start_date                    Yes  date     Start date of the rule
39 --   p_mapping_id                   No   number   Field Mapping Id
40 --   p_formula_id                   No   number   Fast Formula ID
41 --   p_description                  No   varchar2 User description of the rule
42 --   p_end_date                      No   date     End Date of the rule
43 --   p_effective_date               No   date     Effective Date - today's date.
44 --   p_attribute_category           No   varchar2 Attribute Category for
45 --                                                attribute columns.
46 --   p_attribute1..n                No   varchar2 Values for Time Entry Rules
47 --
48 -- Post Success:
49 --
50 -- when the time_entry_rule has been created successfully the following
51 -- out parameters are set.
52 --
53 --   Name                           Type     Description
54 --
55 --   p_time_entry_rule_id        Number   Primary Key for the new rule
56 --   p_object_version_number        Number   Object version number for the
57 --                                           new rule
58 --
59 -- Post Failure:
60 --
61 -- The time entry rule will not be inserted and an application error raised
62 --
63 -- Access Status:
64 --   Public.
65 --
66 -- {End Of Comments}
67 --
68 procedure create_time_entry_rule
69   (p_validate                      in  boolean   default false
70   ,p_time_entry_rule_id            in  out nocopy number
71   ,p_object_version_number         in  out nocopy number
72   ,p_name                          in     varchar2
73   ,p_business_group_id             in     number   default null
74   ,p_legislation_code              in     varchar2 default null
75   ,p_rule_usage                    in     varchar2
76   ,p_start_date                    in     date
77   ,p_mapping_id                    in     number   default null
78   ,p_formula_id                    in     number   default null
79   ,p_description                   in     varchar2 default null
80   ,p_end_date                      in     date     default null
81   ,p_effective_date                in     date     default null
82   ,p_attribute_category            in     varchar2 default null
83   ,p_attribute1                    in     varchar2 default null
84   ,p_attribute2                    in     varchar2 default null
85   ,p_attribute3                    in     varchar2 default null
86   ,p_attribute4                    in     varchar2 default null
87   ,p_attribute5                    in     varchar2 default null
88   ,p_attribute6                    in     varchar2 default null
89   ,p_attribute7                    in     varchar2 default null
90   ,p_attribute8                    in     varchar2 default null
91   ,p_attribute9                    in     varchar2 default null
92   ,p_attribute10                   in     varchar2 default null
93   ,p_attribute11                   in     varchar2 default null
94   ,p_attribute12                   in     varchar2 default null
95   ,p_attribute13                   in     varchar2 default null
96   ,p_attribute14                   in     varchar2 default null
97   ,p_attribute15                   in     varchar2 default null
98   ,p_attribute16                   in     varchar2 default null
99   ,p_attribute17                   in     varchar2 default null
100   ,p_attribute18                   in     varchar2 default null
101   ,p_attribute19                   in     varchar2 default null
102   ,p_attribute20                   in     varchar2 default null
103   ,p_attribute21                   in     varchar2 default null
104   ,p_attribute22                   in     varchar2 default null
105   ,p_attribute23                   in     varchar2 default null
106   ,p_attribute24                   in     varchar2 default null
107   ,p_attribute25                   in     varchar2 default null
108   ,p_attribute26                   in     varchar2 default null
109   ,p_attribute27                   in     varchar2 default null
110   ,p_attribute28                   in     varchar2 default null
111   ,p_attribute29                   in     varchar2 default null
112   ,p_attribute30                   in     varchar2 default null
113   );
114     --
115 -- ----------------------------------------------------------------------------
116 -- |------------------------<update_time_entry_rule>-----------------------|
117 -- ----------------------------------------------------------------------------
118 --
119 -- {Start Of Comments}
120 --
121 -- Description:
122 --
123 -- This API updates an existing Time Entry Rule with a given name, approval
124 -- rule usage covering a particular date range.
125 --
126 -- Prerequisites:
127 --
128 -- None
129 --
130 -- In Parameters:
131 --   Name                           Reqd Type     Description
132 --
133 --   p_validate                     No   boolean  If TRUE then the database
134 --                                                remains unchanged. If FALSE
135 --                                                then the time_entry_rule
136 --                                                is updated. Default is FALSE.
137 --   p_time_entry_rule_id        Yes  number   Primary Key for entity
138 --   p_object_version_number        Yes  number   Object Version Number
139 --   p_name                         Yes  varchar2 Name for the time entry rule
140 --   p_business_group_id                 number   The ID of the business
141 --                                                group which is linked to
142 --                                                the time entry rule.
143 --   p_legislation_code                  varchar2 The legislation code linked
144 --                                                to the time entry rule.
145 --   p_rule_usage                   Yes  varchar2 Rule Usage Code - must be a valid
146 --                                                value from HR_LOOKUPS for the type
147 --                                                'APPROVAL_RULE_USAGE'
148 --   p_start_date                    Yes  date     Start date of the rule
149 --   p_mapping_id                   No   number   Field Mapping ID
150 --   p_formula_id                   No   number   Fast Formula ID
151 --   p_description                  No   varchar2 User description of the rule
152 --   p_end_date                      No   date     End Date of the rule
153 --   p_effective_date               No   date     Effective Date - today's date.
154 --   p_attribute_category           No   varchar2 Attribute Category for
155 --                                                attribute columns.
156 --   p_attribute1..n                No   varchar2 Values for Time Entry Rules
157 --
158 --
159 -- Post Success:
160 --
161 -- when the time_entry_rule has been updated successfully the following
162 -- out parameters are set.
163 --
164 --   Name                           Type     Description
165 --
166 --   p_object_version_number        Number   Object version number for the
167 --                                           updated rule
168 --
169 -- Post Failure:
170 --
171 -- The time entry rule will not be updated and an application error raised
172 --
173 -- Access Status:
174 --   Public.
175 --
176 -- {End Of Comments}
177 --
178 procedure update_time_entry_rule
179   (p_validate                      in      boolean   default false
180   ,p_time_entry_rule_id            in     number
181   ,p_object_version_number         in out nocopy number
182   ,p_name                          in     varchar2
183   ,p_business_group_id             in     number   default hr_api.g_number
184   ,p_legislation_code              in     varchar2 default hr_api.g_varchar2
185   ,p_rule_usage                    in     varchar2
186   ,p_start_date                    in     date
187   ,p_mapping_id                    in     number   default hr_api.g_number
188   ,p_formula_id                    in     number   default hr_api.g_number
189   ,p_description                   in     varchar2 default hr_api.g_varchar2
190   ,p_end_date                      in     date     default hr_api.g_date
191   ,p_effective_date		   in     date     default hr_api.g_date
192   ,p_attribute_category            in     varchar2 default hr_api.g_varchar2
193   ,p_attribute1                    in     varchar2 default hr_api.g_varchar2
194   ,p_attribute2                    in     varchar2 default hr_api.g_varchar2
195   ,p_attribute3                    in     varchar2 default hr_api.g_varchar2
196   ,p_attribute4                    in     varchar2 default hr_api.g_varchar2
197   ,p_attribute5                    in     varchar2 default hr_api.g_varchar2
198   ,p_attribute6                    in     varchar2 default hr_api.g_varchar2
199   ,p_attribute7                    in     varchar2 default hr_api.g_varchar2
200   ,p_attribute8                    in     varchar2 default hr_api.g_varchar2
201   ,p_attribute9                    in     varchar2 default hr_api.g_varchar2
202   ,p_attribute10                   in     varchar2 default hr_api.g_varchar2
203   ,p_attribute11                   in     varchar2 default hr_api.g_varchar2
204   ,p_attribute12                   in     varchar2 default hr_api.g_varchar2
205   ,p_attribute13                   in     varchar2 default hr_api.g_varchar2
206   ,p_attribute14                   in     varchar2 default hr_api.g_varchar2
207   ,p_attribute15                   in     varchar2 default hr_api.g_varchar2
208   ,p_attribute16                   in     varchar2 default hr_api.g_varchar2
209   ,p_attribute17                   in     varchar2 default hr_api.g_varchar2
210   ,p_attribute18                   in     varchar2 default hr_api.g_varchar2
211   ,p_attribute19                   in     varchar2 default hr_api.g_varchar2
212   ,p_attribute20                   in     varchar2 default hr_api.g_varchar2
213   ,p_attribute21                   in     varchar2 default hr_api.g_varchar2
214   ,p_attribute22                   in     varchar2 default hr_api.g_varchar2
215   ,p_attribute23                   in     varchar2 default hr_api.g_varchar2
216   ,p_attribute24                   in     varchar2 default hr_api.g_varchar2
217   ,p_attribute25                   in     varchar2 default hr_api.g_varchar2
218   ,p_attribute26                   in     varchar2 default hr_api.g_varchar2
219   ,p_attribute27                   in     varchar2 default hr_api.g_varchar2
220   ,p_attribute28                   in     varchar2 default hr_api.g_varchar2
221   ,p_attribute29                   in     varchar2 default hr_api.g_varchar2
222   ,p_attribute30                   in     varchar2 default hr_api.g_varchar2
223   );
224 --
225 -- ----------------------------------------------------------------------------
226 -- |------------------------< delete_time_entry_rule >---------------------|
227 -- ----------------------------------------------------------------------------
228 --
229 -- {Start Of Comments}
230 --
231 -- Description:
232 --
233 -- This API deletes an existing Time Entry Rule
234 --
235 -- Prerequisites:
236 --
237 -- None
238 --
239 -- In Parameters:
240 --   Name                           Reqd Type     Description
241 --
242 --   p_validate                     No   boolean  If TRUE then the database
243 --                                                remains unchanged. If FALSE
244 --                                                then the time_entry_rule
245 --                                                is deleted. Default is FALSE.
246 --   p_time_entry_rule_id        Yes  number   Primary Key for entity
247 --   p_object_version_number        Yes  number   Object Version Number
248 --
249 -- Post Success:
250 --
251 -- when the time_entry_rule has been deleted successfully the process
252 -- completes with success.
253 --
254 -- Post Failure:
255 --
256 -- The time entry rule will not be deleted and an application error raised
257 --
258 -- Access Status:
259 --   Public.
260 --
261 -- {End Of Comments}
262 --
263 procedure delete_time_entry_rule
264   (p_validate                       in  boolean  default false
265   ,p_time_entry_rule_id          in  number
266   ,p_object_version_number          in  number
267   );
268 --
269 --
270 END hxc_time_entry_rule_api;