DBA Data[Home] [Help]

PACKAGE: APPS.HR_AE_CONTRACT_API

Source


1 PACKAGE hr_ae_contract_api AS
2 /* $Header: pectcaei.pkh 120.2 2006/09/27 13:23:33 spendhar noship $ */
3 /*#
4  * This package contains contract APIs for UAE.
5  * @rep:scope public
6  * @rep:product PER
7  * @rep:displayname Contract for UAE
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_ae_contract >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a new UAE contract.
17  *
18  *
19  * <p><b>Licensing</b><br>
20  * This API is licensed for use with Oracle Human Resources.
21  *
22  * <p><b>Prerequisites</b><br>
23  * The person record must exist in the same business group as that of the
24  * contract being created.
25  *
26  * <p><b>Post Success</b><br>
27  * The API creates a new contract.
28  *
29  * <p><b>Post Failure</b><br>
30  * The API does not create the contract and raises an error.
31  *
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_contract_id Identifies the contract record.
36  * @param p_effective_start_date If p_validate is false, then set to the
37  * earliest effective start date for the created contract. if p_validate is
38  * true, then set to null.
39  * @param p_effective_end_date If p_validate is false, then set to the
40  * effective end date for the created contract. If p_validate is true, then set
41  * to null.
42  * @param p_object_version_number If p_validate is false, then set to the
43  * version number of the created contract. If p_validate is true, then the
44  * value will be null.
45  * @param p_person_id If p_validate is false, then this uniquely identifies the
46  * person created. If p_validate is true, then set to null.
47  * @param p_reference Reference code for the contract.
48  * @param p_type Contract type.
49  * @param p_status Contract status.
50  * @param p_status_reason Contract status reason.
51  * @param p_doc_status Contract user status.
52  * @param p_doc_status_change_date Date the user status changed.
53  * @param p_description Contract description.
54  * @param p_duration Contract duration.
55  * @param p_duration_units Units for contract duration.
56  * @param p_contractual_job_title Contractual job title.
57  * @param p_parties Parties to the contract.
58  * @param p_start_reason Reason for starting the contract.
59  * @param p_end_reason Reason for ending the contract.
60  * @param p_number_of_extensions Number of contract extensions.
61  * @param p_extension_reason Reason for extending the contract.
62  * @param p_extension_period Extension period.
63  * @param p_extension_period_units Units for extension period.
64  * @param p_employment_status Employment status.
65  * @param p_expiry_date Expiry date.
66  * @param p_attribute_category This context value determines which flexfield
67  * structure to use with the descriptive flexfield segments.
68  * @param p_attribute1 Descriptive flexfield segment.
69  * @param p_attribute2 Descriptive flexfield segment.
70  * @param p_attribute3 Descriptive flexfield segment.
71  * @param p_attribute4 Descriptive flexfield segment.
72  * @param p_attribute5 Descriptive flexfield segment.
73  * @param p_attribute6 Descriptive flexfield segment.
74  * @param p_attribute7 Descriptive flexfield segment.
75  * @param p_attribute8 Descriptive flexfield segment.
76  * @param p_attribute9 Descriptive flexfield segment.
77  * @param p_attribute10 Descriptive flexfield segment.
78  * @param p_attribute11 Descriptive flexfield segment.
79  * @param p_attribute12 Descriptive flexfield segment.
80  * @param p_attribute13 Descriptive flexfield segment.
81  * @param p_attribute14 Descriptive flexfield segment.
82  * @param p_attribute15 Descriptive flexfield segment.
83  * @param p_attribute16 Descriptive flexfield segment.
84  * @param p_attribute17 Descriptive flexfield segment.
85  * @param p_attribute18 Descriptive flexfield segment.
86  * @param p_attribute19 Descriptive flexfield segment.
87  * @param p_attribute20 Descriptive flexfield segment.
88  * @param p_effective_date Determines when the DateTrack operation comes into
89  * force.
90  * @rep:displayname Create Contract for UAE
91  * @rep:category BUSINESS_ENTITY PER_EMPLOYMENT_CONTRACT
92  * @rep:lifecycle active
93  * @rep:scope public
94  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
95 */
96 --
97 -- {End Of Comments}
98 --
99 PROCEDURE create_ae_contract
100  (p_validate                        IN BOOLEAN    DEFAULT FALSE
101   ,p_contract_id                    OUT NOCOPY NUMBER
102   ,p_effective_start_date           OUT NOCOPY DATE
103   ,p_effective_end_date             OUT NOCOPY DATE
104   ,p_object_version_number          OUT NOCOPY NUMBER
105   ,p_person_id                      IN  NUMBER
106   ,p_reference                      IN  VARCHAR2
107   ,p_type                           IN  VARCHAR2
108   ,p_status                         IN  VARCHAR2
109   ,p_status_reason                  IN  VARCHAR2  DEFAULT NULL
110   ,p_doc_status                     IN  VARCHAR2  DEFAULT NULL
111   ,p_doc_status_change_date         IN  DATE      DEFAULT NULL
112   ,p_description                    IN  VARCHAR2  DEFAULT NULL
113   ,p_duration                       IN  NUMBER    DEFAULT NULL
114   ,p_duration_units                 IN  VARCHAR2  DEFAULT NULL
115   ,p_contractual_job_title          IN  VARCHAR2  DEFAULT NULL
116   ,p_parties                        IN  VARCHAR2  DEFAULT NULL
117   ,p_start_reason                   IN  VARCHAR2  DEFAULT NULL
118   ,p_end_reason                     IN  VARCHAR2  DEFAULT NULL
119   ,p_number_of_extensions           IN  NUMBER    DEFAULT NULL
120   ,p_extension_reason               IN  VARCHAR2  DEFAULT NULL
121   ,p_extension_period               IN  NUMBER    DEFAULT NULL
122   ,p_extension_period_units         IN  VARCHAR2  DEFAULT NULL
123   ,p_employment_status              IN  VARCHAR2  DEFAULT NULL
124   ,p_expiry_date                    IN  VARCHAR2  DEFAULT NULL
125   ,p_attribute_category             IN  VARCHAR2  DEFAULT NULL
126   ,p_attribute1                     IN  VARCHAR2  DEFAULT NULL
127   ,p_attribute2                     IN  VARCHAR2  DEFAULT NULL
128   ,p_attribute3                     IN  VARCHAR2  DEFAULT NULL
129   ,p_attribute4                     IN  VARCHAR2  DEFAULT NULL
130   ,p_attribute5                     IN  VARCHAR2  DEFAULT NULL
131   ,p_attribute6                     IN  VARCHAR2  DEFAULT NULL
132   ,p_attribute7                     IN  VARCHAR2  DEFAULT NULL
133   ,p_attribute8                     IN  VARCHAR2  DEFAULT NULL
134   ,p_attribute9                     IN  VARCHAR2  DEFAULT NULL
135   ,p_attribute10                    IN  VARCHAR2  DEFAULT NULL
136   ,p_attribute11                    IN  VARCHAR2  DEFAULT NULL
137   ,p_attribute12                    IN  VARCHAR2  DEFAULT NULL
138   ,p_attribute13                    IN  VARCHAR2  DEFAULT NULL
139   ,p_attribute14                    IN  VARCHAR2  DEFAULT NULL
140   ,p_attribute15                    IN  VARCHAR2  DEFAULT NULL
141   ,p_attribute16                    IN  VARCHAR2  DEFAULT NULL
142   ,p_attribute17                    IN  VARCHAR2  DEFAULT NULL
143   ,p_attribute18                    IN  VARCHAR2  DEFAULT NULL
144   ,p_attribute19                    IN  VARCHAR2  DEFAULT NULL
145   ,p_attribute20                    IN  VARCHAR2  DEFAULT NULL
146   ,p_effective_date                 IN  DATE
147  );
148 --
149 -- ----------------------------------------------------------------------------
150 -- |----------------------------< update_ae_contract >------------------------|
151 -- ----------------------------------------------------------------------------
152 --
153 -- {Start Of Comments}
154 /*#
155  * This API updates an existing UAE contract.
156  *
157  *
158  * <p><b>Licensing</b><br>
159  * This API is licensed for use with Oracle Human Resources.
160  *
161  * <p><b>Prerequisites</b><br>
162  * The contract must exist.
163  *
164  * <p><b>Post Success</b><br>
165  * The API successfully updates the contract.
166  *
167  * <p><b>Post Failure</b><br>
168  * The API does not update the contract and raises an error.
169  *
170  * @param p_validate If true, then validation alone will be performed and the
171  * database will remain unchanged. if false and all validation checks pass,
172  * then the database will be modified.
173  * @param p_contract_id Identifies the contract record.
174  * @param p_effective_start_date If p_validate is false, then set to the
175  * effective start date on the updated contract row which now exists as of the
176  * effective date. If p_validate is true, then set to null.
177  * @param p_effective_end_date If p_validate is false, then set to the
178  * effective end date on the updated contract row which now exists as of the
179  * effective date. If p_validate is true, then set to null.
180  * @param p_object_version_number Pass in the current version number of the
181  * contract to be updated. when the api completes if p_validate is false, will
182  * be set to the new version number of the updated contract. If p_validate is
183  * true will be set to the same value which was passed in.
184  * @param p_person_id Identifies the person record to be modified.
185  * @param p_reference Reference code for the contract.
186  * @param p_type Contract type.
187  * @param p_status Contract status.
188  * @param p_status_reason Contract status reason.
189  * @param p_doc_status Contract user reason.
190  * @param p_doc_status_change_date Date the user status changed.
191  * @param p_description Contract description.
192  * @param p_duration Contract duration.
193  * @param p_duration_units Units for contract duration.
194  * @param p_contractual_job_title Contractual job title.
195  * @param p_parties Parties to the contract.
196  * @param p_start_reason Reason for starting the contract.
197  * @param p_end_reason Reason for ending the contract.
198  * @param p_number_of_extensions Number of contract extensions.
199  * @param p_extension_reason Reason for extending the contract.
200  * @param p_extension_period Extension period.
201  * @param p_extension_period_units Units for extension period.
202  * @param p_employment_status Employment status.
203  * @param p_expiry_date Expiry date.
204  * @param p_attribute_category This context value determines which flexfield
205  * structure to use with the descriptive flexfield segments.
206  * @param p_attribute1 Descriptive flexfield segment.
207  * @param p_attribute2 Descriptive flexfield segment.
208  * @param p_attribute3 Descriptive flexfield segment.
209  * @param p_attribute4 Descriptive flexfield segment.
210  * @param p_attribute5 Descriptive flexfield segment.
211  * @param p_attribute6 Descriptive flexfield segment.
212  * @param p_attribute7 Descriptive flexfield segment.
213  * @param p_attribute8 Descriptive flexfield segment.
214  * @param p_attribute9 Descriptive flexfield segment.
215  * @param p_attribute10 Descriptive flexfield segment.
216  * @param p_attribute11 Descriptive flexfield segment.
217  * @param p_attribute12 Descriptive flexfield segment.
218  * @param p_attribute13 Descriptive flexfield segment.
219  * @param p_attribute14 Descriptive flexfield segment.
220  * @param p_attribute15 Descriptive flexfield segment.
221  * @param p_attribute16 Descriptive flexfield segment.
222  * @param p_attribute17 Descriptive flexfield segment.
223  * @param p_attribute18 Descriptive flexfield segment.
224  * @param p_attribute19 Descriptive flexfield segment.
225  * @param p_attribute20 Descriptive flexfield segment.
226  * @param p_effective_date Determines when the datetrack operation comes into
227  * force.
228  * @param p_datetrack_mode Indicates which datetrack mode to use when updating
229  * the record. you must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
230  * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
231  * depend on the dates of previous record changes and the effective DATE of
232  * this change.
233  * @rep:displayname Update Contract for UAE
234  * @rep:category BUSINESS_ENTITY PER_EMPLOYMENT_CONTRACT
235  * @rep:lifecycle active
236  * @rep:scope public
237  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
238 */
239 --
240 -- {End Of Comments}
241 --
242 PROCEDURE update_ae_contract
243   (p_validate                       IN BOOLEAN    DEFAULT FALSE
244   ,p_contract_id                    IN  NUMBER
245   ,p_effective_start_date           OUT NOCOPY DATE
246   ,p_effective_end_date             OUT NOCOPY DATE
247   ,p_object_version_number          IN OUT NOCOPY NUMBER
248   ,p_person_id                      IN  NUMBER
249   ,p_reference                      IN  VARCHAR2
250   ,p_type                           IN  VARCHAR2
251   ,p_status                         IN  VARCHAR2
252   ,p_status_reason                  IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
253   ,p_doc_status                     IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
254   ,p_doc_status_change_date         IN  DATE      DEFAULT hr_api.g_DATE
255   ,p_description                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
256   ,p_duration                       IN  NUMBER    DEFAULT hr_api.g_NUMBER
257   ,p_duration_units                 IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
258   ,p_contractual_job_title          IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
259   ,p_parties                        IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
260   ,p_start_reason                   IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
261   ,p_end_reason                     IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
262   ,p_number_of_extensions           IN  NUMBER    DEFAULT hr_api.g_NUMBER
263   ,p_extension_reason               IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
264   ,p_extension_period               IN  NUMBER    DEFAULT hr_api.g_NUMBER
265   ,p_extension_period_units         IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
266   ,p_employment_status              IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
267   ,p_expiry_date                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
268   ,p_attribute_category             IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
269   ,p_attribute1                     IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
270   ,p_attribute2                     IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
271   ,p_attribute3                     IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
272   ,p_attribute4                     IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
273   ,p_attribute5                     IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
274   ,p_attribute6                     IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
275   ,p_attribute7                     IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
276   ,p_attribute8                     IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
277   ,p_attribute9                     IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
278   ,p_attribute10                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
279   ,p_attribute11                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
280   ,p_attribute12                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
281   ,p_attribute13                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
282   ,p_attribute14                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
283   ,p_attribute15                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
284   ,p_attribute16                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
285   ,p_attribute17                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
286   ,p_attribute18                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
287   ,p_attribute19                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
288   ,p_attribute20                    IN  VARCHAR2  DEFAULT hr_api.g_VARCHAR2
289   ,p_effective_date                 IN  DATE
290   ,p_datetrack_mode                 IN  VARCHAR2
291   );
292 --
293 end hr_ae_contract_api;