1 PACKAGE HZ_EXTRACT_PERSON_BO_PVT AUTHID CURRENT_USER AS
2 /*$Header: ARHEPPVS.pls 120.1.12000000.2 2007/02/23 20:54:25 awu ship $ */
3 /*
4 * This package contains the private APIs for logical person.
5 * @rep:scope private
6 * @rep:product HZ
7 * @rep:displayname Person
8 * @rep:category BUSINESS_ENTITY HZ_PARTIES
9 * @rep:lifecycle active
10 * @rep:doccd 115hztig.pdf Person Get APIs
11 */
12
13 --------------------------------------
14 --
15 -- PROCEDURE get_person_bo
16 --
17 -- DESCRIPTION
18 -- Get a logical person.
19 --
20 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
21 --
22 -- ARGUMENTS
23 -- IN:
24 -- p_init_msg_list Initialize message stack if it is set to
25 -- p_person_id Person ID.
26 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
27 -- OUT:
28 -- x_person_obj Logical person record.
29 -- x_return_status Return status after the call. The status can
30 -- be fnd_api.g_ret_sts_success (success),
31 -- fnd_api.g_ret_sts_error (error),
32 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
33 -- x_msg_count Number of messages in message stack.
34 -- x_msg_data Message text if x_msg_count is 1.
35 --
36 -- NOTES
37 --
38 -- MODIFICATION HISTORY
39 --
40 --
41 -- 10-JUN-2005 AWU Created.
42 --
43
44 /*
45 The Get Person API Procedure is a retrieval service that returns a full Person business object.
46 The user identifies a particular Person business object using the TCA identifier and/or
47 the object Source System information. Upon proper validation of the object,
48 the full Person business object is returned. The object consists of all data included within
49 the Person business object, at all embedded levels. This includes the set of all data stored
50 in the TCA tables for each embedded entity.
51
52 To retrieve the appropriate embedded business objects within the Person business object,
53 the Get procedure calls the equivalent procedure for the following embedded objects:
54
55 Embedded BO Mandatory Multiple Logical API Procedure Comments
56 Party Site N Y get_party_site_bo
57 Phone N Y get_phone_bo
58 Email N Y get_email_bo
59 Web N Y get_web_bo
60 SMS N Y get_sms_bo
61 Employment History N Y Business Structure. Included entities:HZ_EMPLOYMENT_HISTORY, HZ_WORK_CLASS
62
63
64 To retrieve the appropriate embedded entities within the Person business object,
65 the Get procedure returns all records for the particular person from these TCA entity tables:
66
67 Embedded TCA Entity Mandatory Multiple TCA Table Entities
68
69 Party,Person Profile Y N HZ_PARTIES, HZ_PERSON_PROFILES
70 Person Preference N Y HZ_PARTY_PREFERENCES
71 Relationship N Y HZ_RELATIONSHIPS
72 Classification N Y HZ_CODE_ASSIGNMENTS
73 Language N Y HZ_PERSON_LANGUAGE
74 Education N Y HZ_EDUCATION
75 Citizenship N Y HZ_CITIZENSHIP
76 Interest N Y HZ_PERSON_INTEREST
77 Certification N Y HZ_CERTIFICATIONS
78 Financial Profile N Y HZ_FINANCIAL_PROFILE
79 */
80
81
82
83 PROCEDURE get_person_bo(
84 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
85 p_person_id IN NUMBER,
86 p_action_type IN VARCHAR2 := NULL,
87 x_person_obj OUT NOCOPY HZ_PERSON_BO,
88 x_return_status OUT NOCOPY VARCHAR2,
89 x_msg_count OUT NOCOPY NUMBER,
90 x_msg_data OUT NOCOPY VARCHAR2
91 );
92
93 --------------------------------------
94 --
95 -- PROCEDURE get_persons_created
96 --
97 -- DESCRIPTION
98 --The caller provides an identifier for the Persons created business event and
99 --the procedure returns database objects of the type HZ_PERSON_BO for all of
100 --the Person business objects from the business event.
101
102 --
103 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
104 --
105 -- ARGUMENTS
106 -- IN:
107 -- p_init_msg_list Initialize message stack if it is set to
108 -- p_event_id BES Event identifier.
109 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
110 -- OUT:
111 -- x_person_obj One or more created logical person.
112 -- x_return_status Return status after the call. The status can
113 -- be fnd_api.g_ret_sts_success (success),
114 -- fnd_api.g_ret_sts_error (error),
115 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
116 -- x_msg_count Number of messages in message stack.
117 -- x_msg_data Message text if x_msg_count is 1.
118 --
119 -- NOTES
120 --
121 -- MODIFICATION HISTORY
122 --
123 -- 10-JUN-2005 AWU Created.
124 --
125
126
127
128 /*
129 The Get Persons Created procedure is a service to retrieve all of the Person business objects
130 whose creations have been captured by a logical business event. Each Persons Created
131 business event signifies that one or more Person business objects have been created.
132 The caller provides an identifier for the Persons Created business event and the procedure
133 returns all of the Person business objects from the business event. For each business object
134 creation captured in the business event, the procedure calls the generic Get operation:
135 HZ_PERSON_BO_PVT.get_person_bo
136
137 Gathering all of the returned business objects from those API calls, the procedure packages
138 them in a table structure and returns them to the caller.
139 */
140
141
142 PROCEDURE get_persons_created(
143 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
144 p_event_id IN NUMBER,
145 x_person_objs OUT NOCOPY HZ_PERSON_BO_TBL,
146 x_return_status OUT NOCOPY VARCHAR2,
147 x_msg_count OUT NOCOPY NUMBER,
148 x_msg_data OUT NOCOPY VARCHAR2
149 );
150
151
152
153 --------------------------------------
154 --
155 -- PROCEDURE get_persons_updated
156 --
157 -- DESCRIPTION
158 --The caller provides an identifier for the Persons update business event and
159 --the procedure returns database objects of the type HZ_PERSON_BO for all of
160 --the Person business objects from the business event.
161
162 --
163 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
164 --
165 -- ARGUMENTS
166 -- IN:
167 -- p_init_msg_list Initialize message stack if it is set to
168 -- p_event_id BES Event identifier.
169 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
170 -- OUT:
171 -- x_person_objs One or more created logical person.
172 -- x_return_status Return status after the call. The status can
173 -- be fnd_api.g_ret_sts_success (success),
174 -- fnd_api.g_ret_sts_error (error),
175 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
176 -- x_msg_count Number of messages in message stack.
177 -- x_msg_data Message text if x_msg_count is 1.
178 --
179 -- NOTES
180 --
181 -- MODIFICATION HISTORY
182 --
183 -- 10-JUN-2005 AWU Created.
184 --
185
186
187
188 /*
189 The Get Persons Updated procedure is a service to retrieve all of the Person business objects whose updates have been
190 captured by the logical business event. Each Persons Updated business event signifies that one or more Person business
191 objects have been updated.
192 The caller provides an identifier for the Persons Update business event and the procedure returns database objects of
193 the type HZ_PERSON_BO for all of the Person business objects from the business event.
194 Gathering all of the returned database objects from those API calls, the procedure packages them in a table structure
195 and returns them to the caller.
196 */
197
198 PROCEDURE get_persons_updated(
199 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
200 p_event_id IN NUMBER,
201 x_person_objs OUT NOCOPY HZ_PERSON_BO_TBL,
202 x_return_status OUT NOCOPY VARCHAR2,
203 x_msg_count OUT NOCOPY NUMBER,
204 x_msg_data OUT NOCOPY VARCHAR2
205 );
206
207 --------------------------------------
208 --
209 -- PROCEDURE get_person_updated
210 --
211 -- DESCRIPTION
212 --The caller provides an identifier for the Persons update business event and person_id
213 --the procedure returns one database object of the type HZ_PERSON_BO
214
215 --
216 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
217 --
218 -- ARGUMENTS
219 -- IN:
220 -- p_init_msg_list Initialize message stack if it is set to
221 -- p_event_id BES Event identifier.
222 -- p_person_id Person identifier.
223 -- FND_API.G_TRUE. Default is FND_API.G_FALSE.
224 -- OUT:
225 -- x_person_objs One or more created logical person.
226 -- x_return_status Return status after the call. The status can
227 -- be fnd_api.g_ret_sts_success (success),
228 -- fnd_api.g_ret_sts_error (error),
229 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
230 -- x_msg_count Number of messages in message stack.
231 -- x_msg_data Message text if x_msg_count is 1.
232 --
233 -- NOTES
234 --
235 -- MODIFICATION HISTORY
236 --
237 -- 10-JUN-2005 AWU Created.
238 --
239
240
241
242 -- Get only one person object based on p_person_id and event_id
243
244 PROCEDURE get_person_updated(
245 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
246 p_event_id IN NUMBER,
247 p_person_id IN NUMBER,
248 x_person_obj OUT NOCOPY HZ_PERSON_BO,
249 x_return_status OUT NOCOPY VARCHAR2,
250 x_msg_count OUT NOCOPY NUMBER,
251 x_msg_data OUT NOCOPY VARCHAR2
252 );
253
254 -- called in hz_extract_person_cust_bo_pvt
255 procedure set_person_bo_action_type(p_event_id IN NUMBER,
256 p_root_id IN NUMBER,
257 px_person_obj IN OUT NOCOPY HZ_PERSON_BO,
258 x_return_status OUT NOCOPY VARCHAR2);
259
260
261 END HZ_EXTRACT_PERSON_BO_PVT;
[Home] [Help]