1 PACKAGE HZ_EXTRACT_PARTY_SITE_BO_PVT AUTHID CURRENT_USER AS
2 /*$Header: ARHEPSVS.pls 120.1 2005/07/13 21:25:04 awu noship $ */
3 /*
4 * This package contains the private APIs for logical party site.
5 * @rep:scope private
6 * @rep:product HZ
7 * @rep:displayname party site
8 * @rep:category BUSINESS_ENTITY HZ_PARTIES
9 * @rep:lifecycle active
10 * @rep:doccd 115hztig.pdf party site Get APIs
11 */
12
13 --------------------------------------
14 --
15 -- PROCEDURE get_party_site_bo
16 --
17 -- DESCRIPTION
18 -- Get a logical party site.
19 --
20 -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
21 --
22 -- ARGUMENTS
23 -- IN:
24 -- p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
25 -- p_party_id party ID.
26 -- p_party_site_id party site ID. If this id is not passed in, multiple site objects will be returned.
27 -- p_party_site_os party site orig system.
28 -- p_party_site_osr party site orig system reference.
29 --
30 -- OUT:
31 -- x_party_site_objs Logical party site records.
32 -- x_return_status Return status after the call. The status can
33 -- be fnd_api.g_ret_sts_success (success),
34 -- fnd_api.g_ret_sts_error (error),
35 -- FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
36 -- x_msg_count Number of messages in message stack.
37 -- x_msg_data Message text if x_msg_count is 1.
38 --
39 -- NOTES
40 --
41 -- MODIFICATION HISTORY
42 --
43 --
44 -- 15-MAY-2005 AWU Created.
45 --
46
47 /*
48 The Get party site API Procedure is a retrieval service that returns a full party site business object.
49 The user identifies a particular party site business object using the TCA identifier and/or
50 the object Source System information. Upon proper validation of the object,
51 the full party site business object is returned. The object consists of all data included within
52 the party site business object, at all embedded levels. This includes the set of all data stored
53 in the TCA tables for each embedded entity.
54
55 To retrieve the appropriate embedded business objects within the party site business object,
56 the Get procedure calls the equivalent procedure for the following embedded objects:
57
58 Embedded BO Mandatory Multiple Logical API Procedure Comments
59 Phone N Y get_phone_bos
60 Telex N Y get_telex_bos
61 Email N Y get_email_bos
62 Web N Y get_web_bos
63
64 To retrieve the appropriate embedded entities within the party site business object,
65 the Get procedure returns all records for the particular party site from these TCA entity tables:
66
67 Embedded TCA Entity Mandatory Multiple TCA Table Entities
68
69 Location Y N HZ_LOCATIONS
70 Party Site Y N HZ_PARTY_SITES
71 Party Site Use N Y HZ_PARTY_SITE_USES
72 Contact Preference N Y HZ_CONTACT_PREFERENCES
73 */
74
75
76 PROCEDURE get_party_site_bos(
77 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
78 p_party_id IN NUMBER,
79 p_party_site_id IN NUMBER,
80 p_action_type IN VARCHAR2 := NULL,
81 x_party_site_objs OUT NOCOPY HZ_PARTY_SITE_BO_TBL,
82 x_return_status OUT NOCOPY VARCHAR2,
83 x_msg_count OUT NOCOPY NUMBER,
84 x_msg_data OUT NOCOPY VARCHAR2
85 );
86
87 END;
[Home] [Help]