DBA Data[Home] [Help]

PACKAGE: APPS.HZ_EXTRACT_ACCT_SITE_BO_PVT

Source


1 PACKAGE HZ_EXTRACT_ACCT_SITE_BO_PVT AUTHID CURRENT_USER AS
2 /*$Header: ARHECSVS.pls 120.2 2008/02/06 10:27:53 vsegu ship $ */
3 /*
4  * This package contains the private APIs for logical customer account site.
5  * @rep:scope private
6  * @rep:product HZ
7  * @rep:displayname customer account site
8  * @rep:category BUSINESS_ENTITY HZ_PARTIES
9  * @rep:lifecycle active
10  * @rep:doccd 115hztig.pdf customer account site Get APIs
11  */
12 
13   --------------------------------------
14   --
15   -- PROCEDURE get_cust_acct_site_bos
16   --
17   -- DESCRIPTION
18   --     Get logical customer account sites.
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_parent_id          parent id.
26 --       p_cust_acct_site_id          customer account site ID.
27   --                          FND_API.G_TRUE. Default is FND_API.G_FALSE.
28   --   OUT:
29   --     x_cust_acct_site_obj         Logical customer account site record.
30   --     x_return_status      Return status after the call. The status can
31   --                          be fnd_api.g_ret_sts_success (success),
32   --                          fnd_api.g_ret_sts_error (error),
33   --                          FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
34   --     x_msg_count          Number of messages in message stack.
35   --     x_msg_data           Message text if x_msg_count is 1.
36   --
37   -- NOTES
38   --
39   -- MODIFICATION HISTORY
40   --
41   --
42   --   8-JUN-2005   AWU                Created.
43   --
44 
45 /*
46 
47 The Get customer account site API Procedure is a retrieval service that returns a full customer account site business object.
48 The user identifies a particular Organization Contact business object using the TCA identifier and/or the object's Source System
49 information. Upon proper validation of the object, the full Organization Contact business object is returned.
50 The object consists of all data included within the Organization Contact business object, at all embedded levels.
51 This includes the set of all data stored in the TCA tables for each embedded entity.
52 
53 
54 Embedded BO	    	Mandatory	Multiple Logical API Procedure		Comments
55 
56 Party Site			Y	N	get_party_site_bo
57 Customer Account Site Contact	N	Y	get_cust_acct_contact_bo
58 Customer Account Site Use	N	Y	Business Structure. Included entities and
59 						structures:HZ_CUST_SITE_USES_ALL,Customer
60 						Profile (Business Structure)
61 
62 
63 To retrieve the appropriate embedded entities within the 'Organization Contact' business object, the Get procedure returns
64 all records for the particular contact from these TCA entity tables.
65 
66 Embedded TCA Entity	Mandatory	Multiple	TCA Table Entities
67 
68 Customer account site	Y		N	HZ_CUST_ACCOUNTS
69 Bank account site Use	N		Y	Owned by Payments team
70 Payment Method		N		N	Owned by AR team
71 
72 */
73 
74 
75 
76  PROCEDURE get_cust_acct_site_bos(
77     p_init_msg_list       IN            VARCHAR2 := fnd_api.g_false,
78     p_parent_id           IN            NUMBER,
79     p_cust_acct_site_id           IN            NUMBER,
80     p_action_type	  IN VARCHAR2 := NULL,
81     x_cust_acct_site_objs          OUT NOCOPY    HZ_CUST_ACCT_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 
88  --------------------------------------
89   --
90   -- PROCEDURE get_cust_acct_site_v2_bos
91   --
92   -- DESCRIPTION
93   --     Get logical customer account sites.
94   --
95   -- EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
96   --
97   -- ARGUMENTS
98   --   IN:
99   --     p_init_msg_list      Initialize message stack if it is set to
100   --     p_parent_id          parent id.
101 --       p_cust_acct_site_id          customer account site ID.
102   --                          FND_API.G_TRUE. Default is FND_API.G_FALSE.
103   --   OUT:
104   --     x_cust_acct_site_v2_obj         Logical customer account site record.
105   --     x_return_status      Return status after the call. The status can
106   --                          be fnd_api.g_ret_sts_success (success),
107   --                          fnd_api.g_ret_sts_error (error),
108   --                          FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
109   --     x_msg_count          Number of messages in message stack.
110   --     x_msg_data           Message text if x_msg_count is 1.
111   --
112   -- NOTES
113   --
114   -- MODIFICATION HISTORY
115   --
116   --
117   --   31-JAN-2008   VSEGU                Created.
118   --
119 
120 /*
121 
122 The Get customer account site API Procedure is a retrieval service that returns a full customer account site business object.
123 The user identifies a particular Organization Contact business object using the TCA identifier and/or the object's Source System
124 information. Upon proper validation of the object, the full Organization Contact business object is returned.
125 The object consists of all data included within the Organization Contact business object, at all embedded levels.
126 This includes the set of all data stored in the TCA tables for each embedded entity.
127 
128 
129 Embedded BO	    	Mandatory	Multiple Logical API Procedure		Comments
130 
131 Party Site			Y	N	get_party_site_bo
132 Customer Account Site Contact	N	Y	get_cust_acct_contact_bo
133 Customer Account Site Use	N	Y	Business Structure. Included entities and
134 						structures:HZ_CUST_SITE_USES_ALL,Customer
135 						Profile (Business Structure)
136 
137 
138 To retrieve the appropriate embedded entities within the 'Organization Contact' business object, the Get procedure returns
139 all records for the particular contact from these TCA entity tables.
140 
141 Embedded TCA Entity	Mandatory	Multiple	TCA Table Entities
142 
143 Customer account site	Y		N	HZ_CUST_ACCOUNTS
144 Bank account site Use	N		Y	Owned by Payments team
145 Payment Method		N		N	Owned by AR team
146 
147 */
148 
149 
150 
151  PROCEDURE get_cust_acct_site_v2_bos(
152     p_init_msg_list       IN            VARCHAR2 := fnd_api.g_false,
153     p_parent_id           IN            NUMBER,
154     p_cust_acct_site_id           IN            NUMBER,
155     p_action_type	  IN VARCHAR2 := NULL,
156     x_cust_acct_site_v2_objs          OUT NOCOPY    HZ_CUST_ACCT_SITE_V2_BO_TBL,
157     x_return_status       OUT NOCOPY    VARCHAR2,
158     x_msg_count           OUT NOCOPY    NUMBER,
159     x_msg_data            OUT NOCOPY    VARCHAR2
160   );
161 
162 
163 END HZ_EXTRACT_ACCT_SITE_BO_PVT;