1 PACKAGE hr_in_contact_extra_info_api AS
2 /* $Header: pereiini.pkh 120.1 2005/10/02 02:44 aroussel $ */
3 /*#
4 * This package contains contact extra information APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Contact Extra Information for India
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_in_contact_extra_info >-------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates extra information for a contact relationship.
17 *
18 * For an existing contact relationship, an extra information record is
19 * inserted for the information category 'IN_NOMINATION_DETAILS'.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * Contact Relationship and Contact Information Type must exist.
26 *
27 * <p><b>Post Success</b><br>
28 * The contact extra information will be created for the contact relationship.
29 *
30 * <p><b>Post Failure</b><br>
31 * The API does not create the contact extra info and raises an error.
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 Determines when the DateTrack operation comes into
37 * force.
38 * @param p_contact_relationship_id Contact relationship for which the extra
39 * information applies.
40 * @param p_information_type Information type to which the extra information
41 * applies.
42 * @param p_nomination_type Benefit Type for the contact in the nomination.
43 * Valid values are defined by 'IN_NOMINATION_TYPES' lookup type.
44 * @param p_percent_share Percent Share in the nomination of the contact.
45 * @param p_nomination_change_reason Nomination change reason.
46 * @param p_cei_attribute_category Determines context of the cei_attribute
47 * descriptive flexfield in parameters.
48 * @param p_cei_attribute1 Descriptive flexfield segment.
49 * @param p_cei_attribute2 Descriptive flexfield segment.
50 * @param p_cei_attribute3 Descriptive flexfield segment.
51 * @param p_cei_attribute4 Descriptive flexfield segment.
52 * @param p_cei_attribute5 Descriptive flexfield segment.
53 * @param p_cei_attribute6 Descriptive flexfield segment.
54 * @param p_cei_attribute7 Descriptive flexfield segment.
55 * @param p_cei_attribute8 Descriptive flexfield segment.
56 * @param p_cei_attribute9 Descriptive flexfield segment.
57 * @param p_cei_attribute10 Descriptive flexfield segment.
58 * @param p_cei_attribute11 Descriptive flexfield segment.
59 * @param p_cei_attribute12 Descriptive flexfield segment.
60 * @param p_cei_attribute13 Descriptive flexfield segment.
61 * @param p_cei_attribute14 Descriptive flexfield segment.
62 * @param p_cei_attribute15 Descriptive flexfield segment.
63 * @param p_cei_attribute16 Descriptive flexfield segment.
64 * @param p_cei_attribute17 Descriptive flexfield segment.
65 * @param p_cei_attribute18 Descriptive flexfield segment.
66 * @param p_cei_attribute19 Descriptive flexfield segment.
67 * @param p_cei_attribute20 Descriptive flexfield segment.
68 * @param p_contact_extra_info_id If p_validate is false, uniquely identifies
69 * the contact extra info created. If p_validate is true, set to null.
70 * @param p_object_version_number If p_validate is false, then set to the
71 * version number of the created contact extra information. If p_validate is
72 * true, then the value will be null.
73 * @param p_effective_start_date If p_validate is false, then set to the
74 * earliest effective start date for the created contact extra information. If
75 * p_validate is true, then set to null.
76 * @param p_effective_end_date If p_validate is false, then set to the
77 * effective end date for the created contact extra information. If p_validate
78 * is true, then set to null.
79 * @rep:displayname Create Contact Extra Information for India
80 * @rep:category BUSINESS_ENTITY PER_PERSONAL_CONTACT
81 * @rep:lifecycle active
82 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
83 * @rep:scope public
84 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
85 */
86 --
87 -- {End Of Comments}
88 --
89 PROCEDURE create_in_contact_extra_info
90 (p_validate IN boolean default false,
91 p_effective_date IN date,
92 p_contact_relationship_id IN NUMBER,
93 p_information_type IN VARCHAR2,
94
95 p_nomination_type IN VARCHAR2,
96 p_percent_share IN VARCHAR2,
97 p_nomination_change_reason IN VARCHAR2 DEFAULT NULL,
98 p_cei_attribute_category IN VARCHAR2 DEFAULT NULL,
99 p_cei_attribute1 IN VARCHAR2 DEFAULT NULL,
100 p_cei_attribute2 IN VARCHAR2 DEFAULT NULL,
101 p_cei_attribute3 IN VARCHAR2 DEFAULT NULL,
102 p_cei_attribute4 IN VARCHAR2 DEFAULT NULL,
103 p_cei_attribute5 IN VARCHAR2 DEFAULT NULL,
104 p_cei_attribute6 IN VARCHAR2 DEFAULT NULL,
105 p_cei_attribute7 IN VARCHAR2 DEFAULT NULL,
106 p_cei_attribute8 IN VARCHAR2 DEFAULT NULL,
107 p_cei_attribute9 IN VARCHAR2 DEFAULT NULL,
108 p_cei_attribute10 IN VARCHAR2 DEFAULT NULL,
109 p_cei_attribute11 IN VARCHAR2 DEFAULT NULL,
110 p_cei_attribute12 IN VARCHAR2 DEFAULT NULL,
111 p_cei_attribute13 IN VARCHAR2 DEFAULT NULL,
112 p_cei_attribute14 IN VARCHAR2 DEFAULT NULL,
113 p_cei_attribute15 IN VARCHAR2 DEFAULT NULL,
114 p_cei_attribute16 IN VARCHAR2 DEFAULT NULL,
115 p_cei_attribute17 IN VARCHAR2 DEFAULT NULL,
116 p_cei_attribute18 IN VARCHAR2 DEFAULT NULL,
117 p_cei_attribute19 IN VARCHAR2 DEFAULT NULL,
118 p_cei_attribute20 IN VARCHAR2 DEFAULT NULL,
119 p_contact_extra_info_id OUT NOCOPY number,
120 p_object_version_number OUT NOCOPY number,
121 p_effective_start_date OUT NOCOPY DATE,
122 p_effective_end_date OUT NOCOPY DATE
123 ) ;
124 --
125 -- ----------------------------------------------------------------------------
126 -- |-----------------------< update_in_contact_extra_info >-------------------|
127 -- ----------------------------------------------------------------------------
128 --
129 -- {Start Of Comments}
130 /*#
131 * This API updates extra information for a contact relationship.
132 *
133 * For an existing contact relationship extra information, the record is
134 * updated for the information category 'IN_NOMINATION_DETAILS'.
135 *
136 * <p><b>Licensing</b><br>
137 * This API is licensed for use with Human Resources.
138 *
139 * <p><b>Prerequisites</b><br>
140 * The contact extra info as identified by the in parameter
141 * p_contact_extra_info_id and the in out parameter p_object_version_number
142 * must already exist.
143 *
144 * <p><b>Post Success</b><br>
145 * The contact extra information will be updated for the contact relationship.
146 *
147 * <p><b>Post Failure</b><br>
148 * The API does not update the contact extra info and raises an error.
149 *
150 * @param p_validate If true, then validation alone will be performed and the
151 * database will remain unchanged. If false and all validation checks pass,
152 * then the database will be modified.
153 * @param p_effective_date Determines when the DateTrack operation comes into
154 * force.
155 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
156 * updating the record. You must set to either UPDATE, CORRECTION,
157 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
158 * particular record depend on the dates of previous record changes and the
159 * effective date of this change.
160 * @param p_contact_relationship_id Primary key of the parent contact
161 * relationship.
162 * @param p_information_type Information type the extra info applies to.
163 * @param p_nomination_type Benefit Type for the contact in the nomination.
164 * Valid values are defined by 'IN_NOMINATION_TYPES' lookup type.
165 * @param p_percent_share Percent Share in the nomination of the contact.
166 * @param p_nomination_change_reason Nomination change reason.
167 * @param p_cei_attribute_category Determines context of the cei_attribute
168 * descriptive flexfield in parameters.
169 * @param p_cei_attribute1 Descriptive flexfield segment.
170 * @param p_cei_attribute2 Descriptive flexfield segment.
171 * @param p_cei_attribute3 Descriptive flexfield segment.
172 * @param p_cei_attribute4 Descriptive flexfield segment.
173 * @param p_cei_attribute5 Descriptive flexfield segment.
174 * @param p_cei_attribute6 Descriptive flexfield segment.
175 * @param p_cei_attribute7 Descriptive flexfield segment.
176 * @param p_cei_attribute8 Descriptive flexfield segment.
177 * @param p_cei_attribute9 Descriptive flexfield segment.
178 * @param p_cei_attribute10 Descriptive flexfield segment.
179 * @param p_cei_attribute11 Descriptive flexfield segment.
180 * @param p_cei_attribute12 Descriptive flexfield segment.
181 * @param p_cei_attribute13 Descriptive flexfield segment.
182 * @param p_cei_attribute14 Descriptive flexfield segment.
183 * @param p_cei_attribute15 Descriptive flexfield segment.
184 * @param p_cei_attribute16 Descriptive flexfield segment.
185 * @param p_cei_attribute17 Descriptive flexfield segment.
186 * @param p_cei_attribute18 Descriptive flexfield segment.
187 * @param p_cei_attribute19 Descriptive flexfield segment.
188 * @param p_cei_attribute20 Descriptive flexfield segment.
189 * @param p_contact_extra_info_id Primary key of the contact extra information.
190 * @param p_object_version_number Pass in the current version number of the
191 * contact extra information to be updated. When the API completes if
192 * p_validate is false, will be set to the new version number of the updated
193 * contact extra information. If p_validate is true will be set to the same
194 * value which was passed in.
195 * @param p_effective_start_date If p_validate is false, then set to the
196 * effective start date on the updated contact extra information row which now
197 * exists as of the effective date. If p_validate is true, then set to null.
198 * @param p_effective_end_date If p_validate is false, then set to the
199 * effective end date on the updated contact extra information row which now
200 * exists as of the effective date. If p_validate is true, then set to null.
201 * @rep:displayname Update Contact Extra Information for India
202 * @rep:category BUSINESS_ENTITY PER_PERSONAL_CONTACT
203 * @rep:lifecycle active
204 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
205 * @rep:scope public
206 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
207 */
208 --
209 -- {End Of Comments}
210 --
211 PROCEDURE update_in_contact_extra_info
212 (p_validate IN boolean DEFAULT false,
213 p_effective_date IN date,
214 p_datetrack_update_mode IN VARCHAR2,
215 p_contact_relationship_id IN NUMBER DEFAULT hr_api.g_number,
216 p_information_type IN VARCHAR2 DEFAULT hr_api.g_varchar2,
217 p_nomination_type IN VARCHAR2 DEFAULT hr_api.g_varchar2,
218 p_percent_share IN VARCHAR2 DEFAULT hr_api.g_varchar2,
219 p_nomination_change_reason IN VARCHAR2 DEFAULT hr_api.g_varchar2,
220 p_cei_attribute_category IN VARCHAR2 DEFAULT hr_api.g_varchar2,
221 p_cei_attribute1 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
222 p_cei_attribute2 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
223 p_cei_attribute3 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
224 p_cei_attribute4 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
225 p_cei_attribute5 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
226 p_cei_attribute6 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
227 p_cei_attribute7 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
228 p_cei_attribute8 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
229 p_cei_attribute9 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
230 p_cei_attribute10 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
231 p_cei_attribute11 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
232 p_cei_attribute12 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
233 p_cei_attribute13 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
234 p_cei_attribute14 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
235 p_cei_attribute15 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
236 p_cei_attribute16 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
237 p_cei_attribute17 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
238 p_cei_attribute18 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
239 p_cei_attribute19 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
240 p_cei_attribute20 IN VARCHAR2 DEFAULT hr_api.g_varchar2,
241 p_contact_extra_info_id IN number,
242 p_object_version_number IN OUT NOCOPY number,
243 p_effective_start_date OUT NOCOPY DATE,
244 p_effective_end_date OUT NOCOPY DATE
245 ) ;
246 END hr_in_contact_extra_info_api;